Class: D3PZoomSelectionTool

Defined in: core/tools/zoom-selection.ts:28

Zoom to a dragged selection (name: 'zoom-selection'): a rectangle on cartesian axes, an annular sector on polar ones. Axes without a value at either end of the drag are left alone.

Extends

• D3PTool<SelData>

Constructors

Constructor

new D3PZoomSelectionTool(opts?): D3PZoomSelectionTool;

Defined in: core/tools/zoom-selection.ts:32

Parameters

opts?

D3PZoomSelectionToolOptions = {}

Returns

D3PZoomSelectionTool

Overrides

D3PTool.constructor

Methods

addToChart()

addToChart(chart): void;

Defined in: core/object.ts:77

Attaches the object to a chart; nothing happens if it already is attached to it.

Parameters

chart

D3PChart

Returns

void

Inherited from

D3PTool.addToChart

---

attached()

protected attached(
   chart, 
   data, 
   subs
): void;

Defined in: core/tools/zoom-selection.ts:41

Subscribe / create DOM. Subscriptions added to subs are released on detach.

Parameters

chart

D3PChart

data

SelData

subs

D3PSubscriptions

Returns

void

Overrides

D3PTool.attached

---

createData()

protected createData(): SelData;

Defined in: core/tools/zoom-selection.ts:37

Build the per-chart record. Must not rely on other objects of the chart.

Returns

SelData

Overrides

D3PTool.createData

---

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

D3PTool.destroy

---

detached()

protected detached(_chart, data): void;

Defined in: core/tools/zoom-selection.ts:89

DOM / registry cleanup (subscriptions are released afterwards).

Parameters

_chart

D3PChart

data

SelData

Returns

void

Overrides

D3PTool.detached

---

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

D3PTool.fire

---

getCharts()

getCharts(): D3PChart[];

Defined in: core/object.ts:105

The charts the object is attached to.

Returns

D3PChart[]

Inherited from

D3PTool.getCharts

---

hasChart()

hasChart(chart): boolean;

Defined in: core/object.ts:110

Whether the object is attached to this chart.

Parameters

chart

D3PChart

Returns

boolean

Inherited from

D3PTool.hasChart

---

isActiveOn()

protected isActiveOn(chart): boolean;

Defined in: core/tools/base.ts:55

Whether the tool is attached to this chart and alive.

Parameters

chart

D3PChart

Returns

boolean

Inherited from

D3PTool.isActiveOn

---

onDestroy()

protected onDestroy(): void;

Defined in: core/object.ts:114

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

Returns

void

Inherited from

D3PTool.onDestroy

---

rangeOf()

protected rangeOf(
   axis, 
   point, 
   system?, 
   cache?
): number | undefined;

Defined in: core/tools/base.ts:44

Position of point along axis, in the range units of its system (pixels for a cartesian axis, radians or distance to the center for a polar one). Not limited to the system, so a drag keeps working when the pointer leaves it. system defaults to the live one of the axis; a gesture that compares with its start passes the system of its snapshot.

Parameters

axis

D3PAxis

point

D3PViewportPoint

system?

D3PSystemProjector | undefined = ...

cache?

D3PProjectionCache

Returns

number | undefined

Inherited from

D3PTool.rangeOf

---

removeFromChart()

removeFromChart(chart): void;

Defined in: core/object.ts:95

Detaches the object from a chart; nothing happens if it is not attached to it.

Parameters

chart

D3PChart

Returns

void

Inherited from

D3PTool.removeFromChart

---

render()

render(_chart): void | Promise<void>;

Defined in: core/object.ts:129

Draws the object on a chart. The render manager calls it, once per frame, for the objects that asked for it.

Parameters

_chart

D3PChart

Returns

void | Promise<void>

Inherited from

D3PTool.render

---

requireArea()

protected requireArea(chart): void;

Defined in: core/tools/base.ts:50

Ask for an interaction area (tools driven by the mouse need one).

Parameters

chart

D3PChart

Returns

void

Inherited from

D3PTool.requireArea

---

resolveAxes()

protected resolveAxes(chart): D3PAxis[];

Defined in: core/tools/base.ts:33

The axes the tool acts on: the ones it is restricted to, or all those of the chart.

Parameters

chart

D3PChart

Returns

D3PAxis[]

Inherited from

D3PTool.resolveAxes

---

tagDirty()

tagDirty(chart?): void;

Defined in: core/object.ts:119

Schedule a redraw on one chart (or all attached charts).

Parameters

chart?

D3PChart

Returns

void

Inherited from

D3PTool.tagDirty

Properties

axes

readonly axes: D3PAxisFilter | undefined;

Defined in: core/tools/base.ts:25

The axes the tool is restricted to (objects or names), if any.

Inherited from

D3PTool.axes

---

bus

readonly bus: D3PBus;

Defined in: core/object.ts:27

The bus the object uses for its events.

Inherited from

D3PTool.bus

---

chartData

protected readonly chartData: Map<D3PChart, SelData>;

Defined in: core/object.ts:66

What the object keeps for each chart it is attached to.

Inherited from

D3PTool.chartData

---

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

D3PTool.e

---

isDestroying

isDestroying: boolean = false;

Defined in: core/object.ts:31

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

Inherited from

D3PTool.isDestroying

---

minDelta

minDelta: number;

Defined in: core/tools/zoom-selection.ts:30

The smallest drag, in pixels, that counts as a selection.

---

name

readonly name: string;

Defined in: core/tools/base.ts:27

Inherited from

D3PTool.name

---

subs

protected readonly subs: D3PSubscriptions;

Defined in: core/object.ts:33

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

Inherited from

D3PTool.subs