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
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
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
Joins this table to the provided table, using one of the specified join types:
AJ, ReverseAJ (or RAJ) - inexact timeseries joins, based on the
provided matching rule.CROSS_JOIN (or Join) - cross join of all rows that have matching values in both
tables.EXACT_JOIN (or ExactJoin - matches values in exactly one row in the right table,
with errors if there is not exactly one.NATURAL_JOIN (or Natural - matches values in at most one row in the right table,
with nulls if there is no match or errors if there are multiple matches.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
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: boolean
Behaves like a Table, but doesn't expose all of its API for changing the internal state. Instead, state is driven by the upstream table - when it changes handle, this listens and updates its own handle accordingly.
Additionally, this is automatically subscribed to its one and only row, across all columns.
A new config is returned any time it is accessed, to prevent accidental mutation, and to allow it to be used as a template when fetching a new totals table, or changing the totals table in use.
A simplistic Table, providing access to aggregation of the table it is sourced from. This table is always automatically subscribed to its parent, and adopts changes automatically from it. This class has limited methods found on Table. Instances of this type always have a size of one when no groupBy is set on the config, but may potentially contain as few as zero rows, or as many as the parent table if each row gets its own group.
When using the
groupByfeature, it may be desireable 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 thegroupBysetting.