The columns present on this table. Note that this may not include all columns in the parent table, and in cases where a given column has more than one aggregation applied, the column name will have a suffix indicating the aggregation used. This suffixed name will be of the form columnName + '__' + aggregationName.
Column array
Read-only. An ordered list of custom column formulas to add to the table, either adding new columns or replacing
existing ones. To update, call applyCustomColumns.
CustomColumn array
An ordered list of Filters to apply to the table. To update, call applyFilter. Note that this getter will
return the new value immediately, even though it may take a little time to update on the server. You may listen
for the filterchanged event to know when to update the UI.
FilterCondition array
true if this table has been closed.
boolean
true if this table may receive updates from the server, including size changed events, updated events
after initial snapshot.
boolean
The total number of rows in this table. This may change as the base table's configuration, filter, or contents change.
double
An ordered list of Sorts to apply to the table. To update, call applySort. Note that this getter will
return the new value immediately, even though it may take a little time to update on the server. You may listen
for the sortchanged event to know when to update the UI.
Sort array
Gets the configuration used when creating this Totals Table.
Adds an event listener to this table.
The event name.
The callback to invoke when the event fires.
A function that removes this event listener when invoked.
Adds an event listener to this table.
A function that removes this event listener when invoked.
Replace the current custom columns with a new set. These columns can be used when adding new filter and sort operations to the table, as long as they are present.
Replace the currently set filters on the table. Returns the previously set value. Note that the filter property will immediately return the new value, but you may receive update events using the old filter before the new one is applied, and the filterchanged event fires. Reusing existing, applied filters may enable this to perform better on the server. The updated event will also fire, but rowadded and rowremoved will not.
FilterCondition array
Replace the currently set sort on this table. Returns the previously set value. Note that the sort property will immediately return the new value, but you may receive update events using the old sort before the new sort is applied, and the sortchanged event fires. Reusing existing, applied sorts may enable this to perform better on the server. The updated event will also fire, but rowadded and rowremoved will not.
Sort array
Performs an inexact timeseries join, where rows in this table will have columns added from the closest matching row from the right table.
The `asOfMatchRule` value can be one of:
The table to match to values in this table.
The columns that should match, according to the asOfMatchRole.
Optional columnsToAdd: string[]Columns from the right table to add to the resulting table, empty/null/absent to add all columns.
Optional asOfMatchRule: stringThe match rule to use, see above.
A promise that will resolve to the joined table.
Creates a snapshot of this table on the server, with the given options. See createSnapshot for more information.
options for the snapshot; see SnapshotOptions for details
Promise of TableData
Creates a subscription to this table, with the given options. See createSubscription for more information.
options for the subscription; see SubscriptionOptions for details
a new TableSubscription
Creates a viewport subscription to this table, with the given options. See createViewportSubscription for more information.
options for the viewport subscription; see ViewportSubscriptionOptions for details
A promise that will be resolved with the newly created table holding the results of the specified cross join
operation. The columnsToAdd parameter is optional, not specifying it will result in all columns from the
right table being added to the output. The reserveBits optional parameter lets the client control how the
key space is distributed between the rows in the two tables, see the Java Table class for details.
The table to match to values in this table.
The columns that should match exactly.
Optional columnsToAdd: string[]Columns from the right table to add to the resulting table, empty/null/absent to add all columns.
Optional reserveBits: numberThe number of bits of key-space to initially reserve per group, null/absent will let the server select a value.
A promise that will resolve to the joined table.
A promise that will be resolved with the newly created table holding the results of the specified exact join
operation. The columnsToAdd parameter is optional, not specifying it will result in all columns from the
right table being added to the output.
The table to match to values in this table.
The columns that should match exactly.
Optional columnsToAdd: string[]Columns from the right table to add to the resulting table, empty/null/absent to add all columns.
A promise that will resolve to the joined table.
the currently visible viewport. If the current set of operations has not yet resulted in data, it will not resolve until that data is ready.
Promise of TableData
use () on the result from #createViewportSubscription(Object) instead.
Joins this table to the provided table, using one of the specified join types:
Note that Left join is not supported here, unlike DHE.
See the Choose a join method document for more guidance on picking a join operation.
The type of join to perform, see the list above.
The table to match to values in this table.
Columns that should match.
Optional columnsToAdd: string[]Columns from the right table to add to the result - empty/null/absent to add all columns.
Optional asOfMatchRule: stringIf joinType is AJ/RAJ/ReverseAJ, the match rule to use.
A promise that will resolve to the joined table.
Instead, call the specific method for the join type.
A promise that will be resolved with the newly created table holding the results of the specified natural join
operation. The columnsToAdd parameter is optional, not specifying it will result in all columns from the
right table being added to the output.
The table to match to values in this table.
The columns that should match exactly.
Optional columnsToAdd: string[]Columns from the right table to add to the resulting table. Empty/null/absent to add all columns.
A promise that will resolve to the joined table.
Returns a promise that resolves with the next occurrence of the specified event.
The event name.
Optional timeoutInMillis: numberOptional timeout in milliseconds.
A promise that resolves to the next event.
Removes an event listener from this table.
The event name.
The callback to remove.
true if a listener was removed; false otherwise.
Specifies the range of items to pass to the client and update as they change. If the columns parameter is not provided, all columns will be used. Until this is called, no data will be available. Invoking this will result in events to be fired once data becomes available, starting with an updated event and one rowadded event per row in that range.
Optional columns: Column[]Optional updateIntervalMs: numberOptional isReverseViewport: booleanUse #createViewportSubscription(Object) instead.
Creates a server-side snapshot of baseTable when this table updates.
The table to snapshot.
Optional doInitialSnapshot: booleanWhether to create an initial snapshot immediately.
Optional stampColumns: string[]Optional list of column names to include in the result.
A promise that resolves to the snapshot table.
Behaves like a dh.Table, but doesn't expose all of its API for changing the internal state. Instead, state is driven by the upstream table - when its handle changes, this table listens and rebuilds its totals from the new state. If that rebuild fails, a requestfailed event fires with the failure message as its detail, and this table keeps the totals it last built until the upstream table changes again. If the rebuild succeeds but a filter, sort or custom column set on this table cannot be re-applied to it, the requestfailed event is the one any dh.Table fires for a rejected change, and this table shows the rebuilt totals without that change.
A new config is returned any time it is accessed. This is to:
This class has limited methods found on dh.Table. Instances of this type usually have a size of one when no dh.groupBy | groupBy is set on the config, but may potentially contain as few as zero rows if the parent table was empty, or as many as the parent table if each row gets its own group.
When using the dh.groupBy | groupBy feature, it may be desirable to also provide a row to the user with all values across all rows. To achieve this, request the same Totals Table again, but remove the dh.groupBy | groupBy setting.