Skip to content

Interface: D3PAxisTitleOptions ​

Defined in: core/titles.ts:140

Options of an axis title: the axis it names, its size, its props and the bus.

Properties ​

axis ​

ts
axis: string | D3PAxis;

Defined in: core/titles.ts:144

The axis (object or name) the title is for.


bus? ​

ts
bus?: D3PBus;

Defined in: core/titles.ts:142

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


props? ​

ts
props?: object;

Defined in: core/titles.ts:148

Initial props of the axis title.

align? ​

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

Where it is along the axis: its start, its middle (the default) or its end.

gap? ​

ts
gap?: number;

Pixels between the tick labels of the axis and its title (cartesian axes).

style? ​

ts
style?: object;

Color, size and weight of the text.

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

text? ​

ts
text?: string;

Default: the display name of the axis.


size? ​

ts
size?: number;

Defined in: core/titles.ts:146

Thickness of the title in pixels: its height on a top or bottom axis, its width on a left or right one (default 18).