This class describes an equality relation between two columns in different tables. A relation like '[Tbl1].[Column1] = Upper([Tbl2].[Column1])' is defined using two expressions '[Tbl1].[Column1]' and 'Upper([Tbl2].[Column1])'. These expressions are evaluated in the different source tables, so if one of the tables are external then you can use the methods provided by that external data source and if the table is not external then you can use the standard Spotfire expression language functions. Additionally you can also provide left and right transform expressions which are evaluated on top of the left/right expressions supporting all standard Spotfire expression language functions. These expression refer to the result of the corresponding expression using the name Spotfire.Dxp.Data.ColumnRelation.ValueColumnName. For example you need to perform "Upper" on Tbl2 but the external system doesn't support that method you can define left and right expressions like '[Tbl1].[Column1]' and '[Tbl2].[Column1]' but add additional transform expressions like '[Value]' and 'Upper([Value])'.

2.0

Hierarchy (view full)

Methods

  • 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

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

  • 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

  • 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

  • Initializes a new instance of the Spotfire.Dxp.Data.ColumnRelation class.

    Parameters

    • leftExpression: string | String

      The left expression.

    • rightExpression: string | String

      The right expression.

    Returns ColumnRelation

    2.0

  • Initializes a new instance of the Spotfire.Dxp.Data.ColumnRelation class.

    Parameters

    • leftExpression: string | String

      The left expression.

    • leftTransform: null | string | String

      The left transform or null which will use the original value.

    • rightExpression: string | String

      The right expression.

    • rightTransform: null | string | String

      The right transform or null which will use the original value.

    Returns ColumnRelation

    2.0

  • get LeftTableName(): string
  • Gets the name of the left table.

    Returns string

    2.0

  • get RightTableName(): string
  • Gets the name of the right table.

    Returns string

    2.0

  • get ValueColumnName(): string
  • Gets the name of the value column used for transforming the data.

    Returns string

    2.0

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

  • Will evaluate if the descriptors are the same. The descriptors are considered equal even if the order of the expressions (left/right) are reversed.

    Parameters

    Returns boolean

    True if the ColumnRelation are considered equal, otherwise false.

    2.0