Class: PolarSubplot

Experimental

A polar subplot laid out (see the module comment).

Constructors

Constructor

new PolarSubplot(input): PolarSubplot;

Experimental

Parameters

Parameter	Type
input	PolarSubplotInput

Returns

PolarSubplot

Properties

Property	Modifier	Type	Default value	Description
angular	readonly	AngularConvert	undefined	Experimental
angularAxis	readonly	Container	undefined	Experimental
cx	readonly	number	undefined	Experimental
cy	readonly	number	undefined	Experimental
direction	readonly	-1 | 1	undefined	Experimental 1 counterclockwise, -1 clockwise.
full	readonly	boolean	undefined	Experimental
id	readonly	string	undefined	Experimental
initialAngle	readonly	number	undefined	Experimental
initialRange	readonly	readonly [number, number]	undefined	Experimental The radial range autorange / range gave (linear), before any interaction.
initialRotation	readonly	number	undefined	Experimental
innerRadius	readonly	number	undefined	Experimental
layout	readonly	Container	undefined	Experimental The subplot's defaulted layout container (fullLayout.polarN) of the build.
placement	readonly	PolarPlacement	undefined	Experimental
plotWidth	readonly	number	undefined	Experimental Plot area width (px), which sizes the angular axis' auto ticks as in Plotly.
radialAxis	readonly	Container	undefined	Experimental
radialScale	readonly	Scale	undefined	Experimental
radius	readonly	number	undefined	Experimental
sector	readonly	readonly [number, number]	undefined	Experimental
sectorDeg	readonly	readonly [number, number]	undefined	Experimental sector, sorted, in degrees and radians.
version	public	number	0	Experimental Incremented by every setView: views and caches compare it.

Accessors

angle

Get Signature

get angle(): number;

Experimental

Radial axis angle in use (degrees), before snapping to a polygon vertex.

Returns

number

---

radialAxisAngle

Get Signature

get radialAxisAngle(): number;

Experimental

The radial axis' drawn angle in degrees (snapped to the nearest vertex on polygon grids).

Returns

number

---

region

Get Signature

get region(): PolarRegion;

Experimental

The subplot's region in geometric px (see geometry.ts).

Returns

PolarRegion

---

rl

Get Signature

get rl(): readonly [number, number];

Experimental

Radial range in use (linear coordinates).

Returns

readonly [number, number]

---

rotation

Get Signature

get rotation(): number;

Experimental

Angular rotation in use (degrees).

Returns

number

---

tester

Get Signature

get tester(): RegionTester;

Experimental

Returns

RegionTester

---

vangles

Get Signature

get vangles(): readonly number[] | null;

Experimental

Polygon vertex angles (radians, counterclockwise) for gridshape: 'linear', else null.

Returns

readonly number[] | null

Methods

angularTicks()

angularTicks(): readonly PolarTick[];

Experimental

Angular ticks (at: geometric radians), cached per view.

Returns

readonly PolarTick[]

---

c2g()

c2g(c): number;

Experimental

Angular calc value → geometric radians.

Parameters

Parameter	Type
c	number

Returns

number

---

g2c()

g2c(g): number;

Experimental

Geometric radians → angular calc value.

Parameters

Parameter	Type
g	number

Returns

number

---

inside()

inside(x, y): boolean;

Experimental

Whether a point in geometric px is inside the subplot's region.

Parameters

Parameter	Type
x	number
y	number

Returns

boolean

---

onChange()

onChange(fn): () => void;

Experimental

Call fn after every setView; returns the unsubscribe function.

Parameters

Parameter	Type
fn	() => void

Returns

() => void

---

px2r()

px2r(px): number;

Experimental

Px from the center → radial linear coordinate (for zooms and hover).

Parameters

Parameter	Type
px	number

Returns

number

---

r2px()

r2px(l): number;

Experimental

Radial linear coordinate → px from the center (NaN for NaN).

Parameters

Parameter	Type
l	number

Returns

number

---

radialTicks()

radialTicks(): readonly PolarTick[];

Experimental

Radial ticks (at: px from the center), cached per view.

Returns

readonly PolarTick[]

---

rLabel()

rLabel(l): string;

Experimental

Hover text of a radial linear coordinate (Plotly formatLabels' rLabel).

Parameters

Parameter	Type
l	number

Returns

string

---

setView()

setView(view): void;

Experimental

Change the view (drags): the radial range (linear), the rotation or the radial axis angle (degrees). Every listener is notified.

Parameters

Parameter	Type
view	{ angle?: number; range?: readonly [number, number]; rotation?: number; }
view.angle?	number
view.range?	readonly [number, number]
view.rotation?	number

Returns

void

---

t2g()

t2g(t): number;

Experimental

Angular tick value (degrees, or category index) → geometric radians.

Parameters

Parameter	Type
t	number

Returns

number

---

thetaLabel()

thetaLabel(c): string;

Experimental

Hover text of an angular calc value (thetaLabel: degrees with °, radians, or category).

Parameters

Parameter	Type
c	number

Returns

string

---

toGeometric()

toGeometric(x, y): [number, number];

Experimental

Container px → geometric px.

Parameters

Parameter	Type
x	number
y	number

Returns

[number, number]