@deephaven/jsapi-types
    Preparing search index...

    Class Column

    Describes the structure of the column, and if desired can be used to get access to the data to be rendered in this column.

    Index
    constituentType?: string

    If this column is part of a roll-up tree table, represents the type of the row data that can be found in this column for leaf nodes if RollupConfig.includeConstituents is enabled. Otherwise, it is null.

    String

    description?: string
    • get columnRestrictions(): ColumnRestriction[]

      Returns the column restrictions for input table columns, or an empty array if this is not an input table column or if no restrictions are defined. The restrictions are implementation-specific constraints that the server enforces on column values. The returned array is a copy and may be safely modified by the caller.

      Returns ColumnRestriction[]

      Array of ColumnRestriction, empty if none are defined

    • get index(): number

      Returns number

      int

      Do not use. Internal index of the column in the table, to be used as a key on the TableData.Row.

    • get isPartitionColumn(): boolean

      true if this column is a partition column. Partition columns are used for filtering uncoalesced tables - see Table.isUncoalesced.

      Returns boolean

      true if the column is a partition column.

    • get isSortable(): boolean

      Returns boolean

    • get name(): string

      Label for this column.

      Returns string

      String

    • get type(): string

      Type of the row data that can be found in this column.

      Returns string

      String

    • Creates a new value for use in filters based on this column. Used either as a parameter to another filter operation, or as a builder to create a filter operation.

      Returns FilterValue

      FilterValue

    • The value for this column in the given dh.TableData.Row. Type will be consistent with the type of the Column.

      Parameters

      Returns any

      Any

    • Creates a sort builder object, to be used when sorting by this column.

      Returns Sort

      Sort

    • Returns string