DataRelationshipsCalculation Class

Spotfire 14.7 API Reference

Given two sets of columns, an active filtering and a statistical method outputs a data table with correlations between the columns.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.DataCalculation
        Spotfire.Dxp.Application.CalculationsCalculationDataRelationshipsCalculationSettings, DataRelationshipsCalculationResults
          Spotfire.Dxp.Application.Calculations.DataRelationshipsDataRelationshipsCalculation

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

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(3, 0)]
public sealed class DataRelationshipsCalculation : Calculation<DataRelationshipsCalculationSettings, DataRelationshipsCalculationResults>

The DataRelationshipsCalculation type exposes the following members.

Properties

	Name	Description
	CalculationResults	Gets the CalculationResults implementation associated with this calculation. (Inherited from CalculationTSettings, TResults.)
	CalculationSettings	Gets the CalculationSettings associated with this calculation. (Inherited from CalculationTSettings, TResults.)
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	IsValid	Gets a value indicating whether or not this calculation can be calculated. A calculation may for example be invalid when vital dependencies are missing. (Inherited from Calculation.)
	Name	Gets the unique name of this calculation instance. (Inherited from CalculationTSettings, TResults.)
	NeedsRefresh	Gets a value indicating whether or not this calculation needs refreshing (through a call to Execute) to make sure that its results are up-to-date. (Inherited from Calculation.)
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	TypeId	Gets the type identifier for the Calculation. (Inherited from Calculation.)
	UpdateBehavior	Gets the CalculationUpdateBehavior of the calculation. (Inherited from Calculation.)

Top

Methods

	Name	Description
	Execute	Execute the calculation. If the results exists they will updated - otherwise they will be created. (Inherited from CalculationTSettings, TResults.)
	Execute(CalculationExecutionPromptMode)	Execute the calculation. If the results exists they will updated - otherwise they will be created. (Inherited from CalculationTSettings, TResults.)
	ForEachNodeInSubTreeTNode	Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node. (Inherited from DocumentNode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	SetName	Set the unique (within the CalculationCollection) name of this Calculation instance. (Inherited from CalculationTSettings, TResults.)
	ToString	Returns a String that represents this instance. (Inherited from Calculation.)

Top

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.)

Top

Remarks

Calculates statistical correlations between DataColumns using one of the methods given in ComparisonMethod, and outputs the results to a DataTable.

Version Information

Supported in: 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

Spotfire.Dxp.Application.Calculations.DataRelationships Namespace