Package io.deephaven.web.client.api
Class JsTotalsTableConfig
java.lang.Object
io.deephaven.web.client.api.JsTotalsTableConfig
Describes how a Totals Table will be generated from its parent table. Each table has a default (which may be null)
indicating how that table was configured when it was declared, and each Totals Table has a similar property
describing how it was created. Both the Table.getTotalsTable and Table.getGrandTotalsTable methods take
this config as an optional parameter - without it, the table's default will be used, or if null, a default instance
of TotalsTableConfig will be supplied.
This class has a no-arg constructor, allowing an instance to be made with the default values provided. However, any
JS object can be passed in to the methods which accept instances of this type, provided their values adhere to the
expected formats.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Deprecated.static final String
Deprecated.static final String
Deprecated.@TsTypeRef(JsAggregationOperation.class) String
Specifies the default operation for columns that do not have a specific operation applied; defaults to "Sum".static final String
Deprecated.elemental2.core.JsArray<String>
Groupings to use when generating the Totals Table.static final String
Deprecated.static final String
Deprecated.static final String
Deprecated.jsinterop.base.JsPropertyMap<elemental2.core.JsArray<@TsTypeRef(JsAggregationOperation.class) String>>
Mapping from each column name to the aggregation(s) that should be applied to that column in the resulting Totals Table.boolean
Specifies if a Grand Totals Table should be expanded by default in the UI.boolean
Specifies if a Totals Table should be expanded by default in the UI.static final String
Deprecated.static final String
Deprecated.static final String
Deprecated.static final String
Deprecated. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuildRequest
(elemental2.core.JsArray<Column> allColumns) elemental2.core.JsArray<String>
elemental2.core.JsArray<String>
static JsTotalsTableConfig
Implementation from TotalsTableBuilder.fromDirective, plus changes required to make this able to act on plan JS objects/arrays.Implementation from TotalsTableBuilder.buildDirective(), plus a minor change to iterate JS arrays/objects correctly.toString()
-
Field Details
-
COUNT
Deprecated.- See Also:
-
MIN
Deprecated.- See Also:
-
MAX
Deprecated.- See Also:
-
SUM
Deprecated.- See Also:
-
ABS_SUM
Deprecated.- See Also:
-
VAR
Deprecated.- See Also:
-
AVG
Deprecated.- See Also:
-
STD
Deprecated.- See Also:
-
FIRST
Deprecated.- See Also:
-
LAST
Deprecated.- See Also:
-
SKIP
Deprecated.- See Also:
-
knownAggTypes
-
showTotalsByDefault
public boolean showTotalsByDefaultSpecifies if a Totals Table should be expanded by default in the UI. Defaults to false. -
showGrandTotalsByDefault
public boolean showGrandTotalsByDefaultSpecifies if a Grand Totals Table should be expanded by default in the UI. Defaults to false. -
defaultOperation
@TsTypeRef(JsAggregationOperation.class) public @TsTypeRef(JsAggregationOperation.class) String defaultOperationSpecifies the default operation for columns that do not have a specific operation applied; defaults to "Sum". -
operationMap
public jsinterop.base.JsPropertyMap<elemental2.core.JsArray<@TsTypeRef(JsAggregationOperation.class) String>> operationMapMapping from each column name to the aggregation(s) that should be applied to that column in the resulting Totals Table. If a column is omitted, the defaultOperation is used. -
groupBy
Groupings to use when generating the Totals Table. One row will exist for each unique set of values observed in these columns. See also `Table.selectDistinct`.
-
-
Constructor Details
-
JsTotalsTableConfig
public JsTotalsTableConfig() -
JsTotalsTableConfig
-
-
Method Details
-
parse
Implementation from TotalsTableBuilder.fromDirective, plus changes required to make this able to act on plan JS objects/arrays. Note that this omits groupBy for now, until the server directive format supports it! -
toString
-
serialize
Implementation from TotalsTableBuilder.buildDirective(), plus a minor change to iterate JS arrays/objects correctly. Note that this omits groupBy until the server directive format supports it! -
buildRequest
-
getCustomColumns
-
getDropColumns
-