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.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

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

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

DataType

DisplayValueSettings

Hierarchy

  • 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

    Since

    2.0

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 column is valid or not.

    Returns boolean

    Since

    2.0

Name

  • get Name(): string

  • Gets or sets the name of the column.

    Returns string

    Since

    2.0

  • set Name(value): void

  • Parameters

    • value: string

    Returns void

NameEscapedForExpression

  • 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

    Since

    2.0

Properties

RowValues

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

Visible

  • get Visible(): boolean

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

    Returns boolean

    Since

    2.0

  • set Visible(value): void

  • Parameters

    • value: boolean

    Returns void

As

Settings

Member Visibility

On This Page

Methods
Default capability