Skip to content

Interface: D3PAnnotationTextOptions ​

Defined in: core/annotation.ts:321

Options of an annotation text: the text, where it goes, its offset and its anchor.

Extends ​

Properties ​

anchor? ​

ts
anchor?: "middle" | "start" | "end";

Defined in: core/annotation.ts:334

Which side of its position the text starts from: start, middle (the default) or end.


at? ​

ts
at?: string | [number, number];

Defined in: core/annotation.ts:328

Where the text is centered: the center of the polar system with that name (the middle of a gauge), or, as a pair of fractions, a point of the inner area ([0.5, 0.5] is its middle).


bus? ​

ts
bus?: D3PBus;

Defined in: core/annotation.ts:45

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

Inherited from ​

D3PAnnotationOptions.bus


dx? ​

ts
dx?: number;

Defined in: core/annotation.ts:330

Offset in pixels from that place.


dy? ​

ts
dy?: number;

Defined in: core/annotation.ts:332

Offset of the text from its place, in pixels, on y.


label? ​

ts
label?: string;

Defined in: core/annotation.ts:47

The text written next to the mark.

Inherited from ​

D3PAnnotationOptions.label


style? ​

ts
style?: Partial<D3PAnnotationStyle>;

Defined in: core/annotation.ts:49

The style of the marks.

Inherited from ​

D3PAnnotationOptions.style


text ​

ts
text: string;

Defined in: core/annotation.ts:323

The text to write.