Package io.deephaven.web.client.api

Class Column

java.lang.Object
io.deephaven.web.client.api.Column
@TsName(namespace="dh") public class Column extends Object
Describes the structure of the column, and if desired can be used to get access to the data to be rendered in this column.

  • Constructor Details

    • Column

      public Column(int jsIndex, int index, Integer styleColumnIndex, String type, String name, boolean isPartitionColumn, Integer formatStringColumnIndex, String description, boolean inputTableKeyColumn, boolean inputTableValueColumn, boolean isSortable, elemental2.core.JsArray<ColumnRestriction> columnRestrictions)

  • Method Details

    • formatRowColor

      @JsMethod(namespace="dh.Column") public static CustomColumn formatRowColor(String expression, @JsOptional @TsTypeRef(CustomColumnOptions.class) @JsNullable @TsTypeRef(CustomColumnOptions.class) Object options)
      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 -
      options -
      Returns:
      CustomColumn

    • createCustomColumn

      @JsMethod(namespace="dh.Column") public static CustomColumn createCustomColumn(String name, String expression, @JsOptional @TsTypeRef(CustomColumnOptions.class) @JsNullable @TsTypeRef(CustomColumnOptions.class) Object options)
      A CustomColumn object to apply using applyCustomColumns with the expression specified.
      Parameters:
      name -
      expression -
      options -
      Returns:
      CustomColumn

    • get

      @JsMethod public jsinterop.base.Any get(TableData.Row row)
      The value for this column in the given row. Type will be consistent with the type of the Column.
      Parameters:
      row -
      Returns:
      Any

    • getFormat

      @JsMethod public Format getFormat(TableData.Row row)

    • getJsIndex

      @Deprecated @JsProperty(name="index") public int getJsIndex()
      Deprecated.
      Do not use. Internal index of the column in the table, to be used as a key on the Row.
      Returns:
      int

    • getIndex

      public int getIndex()

    • getType

      @JsProperty public String getType()
      Type of the row data that can be found in this column.
      Returns:
      String

    • getName

      @JsProperty public String getName()
      Label for this column.
      Returns:
      String

    • getDescription

      @JsProperty public @JsNullable String getDescription()

    • getRequiredColumns

      public IntStream getRequiredColumns()

    • getConstituentType

      @JsProperty public @JsNullable String getConstituentType()
      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 includeConstituents is enabled. Otherwise, it is null.
      Returns:
      String

    • setConstituentType

      public void setConstituentType(String constituentType)

    • getFormatStringColumnIndex

      public Integer getFormatStringColumnIndex()

    • getStyleColumnIndex

      public Integer getStyleColumnIndex()

    • getIsPartitionColumn

      @JsProperty public boolean getIsPartitionColumn()
      true if this column is a partition column. Partition columns are used for filtering uncoalesced tables - see JsTable.isUncoalesced().
      Returns:
      true if the column is a partition column.

    • isInputTableKeyColumn

      public boolean isInputTableKeyColumn()

    • isInputTableValueColumn

      public boolean isInputTableValueColumn()

    • sort

      @JsMethod public Sort sort()
      Creates a sort builder object, to be used when sorting by this column.
      Returns:
      Sort

    • getIsSortable

      @JsProperty public boolean getIsSortable()

    • getColumnRestrictions

      @JsProperty public elemental2.core.JsArray<ColumnRestriction> getColumnRestrictions()
      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:
      Array of column restrictions, empty if none are defined

    • filter

      @JsMethod public FilterValue filter()
      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

    • formatColor

      @JsMethod public CustomColumn formatColor(String expression, @JsOptional @TsTypeRef(CustomColumnOptions.class) @JsNullable @TsTypeRef(CustomColumnOptions.class) Object options)
      A CustomColumn object to apply using applyCustomColumns with the expression specified.
      Parameters:
      expression -
      Returns:
      CustomColumn

    • formatNumber

      @JsMethod public CustomColumn formatNumber(String expression, @JsOptional @TsTypeRef(CustomColumnOptions.class) @JsNullable @TsTypeRef(CustomColumnOptions.class) Object options)
      A CustomColumn object to apply using applyCustomColumns with the expression specified.
      Parameters:
      expression -
      Returns:
      CustomColumn

    • formatDate

      @JsMethod public CustomColumn formatDate(String expression, @JsOptional @TsTypeRef(CustomColumnOptions.class) @JsNullable @TsTypeRef(CustomColumnOptions.class) Object options)
      A CustomColumn object to apply using applyCustomColumns with the expression specified.
      Parameters:
      expression -
      Returns:
      CustomColumn

    • toString

      @JsMethod public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • withFormatStringColumnIndex

      public Column withFormatStringColumnIndex(int formatStringColumnIndex)

    • withStyleColumnIndex

      public Column withStyleColumnIndex(int styleColumnIndex)