Skip to content

charton API


charton API / @chart-on/ui / index / ObjectTreeHandle

Interface: ObjectTreeHandle ​

Defined in: ui/src/object-tree.ts:26

Returned by createObjectTree: the panel element, the selected rows, and select, refresh and destroy.

Properties ​

el ​

el: HTMLElement

Defined in: ui/src/object-tree.ts:28

Hide or show it with el.hidden, then call refresh(); it skips updates while hidden.


selection ​

readonly selection: readonly ObjectTreeNode[]

Defined in: ui/src/object-tree.ts:30

The selected rows, in display order.

Methods ​

destroy() ​

destroy(): void

Defined in: ui/src/object-tree.ts:35

Returns ​

void


refresh() ​

refresh(): void

Defined in: ui/src/object-tree.ts:34

Rebuild the rows now.

Returns ​

void


select() ​

select(keys): void

Defined in: ui/src/object-tree.ts:32

Select rows by key (unknown keys are skipped); the drawings among them are selected on the chart too.

Parameters ​

keys ​

readonly string[]

Returns ​

void