Skip to content

PlotOptions

Defined in: map/plot.ts:14

Plot adds no engine-level options of its own — all of BaseEngineOptions (sizing, backend, tooltipClass) apply.

optional aspectRatio?: number

Defined in: map/base-engine.ts:243

width ÷ height. When set, the engine is width-driven and keeps this ratio on resize.

BaseEngineOptions.aspectRatio


optional backend?: BackendType

Defined in: map/base-engine.ts:255

Which renderer to draw with — see BackendType. Defaults to "webgl". Use "auto" for an instant Canvas first paint that upgrades to WebGL in the background.

BaseEngineOptions.backend


optional curveTolerance?: number

Defined in: map/base-engine.ts:278

Max deviation, in world units, between a curve (arc / bezierCurveTo / quadraticCurveTo in a layer’s draw) and the polyline it is baked to. Default DEFAULT_CURVE_TOLERANCE (0.25).

The bake happens once, when a layer is registered, and the view transform only scales it — so a facet measuring t world units measures t·k screen px at zoom k (#45). A chart that zooms to kMax and wants sub-pixel curves therefore wants curveTolerance: 0.25 / kMax.

It is a quality/size dial, not a free win, and it is deliberately opt-in: an arc’s segment count grows as 1/sqrt(tolerance), so 0.25 / 40 bakes ~6.3× the vertices of the curved drawables only (straight paths, rects, and points() circles — which every backend draws analytically — are untouched). Costs nothing per frame.

One setting governs the whole engine, so it also refines anchored sizeMode: "screen" glyphs, whose offsets are used directly as pixels and therefore never facet — those extra vertices buy nothing. (An unanchored screen-sizeMode layer is world-scaled and does want the finer bake.) Splitting the tolerance per drawable is tracked separately.

BaseEngineOptions.curveTolerance


optional height?: number

Defined in: map/base-engine.ts:241

BaseEngineOptions.height


optional tooltipClass?: string

Defined in: map/base-engine.ts:257

Class(es) for the hover tooltip box, replacing its default inline look.

BaseEngineOptions.tooltipClass


optional width?: number

Defined in: map/base-engine.ts:240

BaseEngineOptions.width