charton API

---

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

Interface: ToolbarHandle

Defined in: ui/src/toolbar.ts:184

Returned by createToolbar: its element and visibility, and reads, adds, changes or removes items by id.

Extends

• Visibility

Properties

el

el: HTMLElement

Defined in: ui/src/toolbar.ts:185

---

items

readonly items: readonly ToolbarItem[]

Defined in: ui/src/toolbar.ts:186

---

visible

readonly visible: boolean

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

Inherited from

Visibility.visible

Methods

add()

add(item, placement?): void

Defined in: ui/src/toolbar.ts:199

Insert an item; without a placement it goes after the last item of its group. Placement is a position in the list; the item still renders in its own align group.

Parameters

item

ToolbarItem

placement?

ToolbarPlacement

Returns

void

---

destroy()

destroy(): void

Defined in: ui/src/toolbar.ts:208

Returns

void

---

get()

get(id): ToolbarEntry | undefined

Defined in: ui/src/toolbar.ts:201

Parameters

id

string

Returns

ToolbarEntry | undefined

---

on()

on(event, listener): () => void

Defined in: ui/src/toolbar.ts:207

Subscribe to user layout edits (including reset); payload ids are in display order.

Parameters

event

"change"

listener

(payload) => void

Returns

() => void

---

openCustomization()

openCustomization(): void

Defined in: ui/src/toolbar.ts:203

Open the end-user panel; does nothing without the customize option.

Returns

void

---

refresh()

refresh(): void

Defined in: ui/src/toolbar.ts:188

Re-evaluate isActive, isDisabled and currentValue.

Returns

void

---

registerAction()

registerAction(action): () => void

Defined in: ui/src/toolbar.ts:205

Register an extra catalog button; returns its remover. Throws without the customize option.

Parameters

action

ToolbarAction

Returns

() => void

---

remove()

remove(id): void

Defined in: ui/src/toolbar.ts:200

Parameters

id

string

Returns

void

---

setItems()

setItems(items): void

Defined in: ui/src/toolbar.ts:192

Replace every item.

Parameters

items

ToolbarItem[]

Returns

void

---

setValue()

setValue(id, value): void

Defined in: ui/src/toolbar.ts:190

Programmatically change a segmented/menu item's value (no callback).

Parameters

id

string

value

string

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

---

update()

update(id, patch): void

Defined in: ui/src/toolbar.ts:194

Merge patch into an item and re-render only that item. Unknown ids are ignored.

Parameters

id

string

patch

ToolbarItemPatch

Returns

void