Plot

Defined in: map/plot.ts:76

Extends

• BaseEngine

Constructors

Constructor

new Plot(host, opts?): Plot

Defined in: map/plot.ts:77

Parameters

host

HTMLElement

opts?

PlotOptions = {}

Returns

Plot

Overrides

BaseEngine.constructor

Methods

clearStyle()

clearStyle(name, ids?): this

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

Remove overrides (all of the layer’s when ids is omitted) and restore base styles.

Parameters

name

string

ids?

string | number | readonly (string | number)[]

Returns

this

Inherited from

BaseEngine.clearStyle

---

destroy()

destroy(): void

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

Returns

void

Inherited from

BaseEngine.destroy

---

disableInteraction()

disableInteraction(): this

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

Detach the current pan/zoom or rotation interaction (no-op if none).

Returns

this

Inherited from

BaseEngine.disableInteraction

---

enableZoom()

enableZoom(extent?, onTransform?): this

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

Enable scroll-to-zoom / drag-to-pan via d3-zoom, clamped to extent. The optional onTransform callback fires after each setTransform during zoom — use it to keep an HTML overlay (e.g. a LabelLayer) aligned with the GPU geometry as the view changes.

Parameters

extent?

[number, number] = ...

onTransform?

(t) => void

Returns

this

Inherited from

BaseEngine.enableZoom

---

highlight()

highlight(name, idOrIds, styleOrDraw?): this

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

Highlight one drawable / a set of drawables of name by drawing them into a tiny internal overlay layer on top (inheriting the source’s clipTo/sizeMode) — the base layer’s buffers are untouched, so the per-change cost is tessellating the highlighted items only. styleOrDraw falls back to the layer’s hover option, then to the default white outline. null clears.

Parameters

name

string

idOrIds

string | number | readonly (string | number)[] | null

styleOrDraw?

HighlightStyle | HighlightDraw

Returns

this

Inherited from

BaseEngine.highlight

---

layer()

layer<D>(name, data, opts): LayerHandle<D>

Defined in: map/plot.ts:81

Type Parameters

D

D

Parameters

name

string

data

readonly D[]

opts

PlotLayerOptions<D>

Returns

LayerHandle<D>

---

on()

on(event, cb): this

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

Parameters

event

"click" | "hover"

cb

(hit, ev) => void

Returns

this

Inherited from

BaseEngine.on

---

pick()

pick(x, y): HoverHit | null

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

Parameters

x

number

y

number

Returns

HoverHit | null

Inherited from

BaseEngine.pick

---

points()

points<D>(name, data, opts): LayerHandle<D>

Defined in: map/plot.ts:89

Type Parameters

D

D

Parameters

name

string

data

readonly D[] | (() => readonly D[])

opts

PlotPointOptions<D>

Returns

LayerHandle<D>

---

recolor()

recolor(name): this

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

Parameters

name

string

Returns

this

Inherited from

BaseEngine.recolor

---

render()

render(): this

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

Returns

this

Inherited from

BaseEngine.render

---

select()

select(name, set): this

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

Select a set of drawables: style members with the layer’s selection.selected (default: keep base style) and the complement with selection.others (default { opacity: 0.3 }). One O(n) compose + one styles-only push — click-time cost only, nothing per frame. null clears. NOTE: selection rewrites the layer’s whole override map, so it replaces earlier setStyle overrides (one table, last write wins) — and select(null) restores plain base styles.

Parameters

name

string

set

readonly (string | number)[] | ((d, i) => boolean) | null

Returns

this

Inherited from

BaseEngine.select

---

setBackend()

setBackend(type): this

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

Parameters

type

BackendType

Returns

this

Inherited from

BaseEngine.setBackend

---

setClip()

setClip(name, clipTo?): this

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

Parameters

name

string

clipTo?

string

Returns

this

Inherited from

BaseEngine.setClip

---

setSize()

setSize(width, height): this

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

Resize the engine in place to a new CSS size (px) — no teardown. Resizes the live backend, runs the subclass onResize hook (e.g. GeoMap refits its projection), then re-renders and repaints pass-through layers. Layers, view transform, and interaction state are preserved. A no-op when the size is unchanged or either axis is zero (a collapsed/hidden layout). In responsive modes the ResizeObserver calls this automatically; callers in fixed mode use it to apply a new explicit size without recreating the engine.

Parameters

width

number

height

number

Returns

this

Inherited from

BaseEngine.setSize

---

setStyle()

setStyle(name, ids, override): this

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

Override the style of one drawable or a set (replaces any previous override for those ids — last write wins). O(ids) compose + one styles-only push.

Parameters

name

string

ids

string | number | readonly (string | number)[]

override

StyleOverride

Returns

this

Inherited from

BaseEngine.setStyle

---

setTransform()

setTransform(t): this

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

Parameters

t

ViewTransform

Returns

this

Inherited from

BaseEngine.setTransform

---

toPNG()

toPNG(): string

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

Returns

string

Inherited from

BaseEngine.toPNG

---

toSVG()

toSVG(): string

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

Returns

string

Inherited from

BaseEngine.toSVG

---

whenReady()

whenReady(): Promise<void>

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

Returns

Promise<void>

Inherited from

BaseEngine.whenReady