GeoMap

Defined in: map/geo-map.ts:60

Extends

• BaseEngine

Constructors

Constructor

new GeoMap(host, opts): GeoMap

Defined in: map/geo-map.ts:72

Parameters

host

HTMLElement

opts

GeoMapOptions

Returns

GeoMap

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

---

enableRotation()

enableRotation(opts?): this

Defined in: map/geo-map.ts:243

Drag to trackball-rotate a spherical projection; wheel to scale it. Re-projects on the CPU per frame and pushes the result to whatever backend is live, so every backend (canvas, svg, webgl) renders the identical crisp vector geometry. Layers flagged hideOnInteraction are hidden mid-gesture so dense data needn’t re-project per frame. (A GPU-side shader-projected globe — no per-frame CPU reprojection — is a possible future optimization; the backend retains dormant globe-rendering support.)

Parameters

opts?

RotationOptions = {}

Returns

this

---

enableZoom()

enableZoom(extent?, onTransform?): this

Defined in: map/geo-map.ts:224

One entry point for both projection kinds: a spherical (azimuthal) projection gets versor rotation (drag) + wheel-zoom bounded by extent; a flat projection gets d3-zoom affine pan/zoom. extent sets the zoom limits for both. Backend-agnostic: every backend renders the same per-frame-reprojected geometry, so a backend swap needs no re-dispatch (the interaction listeners and projection state are unaffected by it).

Parameters

extent?

[number, number] = ...

onTransform?

(t) => void

Returns

this

Overrides

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<F>(name, features, opts?): LayerHandle<F>

Defined in: map/geo-map.ts:128

Type Parameters

F

F

Parameters

name

string

features

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

opts?

LayerOptions<F> = {}

Returns

LayerHandle<F>

---

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

---

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

---

setProjection()

setProjection(projection): this

Defined in: map/geo-map.ts:208

Swap the projection on the existing map: re-project every layer once and reset the affine view to identity (the caller fits the new projection).

Parameters

projection

GeoProjection

Returns

this

---

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