Class: D3PLegendManager ​

Defined in: core/legend.ts:30

Computes the legend of each chart from the entries of its renderers (names, colors, visibility).

Extends ​

Constructors ​

Constructor ​

ts
new D3PLegendManager(opts?): D3PLegendManager;

Defined in: core/legend.ts:34

Parameters ​

opts? ​

D3PLegendManagerOptions = {}

Returns ​

D3PLegendManager

Overrides ​

D3PAttachable.constructor

Methods ​

addToChart() ​

ts
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 ​

D3PAttachable.addToChart

attached() ​

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

Defined in: core/legend.ts:43

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

Parameters ​

chart ​

D3PChart

data ​

LegendData

subs ​

D3PSubscriptions

Returns ​

void

Overrides ​

D3PAttachable.attached

createData() ​

ts
protected createData(): LegendData;

Defined in: core/legend.ts:39

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

Returns ​

LegendData

Overrides ​

D3PAttachable.createData

destroy() ​

ts
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 ​

D3PAttachable.destroy

detached() ​

ts
protected detached(_chart, data): void;

Defined in: core/legend.ts:48

DOM / registry cleanup (subscriptions are released afterwards).

Parameters ​

_chart ​

D3PChart

data ​

LegendData

Returns ​

void

Overrides ​

D3PAttachable.detached

fire() ​

ts
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 ​

D3PAttachable.fire

getCharts() ​

ts
getCharts(): D3PChart[];

Defined in: core/object.ts:105

The charts the object is attached to.

Returns ​

D3PChart[]

Inherited from ​

D3PAttachable.getCharts

getLegend() ​

ts
getLegend(chart): D3PLegend;

Defined in: core/legend.ts:79

What the legend shows for a chart: an entry for each part of the renderers it lists.

Parameters ​

chart ​

D3PChart

Returns ​

D3PLegend

hasChart() ​

ts
hasChart(chart): boolean;

Defined in: core/object.ts:110

Whether the object is attached to this chart.

Parameters ​

chart ​

D3PChart

Returns ​

boolean

Inherited from ​

D3PAttachable.hasChart

onDestroy() ​

ts
protected onDestroy(): void;

Defined in: core/object.ts:114

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

Returns ​

void

Inherited from ​

D3PAttachable.onDestroy

refresh() ​

ts
refresh(chart): void;

Defined in: core/legend.ts:84

Force the emission of the current legend of chart.

Parameters ​

chart ​

D3PChart

Returns ​

void

removeFromChart() ​

ts
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 ​

D3PAttachable.removeFromChart

render() ​

ts
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 ​

D3PAttachable.render

tagDirty() ​

ts
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 ​

D3PAttachable.tagDirty

Properties ​

bus ​

ts
readonly bus: D3PBus;

Defined in: core/object.ts:27

The bus the object uses for its events.

Inherited from ​

D3PAttachable.bus

chartData ​

ts
protected readonly chartData: Map<D3PChart, LegendData>;

Defined in: core/object.ts:66

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

Inherited from ​

D3PAttachable.chartData

e ​

ts
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 ​

D3PAttachable.e

isDestroying ​

ts
isDestroying: boolean = false;

Defined in: core/object.ts:31

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

Inherited from ​

D3PAttachable.isDestroying

series ​

ts
readonly series: 
  | readonly (string | D3PSeriesRenderer<any, any>)[]
  | undefined;

Defined in: core/legend.ts:32

The renderers the legend is restricted to, if any.

subs ​

ts
protected readonly subs: D3PSubscriptions;

Defined in: core/object.ts:33

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

Inherited from ​

D3PAttachable.subs