Class DataRelationshipsCalculationSettings

Defines the input to a Spotfire.Dxp.Application.Calculations.DataRelationships.DataRelationshipsCalculation

Since

2.0

Hierarchy (View Summary)

CalculationSettings
- DataRelationshipsCalculationSettings

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

ComparisonMethod Context DataFilteringSelectionReference IsAttached IsNew Transactions UpdateBehavior XColumns YColumns ApplyPreferences SavePreferences ValidateSettings

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from CalculationSettings.Cast

Equals

Equals(obj: any): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from CalculationSettings.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from CalculationSettings.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from CalculationSettings.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from CalculationSettings.TryCast

`Static`Equals

Equals(objA: any, objB: any): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from CalculationSettings.Equals

Default capability

ComparisonMethod

get ComparisonMethod(): ComparisonMethod
Gets or sets the Spotfire.Dxp.Application.Calculations.DataRelationships.DataRelationshipsCalculationSettings.ComparisonMethod of the data relationships calculation.

Returns ComparisonMethod
Since
2.0
set ComparisonMethod(value: ComparisonMethod): void
Parameters
- value: ComparisonMethod
Returns void

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from CalculationSettings.Context

DataFilteringSelectionReference

get DataFilteringSelectionReference(): DataFilteringSelection
Specifies which Spotfire.Dxp.Data.DataFilteringSelection the Spotfire.Dxp.Application.Calculations.DataRelationships.DataRelationshipsCalculation operates on.

Returns DataFilteringSelection
Remark
If no Spotfire.Dxp.Data.DataFilteringSelection is set the

Since
2.0
set DataFilteringSelectionReference(value: DataFilteringSelection): void
Parameters
- value: DataFilteringSelection
Returns void

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from CalculationSettings.IsAttached

IsNew

get IsNew(): boolean
Gets whether or not a settings object is new, that is, is associated with a calculation instance that has not been executed yet.

Returns boolean
Since
2.0

Inherited from CalculationSettings.IsNew

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from CalculationSettings.Transactions

UpdateBehavior

get UpdateBehavior(): CalculationUpdateBehavior
Gets the update behavior of the calculation.

Returns CalculationUpdateBehavior
Remark
This determines whether the calculation should be reexecuted immediately when dependencies change or just indicate their need for manual refresh. Note that columns residing in a normal table will also be asked to recalculate themselves when the rowcount of their table changes regardless of their normal UpdateBehavior.

Since
2.0

Inherited from CalculationSettings.UpdateBehavior

XColumns

get XColumns(): DataRelationshipsColumnCollection
Represents one of the column sets to compare.

Returns DataRelationshipsColumnCollection
Since
2.0

YColumns

get YColumns(): DataRelationshipsColumnCollection
Represents one of the column sets to compare.

Returns DataRelationshipsColumnCollection
Since
2.0

ApplyPreferences

ApplyPreferences(): void
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.

Returns void
Since
2.0

SavePreferences

SavePreferences(): void
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.

Returns void
Since
2.0

ValidateSettings

ValidateSettings(
    dependentColumns: OrExplicit<
        System.Collections.Generic.IEnumerable<DataColumn>,
    >,
    dependentFilteringSelections: OrExplicit<
        System.Collections.Generic.IEnumerable<DataFilteringSelection>,
    >,
    dependentMarkingSelections: OrExplicit<
        System.Collections.Generic.IEnumerable<DataMarkingSelection>,
    >,
): CalculationSettingsValidationResult
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.
Parameters
- dependentColumns: OrExplicit<System.Collections.Generic.IEnumerable<DataColumn>>
  Suggested dependencycolumns
- dependentFilteringSelections: OrExplicit<System.Collections.Generic.IEnumerable<DataFilteringSelection>>
  Suggested Spotfire.Dxp.Data.DataFilteringSelection:s
- dependentMarkingSelections: OrExplicit<System.Collections.Generic.IEnumerable<DataMarkingSelection>>
  Suggested Spotfire.Dxp.Data.DataMarkingSelection:s
Returns CalculationSettingsValidationResult
A Spotfire.Dxp.Application.Calculations.CalculationSettingsValidationResult object containing any errors or warnings that was the result of the check. These can then be displayed to the user so they can modify their choices.

Since
2.0

Inherited from CalculationSettings.ValidateSettings

Class DataRelationshipsCalculationSettings

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

ComparisonMethod

Returns ComparisonMethod

Since

Parameters

Returns void

Context

Returns INodeContext

Since

DataFilteringSelectionReference

Returns DataFilteringSelection

Remark

Since

Parameters

Returns void

IsAttached

Returns boolean

Since

IsNew

Returns boolean

Since

Transactions

Returns ITransactions

Since

UpdateBehavior

Returns CalculationUpdateBehavior

Remark

Since

XColumns

Returns DataRelationshipsColumnCollection

Since

YColumns

Returns DataRelationshipsColumnCollection

Since

ApplyPreferences

Returns void

Since

SavePreferences

Returns void

Since

ValidateSettings

Parameters

Returns CalculationSettingsValidationResult

Since

Settings

On This Page

`Static`Equals