Class: D3PTitle ​

Defined in: core/titles.ts:48

A title over (or under) the plot, with an optional subtitle.

Extends ​

Accessors ​

props ​

Get Signature ​

ts
get props(): D3PProps<D3PTitleProps>;

Defined in: core/titles.ts:64

The props of the title: its text, its subtitle, its alignment and its style.

Returns ​

D3PProps<D3PTitleProps>

Set Signature ​

ts
set props(v): void;

Defined in: core/titles.ts:68

Merges props into those of the title.

Parameters ​
v ​
align? ​

"start" | "end" | "center"

Along the plot: the start, the middle or the end of it.

style? ​

{ color?: string; fontSize?: number; fontWeight?: string; subtitleColor?: string; subtitleFontSize?: number; }

Colors, sizes and weight of the title and of the subtitle.

style.color? ​

string

style.fontSize? ​

number

style.fontWeight? ​

string

style.subtitleColor? ​

string

style.subtitleFontSize? ​

number

subtitle? ​

string

A smaller line under the title.

text? ​

string

The title.

Returns ​

void

Constructors ​

Constructor ​

ts
new D3PTitle(opts): D3PTitle;

Defined in: core/titles.ts:56

Parameters ​

opts ​

D3PTitleOptions

Returns ​

D3PTitle

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): void;

Defined in: core/titles.ts:82

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

Parameters ​

chart ​

D3PChart

Returns ​

void

Overrides ​

D3PAttachable.attached

createData() ​

ts
protected createData(): object;

Defined in: core/titles.ts:78

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

Returns ​

object

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): void;

Defined in: core/titles.ts:87

DOM / registry cleanup (subscriptions are released afterwards).

Parameters ​

chart ​

D3PChart

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

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/titles.ts:91

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

Returns ​

void

Overrides ​

D3PAttachable.onDestroy

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, {
}>;

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

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