charton

Appearance

charton API

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

Interface: ToolRailHandle ​

Defined in: ui/src/rail.ts:224

Returned by createToolRail: the rail's element, its visibility, refresh to update the buttons' states, setItems and destroy.

Extends ​

Properties ​

el ​

el: HTMLElement

Defined in: ui/src/rail.ts:225

visible ​

readonly visible: boolean

Defined in: ui/src/dom.ts:327

Inherited from ​

Visibility.visible

Methods ​

destroy() ​

destroy(): void

Defined in: ui/src/rail.ts:229

Returns ​

void

refresh() ​

refresh(): void

Defined in: ui/src/rail.ts:226

Returns ​

void

setItems() ​

setItems(items): void

Defined in: ui/src/rail.ts:228

Replace every item, e.g. when tool access or favourites change.

Parameters ​

items ​

RailItem[]

Returns ​

void

setVisible() ​

setVisible(visible): void

Defined in: ui/src/dom.ts:328

Parameters ​

visible ​

boolean

Returns ​

void

Inherited from ​

Visibility.setVisible

toggle() ​

toggle(): void

Defined in: ui/src/dom.ts:329

Returns ​

void

Inherited from ​

Visibility.toggle