Interface: D3PTitleOptions ​

Defined in: core/titles.ts:34

Options of a title: the side it sits on, its size, its props (text, subtitle, style) and the bus.

Properties ​

bus? ​

ts
bus?: D3PBus;

Defined in: core/titles.ts:36

The bus the title uses (the global bus by default).

props? ​

ts
props?: object & object;

Defined in: core/titles.ts:42

Props of the title: at least its text.

Type Declaration ​

align? ​
ts
align?: "start" | "end" | "center";

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

style? ​
ts
style?: object;

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

style.color? ​
ts
color?: string;
style.fontSize? ​
ts
fontSize?: number;
style.fontWeight? ​
ts
fontWeight?: string;
style.subtitleColor? ​
ts
subtitleColor?: string;
style.subtitleFontSize? ​
ts
subtitleFontSize?: number;
subtitle? ​
ts
subtitle?: string;

A smaller line under the title.

text? ​
ts
text?: string;

The title.

text ​
ts
text: string;

side? ​

ts
side?: "top" | "bottom";

Defined in: core/titles.ts:38

Above the chart (default) or under it.

size? ​

ts
size?: number;

Defined in: core/titles.ts:40

Height of the strip in pixels; default: fits the title, and the subtitle if there is one.