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

    Class CustomColumn

    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.

    Index
    TYPE_FORMAT_COLOR: string
    TYPE_FORMAT_DATE: string
    TYPE_FORMAT_NUMBER: string
    TYPE_NEW: string
    • get expression(): string

      The expression to evaluate this custom column.

      Returns string

      String

    • get name(): string

      The name of the column to use.

      Returns string

      String

    • get type(): string

      Type of custom column. One of

      • FORMAT_COLOR
      • FORMAT_NUMBER
      • FORMAT_DATE
      • NEW

      Returns string

      String

    • Returns a string representation of this custom column.

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

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

      Returns string

    • Returns the primitive value for this custom column.

      Returns string