GeoMap

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

Extends

BaseEngine

Constructors

Constructor

new GeoMap(host, opts): GeoMap

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

Parameters

host

HTMLElement

opts

GeoMapOptions

Returns

GeoMap

Overrides

BaseEngine.constructor

Methods

clearStyle()

clearStyle(name, ids?): this

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

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:1678

Returns

void

Inherited from

BaseEngine.destroy

disableInteraction()

disableInteraction(): this

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

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:290

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:271

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()

Call Signature

highlight(name, idOrIds, style?): this

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

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.

The draw-fn overload is generic over the layer’s datum type D (caller-asserted, like select’s predicate) so a custom highlight draw sees a typed datum.

Parameters

name

string

idOrIds

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

style?

HighlightStyle

Returns

this

Inherited from

BaseEngine.highlight

Call Signature

highlight<D>(name, idOrIds, draw): this

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

The draw-fn overload is generic over the layer’s datum type D (caller-asserted, like select’s predicate) so a custom highlight draw sees a typed datum.

Type Parameters

D

D = unknown

Parameters

name

string

idOrIds

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

draw

HighlightDraw<D>

Returns

this

Inherited from

BaseEngine.highlight

labels()

Call Signature

labels(data): this

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

Show engine-owned text labels (#223): supply the data and d3-style accessors, and the engine measures each label’s text once, then places + culls collisions and re-places them on every pan/zoom (no manual overlay, transform callback, or text-metric estimates). anchorOf returns a PROJECTED point — e.g. projection(feature.geometry.coordinates) (return null to skip a feature off the globe). Rendered by the active backend — an HTML overlay on WebGL, native <text>/fillText on SVG/Canvas so labels survive toSVG()/toPNG() export. Pass false to remove; re-call to rebuild after the projection changes.

Parameters

data

false

Returns

this

Call Signature

labels<D>(data, opts): this

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

Type Parameters

D

D

Parameters

data

readonly D[]

opts

DataLabelOptions<D>

Returns

this

layer()

layer<F>(name, features, opts?): LayerHandle<F>

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

Declare (or re-declare) a named layer of GeoJSON features, projected once through the map’s projection and retained so every backend re-renders the same crisp vector geometry. features may be a single Feature/geometry, an array of them, or — only with passThrough: true — a callback re-invoked each repaint (the uncapped, non-pickable streaming path). Re-declaring an existing name replaces the layer and resets its interaction/style state. Returns a LayerHandle for appending data and per-layer styling. (Wind exterior polygon rings clockwise in [lon, lat] — see the project docs.)

Type Parameters

F

F extends GeoInput

the feature/datum type carried through to accessors and hit results.

Parameters

name

string

features

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

opts?

LayerOptions<F> = {}

Returns

LayerHandle<F>

on()

Call Signature

on(event, cb): this

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

Parameters

event

"click" | "hover"

cb

(hit, ev) => void

Returns

this

Inherited from

BaseEngine.on

Call Signature

on(event, cb): this

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

Parameters

event

"select"

cb

(selected, ev?) => void

Returns

this

Inherited from

BaseEngine.on

pick()

pick(x, y, exact?): HoverHit | null

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

Parameters

x

number

y

number

exact?

boolean = true

Returns

HoverHit | null

Inherited from

BaseEngine.pick

recolor()

recolor(name): this

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

Parameters

name

string

Returns

this

Inherited from

BaseEngine.recolor

render()

render(): this

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

Returns

this

Inherited from

BaseEngine.render

select()

Call Signature

select(name, set): this

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

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.

Also updates the managed selection set and fires on("select") with ev = undefined (programmatic — no PointerEvent), so callers can observe programmatic selection the same way they observe gesture selection.

The predicate overload is generic over the layer’s datum type D — annotate the parameter ((d: MyDatum) => …) or pass select<MyDatum>(…) to get a typed datum, mirroring d3-selection’s caller-asserted datum generics. Prefer the layer handle’s LayerHandle.select, which already knows D from registration.

Parameters

name

string

set

readonly (string | number)[] | null

Returns

this

Inherited from

BaseEngine.select

Call Signature

select<D>(name, predicate): this

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

Type Parameters

D

D = unknown

Parameters

name

string

predicate

(d, i) => boolean

Returns

this

Inherited from

BaseEngine.select

selection()

selection(): HoverHit[]

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

Flatten the retained selection into HoverHit[], resolving datums + members() via the layer’s Scene spec or its interactive lane (so a selected aggregate’s leaf ids are reachable, #105 N7c-2).

Returns

HoverHit[]

Inherited from

BaseEngine.selection

setBackend()

setBackend(type): this

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

Parameters

type

BackendType

Returns

this

Inherited from

BaseEngine.setBackend

setClip()

setClip(name, clipTo?): this

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

Parameters

name

string

clipTo?

string

Returns

this

Inherited from

BaseEngine.setClip

setProjection()

setProjection(projection): this

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

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:487

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:963

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:1267

Parameters

t

ViewTransform

Returns

this

Inherited from

BaseEngine.setTransform

toPNG()

toPNG(): string

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

Returns

string

Inherited from

BaseEngine.toPNG

toSVG()

toSVG(): string

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

Returns

string

Inherited from

BaseEngine.toSVG

whenReady()

whenReady(): Promise<void>

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

Returns

Promise<void>

Inherited from

BaseEngine.whenReady