Action
    Preparing search index...

    Class AddRowsSettings

    This class describes the settings used when performing the AddRows(dataSource, settings) operation on a Spotfire.Dxp.Data.DataTable.

    2.0

    Hierarchy (View Summary)

    Index

    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

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

    • 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

    • get CreateNewSourceColumn(): boolean

      Gets a value indicating whether a new origin column (containing the identifier values) should be created to identify the original and added rows.

      Returns boolean

      2.0

    • get NewRowSourceValue(): string

      Gets the value (if any) to use to identify the added rows.

      Returns string

      2.0

    • get OriginalRowSourceValue(): string

      Gets the value (if any) to use to identify the original rows.

      Returns string

      2.0

    • get RowSourceColumnName(): string

      Gets the name (if any) of the origin column that should be created or used to identify the original and added rows.

      Returns string

      2.0

    • get UseExistingSourceColumn(): boolean

      Gets a value indicating whether an existing origin column (containing the identifier values) should be used to identify the original and added rows.

      Returns boolean

      2.0