Skip to content

Interface: D3PPolarOptions ​

Defined in: core/coords.ts:334

Options of a polar system: its name and its props.

Extends ​

Properties ​

bus? ​

ts
bus?: D3PBus;

Defined in: core/coords.ts:75

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

Inherited from ​

D3PCoordinateSystemOptions.bus


name? ​

ts
name?: string;

Defined in: core/coords.ts:77

Identifier on the chart; axes refer to it with their system option.

Inherited from ​

D3PCoordinateSystemOptions.name


props? ​

ts
props?: object;

Defined in: core/coords.ts:336

Initial props of the system.

clockwise? ​

ts
clockwise?: boolean;

Whether the angle grows clockwise (default true).

innerRadius? ​

ts
innerRadius?: number;

Hole radius as a fraction of the outer radius (0 = full disc, 0.5 = ring).

padding? ​

ts
padding?: number;

Pixels kept free around the disc, for the angle labels.

reach? ​

ts
reach?: number;

How far beyond the ring, in pixels, the pointer still counts as being over the system. There it reads the angle and the outer radius, so the tooltip, the markers and the radius axis that follows the pointer keep working around the chart, not only on the disc.

shift? ​

ts
shift?: [number, number];

Moves the center, as fractions of the outer radius: [0, 0.5] lowers a half disc so that it sits in the middle.

startAngle? ​

ts
startAngle?: number;

Screen angle (degrees) at which the angle range starts: 0 = up.

sweep? ​

ts
sweep?: number;

Angle covered by the system, in degrees: 360 is a full circle, 180 a half (gauges, semi-donuts).