Class Column

Optional Readonly constituentType

Optional Readonly description

columnRestrictions

• 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 column restrictions, empty if none are defined

index

• get index(): number

• Returns number

  int

  Deprecated

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

isPartitionColumn

• get isPartitionColumn(): boolean

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

  Returns boolean

  true if the column is a partition column.

isSortable

• get isSortable(): boolean

• Returns boolean

name

• get name(): string

• Label for this column.

  Returns string

  String

type

• get type(): string

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

  Returns string

  String

filter

• filter(): FilterValue

• 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

formatColor

• formatColor(expression, options?): CustomColumn

• A CustomColumn object to apply using applyCustomColumns with the expression specified.

  Parameters

  • expression: string

  • Optional options: CustomColumnOptions

  Returns CustomColumn

  CustomColumn

formatDate

• formatDate(expression, options?): CustomColumn

• A CustomColumn object to apply using applyCustomColumns with the expression specified.

  Parameters

  • expression: string

  • Optional options: CustomColumnOptions

  Returns CustomColumn

  CustomColumn

formatNumber

• formatNumber(expression, options?): CustomColumn

• A CustomColumn object to apply using applyCustomColumns with the expression specified.

  Parameters

  • expression: string

  • Optional options: CustomColumnOptions

  Returns CustomColumn

  CustomColumn

get

• get(row): any

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

  Parameters

  • row: Row

  Returns any

  Any

getFormat

• getFormat(row): Format

• Parameters

  • row: Row

  Returns Format

sort

• sort(): Sort

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

  Returns Sort

  Sort

toString

• toString(): string

• Returns string

Static createCustomColumn

• createCustomColumn(name, expression, options?): CustomColumn

• A CustomColumn object to apply using applyCustomColumns with the expression specified.

  Parameters

  • name: string

  • expression: string

  • Optional options: CustomColumnOptions

  Returns CustomColumn

  CustomColumn

Static formatRowColor

• formatRowColor(expression, options?): CustomColumn

• Format entire rows colors using the expression specified. Returns a CustomColumn object to apply to a table using applyCustomColumns with the parameters specified.

  Parameters

  • expression: string

  • Optional options: CustomColumnOptions

  Returns CustomColumn

  CustomColumn