Class: D3PToolbox

Defined in: core/tools/toolbox.ts:29

Registry of named tools over N charts, a subset of which is active. Activating a tool attaches it to every chart of the toolbox; deactivating detaches it.

Extends

• D3PObject<{ toolStateChanged: { state: boolean; tool: D3PToolLike; }; }>

Accessors

mutuallyExclusiveGroups

Get Signature

get mutuallyExclusiveGroups(): string[][];

Defined in: core/tools/toolbox.ts:42

The groups of tool names of which only one is active at a time ([['pan', 'zoom-selection']]).

Returns

string[][]

Constructors

Constructor

new D3PToolbox(opts?): D3PToolbox;

Defined in: core/tools/toolbox.ts:36

Parameters

opts?

D3PToolboxOptions = {}

Returns

D3PToolbox

Overrides

D3PObject.constructor

Methods

addToChart()

addToChart(chart): void;

Defined in: core/tools/toolbox.ts:67

Attaches the toolbox to a chart: the active tools work there.

Parameters

chart

D3PChart

Returns

void

---

addTool()

addTool(tool): void;

Defined in: core/tools/toolbox.ts:53

Adds a tool. Throws an error if a tool has its name. It is not active until setToolActive.

Parameters

tool

D3PToolLike

Returns

void

---

deactivateAll()

deactivateAll(): void;

Defined in: core/tools/toolbox.ts:105

Deactivates every tool.

Returns

void

---

destroy()

destroy(): void;

Defined in: core/object.ts:51

Detaches the object from all its charts, announces destroyed and releases its subscriptions. The object cannot be used afterwards.

Returns

void

Inherited from

D3PObject.destroy

---

fire()

protected fire<P>(event, ...args): void;

Defined in: core/object.ts:41

Emits one of its own events on the bus.

Type Parameters

P

P

Parameters

event

D3PEvent<P>

args

...P extends void ? [] : [payload: P]

Returns

void

Inherited from

D3PObject.fire

---

getActiveTool()

getActiveTool(): D3PToolLike | null;

Defined in: core/tools/toolbox.ts:114

The first active tool, or null.

Returns

D3PToolLike | null

---

getActiveTools()

getActiveTools(): D3PToolLike[];

Defined in: core/tools/toolbox.ts:119

The tools that are active.

Returns

D3PToolLike[]

---

getTool()

getTool<T>(name): T | undefined;

Defined in: core/tools/toolbox.ts:127

The tool of that name, if any.

Type Parameters

T

T extends D3PToolLike = D3PToolLike

Parameters

name

string

Returns

T | undefined

---

getTools()

getTools(): D3PToolLike[];

Defined in: core/tools/toolbox.ts:131

All the tools, active or not.

Returns

D3PToolLike[]

---

hasToolActive()

hasToolActive(): boolean;

Defined in: core/tools/toolbox.ts:110

Whether at least one tool is active.

Returns

boolean

---

isToolActive()

isToolActive(name): boolean;

Defined in: core/tools/toolbox.ts:123

Whether the tool of that name is active.

Parameters

name

string

Returns

boolean

---

onDestroy()

protected onDestroy(): void;

Defined in: core/tools/toolbox.ts:135

Hook run first on destroy (detach from partners, release DOM...).

Returns

void

Overrides

D3PObject.onDestroy

---

removeFromChart()

removeFromChart(chart): void;

Defined in: core/tools/toolbox.ts:75

Detaches the toolbox from a chart.

Parameters

chart

D3PChart

Returns

void

---

removeTool()

removeTool(name): void;

Defined in: core/tools/toolbox.ts:59

Removes a tool (and deactivates it).

Parameters

name

string

Returns

void

---

setMutuallyExclusiveGroups()

setMutuallyExclusiveGroups(groups): void;

Defined in: core/tools/toolbox.ts:47

Sets the groups of mutually exclusive tools. Active tools that conflict are deactivated.

Parameters

groups

string[][]

Returns

void

---

setToolActive()

setToolActive(name, active?): void;

Defined in: core/tools/toolbox.ts:85

Activates or deactivates a tool. Activating a tool deactivates the others of its groups. Throws an error for an unknown name.

Parameters

name

string

active?

boolean = true

Returns

void

Properties

bus

readonly bus: D3PBus;

Defined in: core/object.ts:27

The bus the object uses for its events.

Inherited from

D3PObject.bus

---

e

readonly e: D3PEventTable<M & object>;

Defined in: core/object.ts:29

The events of the object, by name: destroyed for all, and its own (axis.e.scaleChanged).

Inherited from

D3PObject.e

---

isDestroying

isDestroying: boolean = false;

Defined in: core/object.ts:31

Set when destroy starts: the object is not drawn after that.

Inherited from

D3PObject.isDestroying

---

subs

protected readonly subs: D3PSubscriptions;

Defined in: core/object.ts:33

The subscriptions of the object, released when it is destroyed.

Inherited from

D3PObject.subs