DataRelationshipsCalculationSettings Class

Spotfire 14.3 API Reference

Defines the input to a DataRelationshipsCalculation

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.CalculationsCalculationSettings
        Spotfire.Dxp.Application.Calculations.DataRelationshipsDataRelationshipsCalculationSettings

Namespace: Spotfire.Dxp.Application.Calculations.DataRelationships
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)

Syntax

[SerializableAttribute]
[PersistenceVersionAttribute(3, 0)]
public sealed class DataRelationshipsCalculationSettings : CalculationSettings

The DataRelationshipsCalculationSettings type exposes the following members.

Properties

	Name	Description
	ComparisonMethod	Gets or sets the ComparisonMethod of the data relationships calculation.
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	DataFilteringSelectionReference	Specifies which DataFilteringSelection the DataRelationshipsCalculation operates on.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	IsNew	Gets whether or not a settings object is new, that is, is associated with a calculation instance that has not been executed yet. (Inherited from CalculationSettings.)
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	XColumns	Represents one of the column sets to compare.
	YColumns	Represents one of the column sets to compare.

Methods

	Name	Description
	ApplyPreferences	Initializes the settings with the preferences of the current user. Preferences consists of the two column sets, the comparison method and table name to operate on.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	SavePreferences	Saves the user preferences to match the current settings. Preferences consists of the two column sets, the comparison method and table name to operate on.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	ValidateSettings	Validates the suggested columns, filtering selections and marking selections with respect to the current Settings and Results. In particular this means checking for circular references. This method is meant to be called from a dialog before allowing the user to set up dependencies that would cause errors. If the implementer forgets to do this the framework will run the same check before trying to calculate but without any chance for the user to modify their choices. (Inherited from CalculationSettings.)

Explicit Interface Implementations

	Name	Description
	INodeContextGetAncestorT	Implements GetAncestorT. (Inherited from DocumentNode.)
	INodeContextGetServiceT	Implements GetServiceT. (Inherited from DocumentNode.)
	INodeContextIsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactionsBeginAggregatedTransaction	Implements BeginAggregatedTransaction. (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8