Class: PolarPlot

Defined in: polar/polar.ts:93

A polar (r, θ) plot: concentric radial grid + angular spokes, WebGL data.

Constructors

Constructor

new PolarPlot(container, options?): PolarPlot;

Defined in: polar/polar.ts:135

Parameters

Parameter	Type
container	HTMLElement
options	PolarOptions

Returns

PolarPlot

Methods

addLine()

addLine(opts): PolarSeries;

Defined in: polar/polar.ts:243

Parameters

Parameter	Type
opts	PolarLineOptions

Returns

PolarSeries

---

addScatter()

addScatter(opts): PolarSeries;

Defined in: polar/polar.ts:254

Parameters

Parameter	Type
opts	PolarScatterOptions

Returns

PolarSeries

---

copyToClipboard()

copyToClipboard(opts?): Promise<void>;

Defined in: polar/polar.ts:359

Copy the current view to the clipboard as a PNG.

Parameters

Parameter	Type
opts	ExportOptions

Returns

Promise<void>

---

destroy()

destroy(): void;

Defined in: polar/polar.ts:373

Returns

void

---

downloadImage()

downloadImage(
   filename?, 
   type?, 
opts?): Promise<void>;

Defined in: polar/polar.ts:354

Download the current view as an image (PNG by default).

Parameters

Parameter	Type	Default value
filename	string	"chart.png"
type	string	"image/png"
opts	ExportOptions	{}

Returns

Promise<void>

---

getRotation()

getRotation(): number;

Defined in: polar/polar.ts:311

Current rotation offset in radians (CCW).

Returns

number

---

home()

home(): void;

Defined in: polar/polar.ts:302

Reset zoom (r-domain) and rotation back to the initial view.

Returns

void

---

isOnScreen()

isOnScreen(): boolean;

Defined in: polar/polar.ts:369

Whether this chart is currently on screen (plus a small margin), as offscreenCulling judges it. Photon already skips its own drawing while a chart is out of view; a streaming app should check this before regenerating data and calling setData, which uploads to the GPU regardless.

Returns

boolean

---

render()

render(): void;

Defined in: polar/polar.ts:425

Returns

void

---

requestRender()

requestRender(): void;

Defined in: polar/polar.ts:412

Returns

void

---

setRotation()

setRotation(rad): void;

Defined in: polar/polar.ts:316

Set the rotation offset (radians, CCW) and redraw.

Parameters

Parameter	Type
rad	number

Returns

void

---

toBlob()

toBlob(type?, opts?): Promise<Blob | null>;

Defined in: polar/polar.ts:349

Export the current view as a Blob (default PNG).

Parameters

Parameter	Type	Default value
type	string	"image/png"
opts	ExportOptions	{}

Returns

Promise<Blob | null>

---

toDataURL()

toDataURL(type?, opts?): string;

Defined in: polar/polar.ts:344

Export the current view as a data URL (default PNG).

Parameters

Parameter	Type	Default value
type	string	"image/png"
opts	ExportOptions	{}

Returns

string