Class VisualizationRelations

This class is used to set which column relation to use when there are more than one column relation in the data manager that matches an expression. The Spotfire.Dxp.Data.ColumnRelation must exist in the Spotfire.Dxp.Data.ColumnRelationCollection in the data manager in order to be set as preferred.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context IsAttached Transactions ResetAllPreferred ResetPreferred SetPreferred

Methods

Cast

  • Cast<T1, T2>(this, type): 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

    Returns T1

Equals

  • Equals(obj): 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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): 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

    Returns null | T1

StaticEquals

  • Equals(objA, objB): 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.

Default capability

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

Transactions

  • get Transactions(): ITransactions

  • Gets a collection of methods for executing transactions on the document.

    Returns ITransactions

    Since

    2.0

ResetAllPreferred

  • ResetAllPreferred(): void

  • Reset all preferred column relations and use the default column relations instead.

    Returns void

    Since

    2.0

ResetPreferred

  • ResetPreferred(relation): void

  • Reset the preferred column relation and use the default column relation instead.

    Parameters

    Returns void

    Since

    2.0

SetPreferred

  • SetPreferred(relation): void

  • Sets the preferred column relation. The relation must be a reference to a column relation in the data manager.

    Parameters

    Returns void

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability