Interface: EngineAdapter
Defined in: runtime/adapter.ts:58
Properties
id
id:
"maplibre"|"deckgl"
Defined in: runtime/adapter.ts:59
Methods
applyPatch()?
optionalapplyPatch(patch):void
Defined in: runtime/adapter.ts:67
Parameters
| Parameter | Type |
|---|---|
patch | SpecPatch |
Returns
void
destroy()
destroy():
void
Defined in: runtime/adapter.ts:94
Returns
void
getCapabilities()
getCapabilities():
CapabilitySet
Defined in: runtime/adapter.ts:60
Returns
getNativeInstance()
getNativeInstance():
unknown
Defined in: runtime/adapter.ts:95
Returns
unknown
mount()
mount(
container,spec,viewId):MountedView
Defined in: runtime/adapter.ts:61
Parameters
| Parameter | Type |
|---|---|
container | HTMLElement |
spec | VisualizationSpec |
viewId | string |
Returns
onViewChange()?
optionalonViewChange(listener): () =>void
Defined in: runtime/adapter.ts:93
Subscribes to camera moves of every view this adapter mounts, including views mounted after the call. Returns the unsubscribe. Optional: an adapter without it simply reports nothing, and whatever relies on it (the split map mode keeping its two sides together) degrades to independent cameras.
Parameters
| Parameter | Type |
|---|---|
listener | (camera) => void |
Returns
() => void
setPinFocus()?
optionalsetPinFocus(focus):void
Defined in: runtime/adapter.ts:85
Hides every pin on the map — every symbol layer — while a pin is in
focus, so the caller can draw that pin itself above what it draws around
it, until called with null, which shows every pin the spec turns on
again. Holds across spec updates. What a proximity search does while it
shows the places around a pin. Optional: an adapter without it leaves
every pin on the map.
Parameters
| Parameter | Type |
|---|---|
focus | PinFocus | null |
Returns
void
setSelection()?
optionalsetSelection(selection):void
Defined in: runtime/adapter.ts:76
Applies (or, with null, clears) the runtime's current selection —
swaps feature-state.selected on the live map. Optional: adapters that
don't support feature-state selection simply skip this (dispatch()
still tracks selection at the runtime level either way).
Parameters
| Parameter | Type |
|---|---|
selection | GeoVisSelection | null |
Returns
void
setView()
setView(
options):void
Defined in: runtime/adapter.ts:69
Imperatively moves the camera. Animated by default.
Parameters
| Parameter | Type |
|---|---|
options | SetViewOptions |
Returns
void
update()
update(
spec):void
Defined in: runtime/adapter.ts:66
Parameters
| Parameter | Type |
|---|---|
spec | VisualizationSpec |
Returns
void