Optional ReadonlydescriptionOptional ReadonlylayoutStatic ReadonlyEVENT_event.detail is the currently visible viewport data based on the active viewport configuration.
Static ReadonlyEVENT_event.detail is the currently visible viewport data based on the active viewport configuration.
Static ReadonlyEVENT_event.detail is the currently visible viewport data based on the active viewport configuration.
Static ReadonlyEVENT_event.detail is the currently visible viewport data based on the active viewport configuration.
Static ReadonlyEVENT_event.detail is the currently visible viewport data based on the active viewport configuration.
The current list of custom columns added to this Tree Table.
CustomColumn array
true if this is a roll-up and will provide the original rows that make up each grouping.
boolean
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 current number of rows given the table's contents and the various expand/collapse states of each node. (No
totalSize is provided at this time; its definition becomes unclear between roll-up and tree tables,
especially when considering collapse/expand states).
double
Adding new columns to the table based on other columns using updateView mechanics. Rollup tables are
supported but Tree tables will throw an java.lang.UnsupportedOperationException if this function is called.
CustomColumn array
Applies the given filter to the contents of the tree in such a way that if any node is visible, then any parent node will be visible as well even if that parent node would not normally be visible due to the filter's condition. Returns the previous sort in use.
FilterCondition array
Indicates that the table will no longer be used, and server resources can be freed.
Collapses the given node, so that its children and descendants are not visible in the size or the viewport. The
parameter can be the row index, or the row object itself. Equivalent to setExpanded(row, false).
The row to collapse - either the absolute row index or the row object.
a new copy of this treetable, so it can be sorted and filtered separately, and maintain a different viewport. Unlike Table, this will not copy the filter or sort, since tree table viewport semantics differ, and without a viewport set, the treetable doesn't evaluate these settings, and they aren't readable on the properties. Expanded state is also not copied.
Promise of dh.TreeTable
Expands the given node, so that its children are visible when they are in the viewport. The parameter can be the
row index, or the row object itself. The second parameter controls how descendants are expanded: pass
true to expand the row and all descendants, a number to expand to a specified depth relative to
the target node, or omit / pass false to expand only the row itself. A depth of 1 is equivalent to a
regular expand (one level). A depth of 2 expands the node and its children, etc. Equivalent to
setExpanded(row, true) with an optional third parameter. Numeric value is only supported if
Features.treeTableExpandToDepth is true.
The row to expand - either the absolute row index or the row object.
OptionalexpandDescendants: number | boolean
Controls descendant expansion: true for all descendants, a number for
depth-limited expansion (relative to the target node), or false/omitted for a single level.
Optionalconfig: unknownOptionalconfig: unknownChecks whether any event listeners are registered for the given event name.
The event name.
true if there is at least one listener registered for name; false otherwise.
Tests if the specified row is expanded.
The row to test - either the absolute row index or the row object.
true if the row is expanded, false otherwise.
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.
OptionaltimeoutInMillis: number
Optional timeout in milliseconds.
A promise that resolves with the next matching event.
Given a compatible expanded state string from TreeTable.saveExpandedState(), replaces this table's expanded state with that state. This is a best-effort operation, and on error will have no effect except to log a diagnostic warning. With that said it is possible for the expand operation to fail
serialized string payload to restore
Serializes the current expand
Provides Table-like selectDistinct functionality, but with a few quirks, since it is only fetching the
distinct values for the given columns in the source table:
Specifies if the given node should be expanded or collapsed. If this node has children, and the value is changed,
the size of the table will change. The third parameter, expandDescendants, controls how descendants are
expanded when isExpanded is true:
true — expand the row and all descendants (expand-all). Descendants with their own collapse or
single-expand directives are respected.number (>= 1) — expand to a specified depth relative to the target node. The depth is relative
to the target node: a depth of 1 is equivalent to a regular expand (one level), a depth of 2 expands the node and
its children, etc. Behaves like expand-all but stops auto-expanding after the specified number of levels.
Descendants with their own collapse or single-expand directives are respected, same as expand-all. Numeric value
is only supported if Features.treeTableExpandToDepth is true.false, null, or omitted — expand only the row itself (one level).The row to expand or collapse - either the absolute row index or the row object.
true to expand the row, false to collapse.
OptionalexpandDescendants: number | boolean
Controls descendant expansion: true for all descendants, a number for
depth-limited expansion (relative to the target node), or false/omitted for a single level.
Defaults to false.
Optionalcolumns: Column[]OptionalupdateInterval: number
Behaves like a Table externally, but data, state, and viewports are managed by an entirely different mechanism, and so reimplemented here.
Any time a change is made, we build a new request and send it to the server, and wait for the updated state.
Semantics around getting updates from the server are slightly different - we don't "unset" the viewport here after operations are performed, but encourage the client code to re-set them to the desired position.
The table size will be -1 until a viewport has been fetched.
Similar to a table, a Tree Table provides access to subscribed viewport data on the current hierarchy. A different Row type is used within that viewport, showing the depth of that node within the tree and indicating details about whether it has children or is expanded. The Tree Table itself then provides the ability to change if a row is expanded or not. Methods used to control or check if a row should be expanded or not can be invoked on a
TreeRowinstance, or on the number of the row (thus allowing for expanding/collapsing rows which are not currently visible in the viewport).Events and viewports are somewhat different from tables, due to the expense of computing the expanded/collapsed rows and count of children at each level of the hierarchy, and differences in the data that is available.
TreeTablewas created client-side, the originalTablecan have custom columns applied, and theTreeTablecan be recreated.Tablehas a Table.totalsTableConfig property, it is defined here as a method, TreeTable.getTotalsTableConfig(). This returns a promise so the config can be fetched asynchronously.Table.treeTablein the query config), the totals will include non-leaf nodes (since they are themselves actual rows in the table), but in a roll-up table, the totals only include leaf nodes (as non-leaf nodes are generated through grouping the contents of the original table). Roll-ups also have the RollupConfig.includeConstituents property, indicating that a Column in the tree may have a Column.constituentType property reflecting that the type of cells where dh.TreeTable.TreeSubscription.TreeRowImpl.hasChildren is false will be different from usual.