Package io.deephaven.web.client.api.tree

Interface TreeViewportData

All Superinterfaces:

TableData

All Known Implementing Classes:

JsTreeTable.TreeSubscription.TreeViewportDataImpl

@JsType(namespace="dh")
public interface TreeViewportData
extends TableData

Similar to ViewportData, but with additional properties to reflect the tree structure.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TreeViewportData.TreeRow	Row implementation that also provides additional read-only properties.

Nested classes/interfaces inherited from interface io.deephaven.web.client.api.TableData

TableData.Row, TableData.RowPositionUnion

Field Summary

Fields inherited from interface io.deephaven.web.client.api.TableData

NO_ROW_FORMAT_COLUMN

Method Summary

Modifier and Type	Method	Description
default TableData.Row	get(TableData.RowPositionUnion index)	Reads a row object from the table, from which any subscribed column can be read.
double	getOffset()	The position of the first returned row within the tree.
elemental2.core.JsArray<@TsTypeRef(TreeRow.class) TableData.Row>	getRows()	A lazily computed array of all rows available on the client.
double	getTreeSize()

Methods inherited from interface io.deephaven.web.client.api.TableData

get, get, getColumns, getData, getData, getData, getFormat, getFormat, getFormat

Method Details

getTreeSize

@JsProperty
double getTreeSize()

get

@TsTypeRef(TreeRow.class)
default TableData.Row get(TableData.RowPositionUnion index)

Description copied from interface: TableData

Reads a row object from the table, from which any subscribed column can be read.

Specified by:

get in interface TableData

Parameters:

index - the position or key to access

Returns:

the row at the given location

getRows

@JsProperty
elemental2.core.JsArray<@TsTypeRef(TreeRow.class) TableData.Row> getRows()

Description copied from interface: TableData

A lazily computed array of all rows available on the client.

Specified by:

getRows in interface TableData

getOffset

@JsProperty
double getOffset()

The position of the first returned row within the tree.