Package io.deephaven.web.client.api

Class CustomColumn

java.lang.Object
io.deephaven.web.client.api.CustomColumn
@JsType(namespace="dh") public class CustomColumn extends Object
Describes a custom column expression.

This type is used to represent a formula column or a formatting column (for example, table color or number/date formatting) in the Deephaven JS API.

  • Field Details

  • Constructor Details

    • CustomColumn

      @JsIgnore public CustomColumn(String name, String type, String expression, Object options)

    • CustomColumn

      @JsIgnore public CustomColumn(CustomColumnDescriptor descriptor)

    • CustomColumn

      @JsIgnore public CustomColumn(jsinterop.base.JsPropertyMap<Object> source)

  • Method Details

    • getName

      @JsProperty public String getName()
      The name of the column to use.
      Returns:
      String

    • getType

      @JsProperty public String getType()
      Type of custom column. One of
      • FORMAT_COLOR
      • FORMAT_NUMBER
      • FORMAT_DATE
      • NEW
      Returns:
      String

    • getExpression

      @JsProperty public String getExpression()
      The expression to evaluate this custom column.
      Returns:
      String

    • getOptions

      @JsProperty public CustomColumnOptions getOptions()
      The options for this custom column.
      Returns:
      CustomColumOptions

    • valueOf

      @JsMethod public String valueOf()
      Returns the primitive value for this custom column.

    • toString

      @JsMethod public String toString()
      Returns a string representation of this custom column.

      The returned value is formatted as name[SUFFIX]=expression, where [SUFFIX] depends on the type.

      from(String) parses name=expression and always produces a TYPE_NEW column. It does not interpret suffixes or preserve the original type.

      Overrides:
      toString in class Object

    • from

      @JsMethod public static CustomColumn from(String columnInfo)
      Creates a CustomColumn by parsing a string produced by toString().

      This method parses name=expression and always produces a TYPE_NEW column. It does not interpret suffixes.

      Parameters:
      columnInfo - a string formatted as name=expression
      Returns:
      a new CustomColumn