Skip to main content

Interface: GeoVisRuntime

Defined in: runtime/createRuntime.ts:23

Properties​

result​

readonly result: GeoVisResult

Defined in: runtime/createRuntime.ts:26

The GeoVisResult of the last update/applyPatch call (or the initial spec's validation).


spec​

readonly spec: VisualizationSpec

Defined in: runtime/createRuntime.ts:24

Methods​

applyPatch()​

applyPatch(patch): GeoVisResult

Defined in: runtime/createRuntime.ts:36

Low-level escape hatch (PRD-002) — prefer dispatch() for anything expressible as one of its actions; it targets stable ids and is logged. Validates the patched spec first; on failure the adapter is never called and spec/result are unchanged.

Parameters​

ParameterType
patchSpecPatch

Returns​

GeoVisResult


destroy()​

destroy(): void

Defined in: runtime/createRuntime.ts:58

Returns​

void


dispatch()​

dispatch(action): GeoVisResult

Defined in: runtime/createRuntime.ts:45

Validates and compiles a closed, typed GeoVisAction (ADR-0003) to an existing SpecPatch/update/setView mechanism, applying it only on success. Every call — accepted or rejected — appends one entry to the action log (getActionLog()).

Parameters​

ParameterType
actionGeoVisAction

Returns​

GeoVisResult


getActionLog()​

getActionLog(): readonly ActionLogEntry[]

Defined in: runtime/createRuntime.ts:47

Every dispatched action and its outcome, in dispatch order (ADR-0003 audit substrate).

Returns​

readonly ActionLogEntry[]


getAdapter()​

getAdapter(): EngineAdapter

Defined in: runtime/createRuntime.ts:59

Returns​

EngineAdapter


getContextPacket()​

getContextPacket(): ContextPacket

Defined in: runtime/createRuntime.ts:49

Versioned, read-only, metadata-only summary of the current map (ADR-0004).

Returns​

ContextPacket


getSelection()​

getSelection(): GeoVisSelection | null

Defined in: runtime/createRuntime.ts:51

The runtime's current selection (set via dispatch({ type: 'select-feature' })), or null.

Returns​

GeoVisSelection | null


mount()​

mount(container, viewId): MountedView

Defined in: runtime/createRuntime.ts:27

Parameters​

ParameterType
containerHTMLElement
viewIdstring

Returns​

MountedView


onViewChange()​

onViewChange(listener): () => void

Defined in: runtime/createRuntime.ts:57

Subscribes to the camera of every view this runtime mounts, after each move. Returns the unsubscribe; a no-op when the adapter reports no camera (see EngineAdapter.onViewChange).

Parameters​

ParameterType
listener(camera) => void

Returns​

() => void


setView()​

setView(options): void

Defined in: runtime/createRuntime.ts:38

Imperatively moves the camera and syncs spec.view. Animated by default.

Parameters​

ParameterType
optionsSetViewOptions

Returns​

void


update()​

update(spec): GeoVisResult

Defined in: runtime/createRuntime.ts:29

Validates spec first; on failure the adapter is never called and spec/result are unchanged.

Parameters​

ParameterType
specVisualizationSpec

Returns​

GeoVisResult