Class DataRelation

This class describes a relation between two Spotfire.Dxp.Data.DataTables. The relations are contained in a Spotfire.Dxp.Data.DataRelationCollection, use the Add(leftTable, rightTable, relationExpression) method to add new relations.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context Expression IsAttached IsValid LeftTable RightTable Transactions ConnectsTable GetRelatedTable

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

Expression

  • get Expression(): string

  • Gets or sets the expression used to define the relation.

    Returns string

    Since

    2.0

  • set Expression(value): void

  • Parameters

    • value: string

    Returns void

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

IsValid

  • get IsValid(): boolean

  • Gets a value indicating whether the relation is valid, false otherwise..

    Returns boolean

    Since

    2.0

LeftTable

RightTable

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

ConnectsTable

  • ConnectsTable(dataTable): boolean

  • Check if the relation connects the data table.

    Parameters

    • dataTable: DataTable

      The table to check if the relation connects to it.

    Returns boolean

    True if the table is part of the relation, false otherwise.

    Since

    2.0

GetRelatedTable

  • GetRelatedTable(dataTable): DataTable

  • Get the data table that the given data table relates to in the relation.

    Parameters

    • dataTable: DataTable

      A data table which is either the right or the left table.

    Returns DataTable

    The other table that the relation refers to.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability