Protected constructorOptional Readonly descriptionThe table description attribute.
The description, or null.
Optional Readonly layoutLayout hints for displaying this table.
Optional Readonly pluginThe plugin name attribute for this table.
The plugin name, or null.
Static Readonly EVENT_Indicates that columns for this table have changed, and column headers should be updated.
Static Readonly EVENT_This table has lost its connection to the server. Events will not fire and data will not update until the connection is reestablished, at which point EVENT_RECONNECT will fire. A reconnect will be attempted automatically.
Static Readonly EVENT_Indicates that a filter has occurred, and that the UI should be replaced with the current viewport.
Static Readonly EVENT_This table has reconnected to the server, and data will update again. Any viewport or subscription that was active before the disconnect is restored.
Static Readonly EVENT_This table failed to reconnect to the server. The event.detail value describes the failure.
Static Readonly EVENT_Indicates that an error occurred on this table on the server or while communicating with it. The message will provide more insight, but recent operations were likely unsuccessful and may need to be reapplied.
Static Readonly EVENT_Indicates that a pending change to this table, such as a new sort or filter, was applied on the server. Any EVENT_SORTCHANGED, EVENT_FILTERCHANGED, or EVENT_CUSTOMCOLUMNSCHANGED resulting from that change fires after this event.
Static Readonly EVENT_Finer grained visibility into data being added, rather than just seeing the currently visible viewport. Provides the row being added, and the offset it will exist at.
Static Readonly EVENT_Finer grained visibility into data being removed, rather than just seeing the currently visible viewport. Provides the row being removed, and the offset it used to exist at.
Static Readonly EVENT_Finer grained visibility into data being updated, rather than just seeing the currently visible viewport. Provides the row being updated and the offset it exists at.
Static Readonly EVENT_The table size has updated, so live scrollbars and the like can be updated accordingly.
Static Readonly EVENT_Indicates that a sort has occurred, and that the UI should be replaced with the current viewport.
Static Readonly EVENT_event.detail is the currently visible window, the same as if getViewportData was called and
resolved. Listening to this event removes the need to listen to the finer grained events below for data changes.
In contrast, using the finer grained events may enable only updating the specific rows which saw a change.
Static Readonly SIZE_The size the table will have if it is uncoalesced.
The columns that are present on this table. This is always all possible columns. If you specify fewer columns in
setViewport, you will get only those columns in your
ViewportData. size is the total count of
rows in the table. The size can and will change; see the EVENT_SIZECHANGED event for details. Size will
be negative in exceptional cases (eg. the table is uncoalesced, see the Table.uncoalesced property for
details).
Column array
An ordered list of custom column formulas to add to the table, either adding new columns or replacing existing ones. To update, call applyCustomColumns.
An ordered list of filter conditions 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 EVENT_FILTERCHANGED event to know when to update the UI.
true if this table represents a user Input Table (see dh.InputTable). When
true, you may call inputTable to add or remove data from the underlying table.
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
Read-only. true if this table is uncoalesced, indicating that work must be done before the table can be
used.
Uncoalesced tables are expensive to operate on - filter to a single partition or range of partitions before subscribing to access only the desired data efficiently. A subscription can be specified without a filter, but this can be very expensive. To see which partitions are available, check each column on the table to see which have isPartitionColumn as `true`, and filter those columns. To read the possible values for those columns, use selectDistinct.
true if the table is uncoaleced and should be filtered before operating on it, otherwise
false.
The total count of rows in the table. If there is a viewport subscription active, this size will be updated when the subscription updates. If not, and Table.uncoalesced is true, the size will be SIZE_UNCOALESCED. Otherwise, the size will be updated when the server's update graph processes changes.
When the size changes, the EVENT_SIZECHANGED event will be fired.
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 EVENT_SORTCHANGED event to know when to update the UI.
The total count of the rows in the table, excluding any filters. Unlike size, changes to this value will not result in any event. If the table is unfiltered, this will return the same size as size. If this table was uncoalesced before it was filtered, this will return SIZE_UNCOALESCED.
The default configuration to be used when building a dh.TotalsTable for this table.
Listen for events on this object.
The type of the data that the event will provide.
The name of the event to listen for.
A function to call when the event occurs.
Returns a cleanup function.
Listen for events on this object.
Returns a cleanup function.
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 EVENT_FILTERCHANGED event fires. Reusing existing, applied filters may enable this to perform better on the server. The EVENT_UPDATED event will also fire, but EVENT_ROWADDED and EVENT_ROWREMOVED will not.
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 EVENT_SORTCHANGED event fires. Reusing existing, applied sorts may enable this to perform better on the server. The EVENT_UPDATED event will also fire, but EVENT_ROWADDED and EVENT_ROWREMOVED will not.
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.
Alias for partitionBy.
The partition key column name or names.
Optional dropKeys: booleanWhether to drop the key columns from the partitioned constituent tables.
Promise of PartitionedTable.
Returns a promise that will resolve to a TableData instance containing a snapshot of the current state of the table, within the bounds of the specified rows and columns.
options for the snapshot; see SnapshotOptions for details
Creates a subscription to the specified columns, across all rows in the table. Useful for charts or taking a snapshot of the table atomically. The initial snapshot will arrive in a single event, but later changes will be sent as updates. However, this may still be very expensive to run from a browser for very large tables. Each call to createSubscription creates a new subscription, which must have io.deephaven.web.client.api.subscription.AbstractTableSubscription.close called on it to stop it and release its resources, and all events are fired from the TableSubscription instance.
options for the subscription; see SubscriptionOptions for details
a new TableSubscription
Creates a viewport subscription to the specified columns, across the specified rows in the table. The returned TableViewportSubscription instance allows the viewport to be changed over time, and events are fired from it when the data changes or when a viewport change has been applied. Each call to createViewportSubscription creates a new subscription, which must have close called on it to stop it and release its resources
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.
A "frozen" version of this table (a server-side snapshot of the entire source table). Viewports on the frozen table will not update. This does not change the original table, and the new table will not have any of the client side sorts/filters/columns. New client side sorts/filters/columns can be added to the frozen copy.
Promise of dh.Table
null if no attribute exists, a string if it is an easily serializable attribute value, or a
Promise that resolves to a Table if the attribute value is a table.
Object
A promise that will resolve to ColumnStatistics for the column of this table.
Promise of ColumnStatistics
A promise that will resolve to a Totals Table of this table, ignoring any filters. See getTotalsTable for more specifics.
Optional config: TotalsTableConfigpromise of dh.TotalsTable
A promise that will resolve to a Totals Table of this table. This table will obey the configurations provided as a parameter, or will use the table's default if no parameter is provided, and be updated once per second as necessary. Note that multiple calls to this method will each produce a new dh.TotalsTable which must have close() called on it when not in use.
Optional config: TotalsTableConfigPromise of dh.TotalsTable
Gets 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. If this table is closed before the promise resolves, it will be rejected - to separate the lifespan of this promise from the table itself, call getViewportData on the result from setViewport.
Promise of TableData
use () on the result from #createViewportSubscription(Object) instead.
If hasInputTable is true, you may call this method to gain access to an InputTable
object which can be used to mutate the data within the table. If the table is not an Input Table, the promise
will be immediately rejected.
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 the next time the named event occurs, with the value of the event's detail. If a timeout is specified and occurs before the event takes place, the promise will reject, otherwise waits indefinitely.
The type of the event detail.
The event name.
Optional timeoutInMillis: numberOptional timeout in milliseconds.
A promise that resolves with the next matching event.
Creates a new dh.PartitionedTable from the contents of the current table, partitioning data based on the specified keys.
Optional dropKeys: booleanPromise of dh.PartitionedTable
Removes an event listener added to this table.
a promise that will resolve to a new roll-up dh.TreeTable of this table. Multiple calls to this method will each produce a new dh.TreeTable which must have close() called on it when not in use.
Promise of dh.TreeTable
Seek the row matching the data provided
Row to start the seek from
Column to seek for value on
Type of value provided
Value to seek
Optional insensitive: booleanOptional value to flag a search as case-insensitive. Defaults to false.
Optional contains: booleanOptional value to have the seek value do a contains search instead of exact equality. Defaults to
false.
Optional isBackwards: booleanOptional value to seek backwards through the table instead of forwards. Defaults to
false.
A promise that resolves to the row value found.
A new table containing the distinct tuples of values from the given columns that are present in the original table. This table can be manipulated as any other table. Sorting is often desired as the default sort is the order of appearance of values from the original table.
Promise of dh.Table
If the columns parameter is not provided, all columns will be used. If the updateIntervalMs parameter is
not provided, a default of one second 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 a
rowadded event per row in that range. The returned object allows the viewport to be closed when no longer
needed.
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.
Creates a subscription to the specified columns, across all rows in the table. The optional parameter
updateIntervalMs may be specified to indicate how often the server should send updates, defaulting to one
second if omitted. Useful for charts or taking a snapshot of the table atomically. The initial snapshot will
arrive in a single event, but later changes will be sent as updates. However, this may still be very expensive to
run from a browser for very large tables. Each call to subscribe creates a new subscription, which must have
io.deephaven.web.client.api.subscription.AbstractTableSubscription.close called on it to stop it, and all events are fired from the
TableSubscription instance.
Optional updateIntervalMs: numberUse #createSubscription(Object) with a DataOptions.SubscriptionOptions instead.
A promise that will resolve to a new dh.TreeTable of this table. Multiple calls to this method will each produce a new dh.TreeTable which must have close() called on it when not in use.
Promise of dh.TreeTable
Static reverse
Provides access to data in a table. Note that several methods present their response through Promises. This allows the client to: