Interface: PolarOptions

Defined in: polar/polar.ts:10

Properties

angleUnit?

optional angleUnit?: "rad" | "deg";

Defined in: polar/polar.ts:13

Angle unit of input theta values. Default "rad".

---

hover?

optional hover?: boolean;

Defined in: polar/polar.ts:20

Enable hover: highlight the nearest point + show a tooltip. Default true.

---

interactive?

optional interactive?: boolean;

Defined in: polar/polar.ts:18

Enable wheel-zoom (r scale) and drag-rotate interaction. Default true.

---

margin?

optional margin?: number;

Defined in: polar/polar.ts:16

---

maxRadius?

optional maxRadius?: number;

Defined in: polar/polar.ts:15

Fixed max radius. If omitted, autoscales to the data.

---

offscreenCulling?

optional offscreenCulling?: boolean;

Defined in: polar/polar.ts:34

Skip drawing while the chart is scrolled out of view, and draw once as it comes back. Default false — a chart draws whenever it is asked to.

Turn it on for a page that holds many charts. A frame costs the same whether or not anyone can see it, and most charts on a long page are off-screen at any moment. The saving is largest in Firefox, where reading the shared WebGL canvas back into a chart's own canvas costs ~1ms per chart per frame: on a 52-chart page that is 15fps against 58. Photon can only skip its own drawing, so ask Plot.isOnScreen before regenerating the data too.

---

pointInfo?

optional pointInfo?: "click" | "hover";

Defined in: polar/polar.ts:40

How the pinned point-info box is triggered: "click" pins a point until empty space is clicked; "hover" shows the point under the cursor automatically (no click). Default "click".

---

showToolbar?

optional showToolbar?: boolean;

Defined in: polar/polar.ts:22

Show the built-in home (reset) button. Default true.

---

theme?

optional theme?: Theme | "light" | "dark";

Defined in: polar/polar.ts:11