Package io.deephaven.web.client.api.tree

Class JsRollupConfig

java.lang.Object
io.deephaven.web.client.api.tree.JsRollupConfig
@JsType(name="RollupConfig", namespace="dh") public class JsRollupConfig extends Object
Describes a grouping and aggregations for a roll-up table. Pass to the Table.rollup function to create a roll-up table.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    jsinterop.base.JsPropertyMap<elemental2.core.JsArray<String>>
    aggregations
    Mapping from each aggregation name to the ordered list of columns it should be applied to in the resulting roll-up table.
    elemental2.core.JsArray<elemental2.core.JsString>
    groupingColumns
    Ordered list of columns to group by to form the hierarchy of the resulting roll-up table.
    boolean
    includeConstituents
    Optional parameter indicating if an extra leaf node should be added at the bottom of the hierarchy, showing the rows in the underlying table which make up that grouping.
    boolean
    includeDescriptions
    Optional parameter indicating if original column descriptions should be included.
    @jsinterop.annotations.JsNullable boolean
    includeOriginalColumns
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    JsRollupConfig()
     
    JsRollupConfig(jsinterop.base.JsPropertyMap<Object> source)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    RollupRequest
    buildRequest(elemental2.core.JsArray<Column> tableColumns)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • groupingColumns

      public elemental2.core.JsArray<elemental2.core.JsString> groupingColumns
      Ordered list of columns to group by to form the hierarchy of the resulting roll-up table.

    • aggregations

      public jsinterop.base.JsPropertyMap<elemental2.core.JsArray<String>> aggregations
      Mapping from each aggregation name to the ordered list of columns it should be applied to in the resulting roll-up table.

    • includeConstituents

      public boolean includeConstituents
      Optional parameter indicating if an extra leaf node should be added at the bottom of the hierarchy, showing the rows in the underlying table which make up that grouping. Since these values might be a different type from the rest of the column, any client code must check if TreeRow.hasChildren = false, and if so, interpret those values as if they were Column.constituentType instead of Column.type. Defaults to false.

    • includeOriginalColumns

      public @jsinterop.annotations.JsNullable boolean includeOriginalColumns

    • includeDescriptions

      public boolean includeDescriptions
      Optional parameter indicating if original column descriptions should be included. Defaults to true.

  • Constructor Details

    • JsRollupConfig

      @JsConstructor public JsRollupConfig()

    • JsRollupConfig

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

  • Method Details

    • buildRequest

      @JsIgnore public RollupRequest buildRequest(elemental2.core.JsArray<Column> tableColumns)