Action
    Preparing search index...

    Class DataColumn

    This is a data column which is part of a data table and can be used to retrieve data on row values, hierarchies and properties. The data column implements the Spotfire.Dxp.Data.IDataColumn which is to be used for non-modification operations on the data column. This class has no public constructors, see the Spotfire.Dxp.Data.DataColumnCollection class for methods which create data columns.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    Context DataType DisplayValueSettings Hierarchy IsAttached IsValid Name NameEscapedForExpression Properties RowValues Transactions Visible As

    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 Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get Hierarchy(): DataHierarchy

      Gets the hierarchy of the column, this is either the hierarchy in the case of a hierarchy column or the indexed column for other columns.

      Returns DataHierarchy

      2.0

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get IsValid(): boolean

      Gets a value indicating whether the column is valid or not.

      Returns boolean

      2.0

    • get Name(): string

      Gets or sets the name of the column.

      Returns string

      2.0

    • set Name(value: string): void

      Parameters

      • value: string

      Returns void

    • get NameEscapedForExpression(): string

      Gets the name of the column escaped for usage in an expression. This is a utility method which uses EscapeIdentifier(identifier).

      Returns string

      2.0

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • get Visible(): boolean

      Gets or sets a value indicating whether this column should be visible in the user interface.

      Returns boolean

      2.0

    • set Visible(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability