Interface: ToolbarHost

Defined in: ui/toolbar.ts:4

The subset of Plot the toolbar drives. Kept minimal to avoid an import cycle.

Properties

drawTools?

optional drawTools?: {
  clear: void;
  get: string | null;
  onChange: void;
  set: void;
};

Defined in: ui/toolbar.ts:12

Optional: interactive drawing tools. Adds a tool group (trendline / hline / ray / fib / rect / clear) when present.

clear()

clear(): void;

Returns

void

get()

get(): string | null;

Returns

string | null

onChange()

onChange(cb): void;

Parameters

Parameter	Type
cb	(tool) => void

Returns

void

set()

set(tool): void;

Parameters

Parameter	Type
tool	string | null

Returns

void

Methods

download()?

optional download(): void;

Defined in: ui/toolbar.ts:10

Optional: download the current view as a PNG. Adds a toolbar button when present.

Returns

void

---

getMode()

getMode(): InteractionMode;

Defined in: ui/toolbar.ts:6

Returns

InteractionMode

---

home()

home(): void;

Defined in: ui/toolbar.ts:7

Returns

void

---

onModeChange()

onModeChange(cb): void;

Defined in: ui/toolbar.ts:8

Parameters

Parameter	Type
cb	(mode) => void

Returns

void

---

setMode()

setMode(mode): void;

Defined in: ui/toolbar.ts:5

Parameters

Parameter	Type
mode	InteractionMode

Returns

void