Skip to content
pixi-silk
GitHub repository
Interface

LayerTreeOptions

import type { LayerTreeOptions } from 'pixi-silk/ui/layers';

Options of LayerTree.

Type Parameters#

Type Parameter
T

Properties#

PropertyTypeDescriptionDefined in
adapterTreeAdapter<T>How the tree reads and changes your data.ui/panels/LayerTree.ts:35
atlas?SdfAtlasGlyph atlas of the row names. Default the shared one.ui/panels/LayerTree.ts:68
dragDrop?booleanDrag rows to reorder and reparent them (needs adapter.move). Default true.ui/panels/LayerTree.ts:55
element?HTMLElementThe element the scene is drawn on, usually app.canvas. The rename field positions its hidden input against it.ui/panels/LayerTree.ts:64
expanded?Iterable<T, any, any>Nodes that start expanded. Default the top rows.ui/panels/LayerTree.ts:53
height?numberList height in local units. Rows past it scroll. Default 320.ui/panels/LayerTree.ts:47
history?HistoryLikeWhere renames, toggles and moves go for undo. Each gesture is one step.ui/panels/LayerTree.ts:43
hoverSync?booleanHovering a row sets selection.state.hovered, so the canvas can outline it. Default true.ui/panels/LayerTree.ts:62
indent?numberIndent per depth level in local units. Default 14.ui/panels/LayerTree.ts:51
keyboard?booleanArrow keys, Home, End, Enter and F2 work while the tree has focus. Adds keydown and pointerdown listeners on window. Default true.ui/panels/LayerTree.ts:60
rootTThe node whose children are the top rows.ui/panels/LayerTree.ts:37
rowHeight?numberRow height in local units. Default 28.ui/panels/LayerTree.ts:49
selection?Selection<T>The selection the rows show and change. Default a new one.ui/panels/LayerTree.ts:41
showRoot?booleanShow root itself as the first row. Default false.ui/panels/LayerTree.ts:39
theme?Partial<PanelTheme>Colours, radius and font. Default the dark theme.ui/panels/LayerTree.ts:66
ticker?Ticker | nullTicker driving the motion. Default Ticker.shared. null for manual LayerTree.tick.ui/panels/LayerTree.ts:70
width?numberList width in local units. Default 240.ui/panels/LayerTree.ts:45