Action
    Preparing search index...

    Class DataColumnCollection

    This is a collection of Spotfire.Dxp.Data.DataColumn columns in a Spotfire.Dxp.Data.DataTable. This class is used to retrieve columns and to add new columns.

    2.0

    Hierarchy (View Summary)

    Implements

    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

    Item: PropertyGet<string | String, DataColumn> & PropertyGet<
        number
        | Int32,
        DataColumn,
    >

    Get a column with a given index.

    The index of the column to retrieve.

    The column at the given index.

    2.0

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get Count(): number

      Gets the number of columns in the collection.

      Returns number

      2.0

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • Add a new calculated column.

      Parameters

      • name: string | String

        The name of the calculated column.

      • expression: string | String

        The expression describing how the calculated column should be calculated.

      Returns DataColumn

      The newly created calculated column.

      2.0

    • Check if this collection contains a column with the given name.

      Parameters

      • name: string | String

        The name of the column.

      Returns boolean

      True if a column with the given name exists in the collection, false otherwise.

      2.0

    • Create a new unique column name from a suggestion. The suggested name is used if possible.

      Parameters

      • columnName: string | String

        The suggested column name.

      Returns string

      A column name which is unique in the collection.

      2.0

    • Check if the suggested column name is a valid unique name in the collection.

      Parameters

      • columnName: string | String

        The suggested column name.

      Returns boolean

      True if the suggested name is a valid name for a new column in the collection, false otherwise.

      2.0

    • Try to get a column with a given name.

      Parameters

      • name: string | String

        The name of the column.

      • dataColumn: OutParam<DataColumn>

        The column will be assigned to this parameter if found.

      Returns boolean

      True if the column was found in the collection and assigned to dataColumn parameter, false otherwise.

      2.0