Skip to main content

Interface: SetViewOptions

Defined in: runtime/adapter.ts:22

Options accepted by EngineAdapter.setView and GeoVisRuntime.setView. All camera fields are optional — only provided values are applied. When animate is true (default) the adapter uses a smooth flyTo transition; when false it uses an instant jumpTo.

The flight itself is shaped by ViewAnimation's fields, which a ViewPreset declares and set-view-preset carries through. Left out, the engine picks its own flight — and turns it into a jump for a viewer who asked for reduced motion, unless essential says the flight is the point.

Extends​

Properties​

animate?​

optional animate?: boolean

Defined in: spec/types.ts:740

Whether the camera flies rather than lands. Defaults to true; false is an instant cut, which is what a move the user is not meant to follow wants.

Inherited from​

ViewAnimation.animate

bearing?​

optional bearing?: number

Defined in: runtime/adapter.ts:26

bounds?​

optional bounds?: GeoJSONBoundingBox

Defined in: runtime/adapter.ts:34

Frame this box instead of going to a center/zoom, which is what an extent — a territory, a district, a catchment — asks for: how close the camera ends up is the size of the thing, not a number chosen in advance.

Given, it wins over center/zoom, and those are left out of the move.

center?​

optional center?: LngLat

Defined in: runtime/adapter.ts:23

curve?​

optional curve?: number

Defined in: spec/types.ts:750

How far the camera pulls back on the way. Higher arcs higher, which is what shows the route rather than just the ends of it. MapLibre defaults to 1.42.

Inherited from​

ViewAnimation.curve

duration?​

optional duration?: number

Defined in: spec/types.ts:745

Milliseconds the flight takes. Omitted, the engine derives one from the distance, which makes a short hop and a continental flight read alike.

Inherited from​

ViewAnimation.duration

essential?​

optional essential?: boolean

Defined in: spec/types.ts:761

Fly even for a viewer who asked their system to reduce motion. Off by default, so that request is honoured and the camera cuts instead.

Turn it on only where the flight carries the meaning — where the point is where the map went, not that it went somewhere — since it overrides an accessibility preference the viewer set deliberately.

Inherited from​

ViewAnimation.essential

maxZoom?​

optional maxZoom?: number

Defined in: runtime/adapter.ts:42

How close bounds may bring the camera. Without it a small enough extent fills the screen with a single shape and no surroundings to place it against.

padding?​

optional padding?: number

Defined in: runtime/adapter.ts:36

Pixels of breathing room around bounds.

pitch?​

optional pitch?: number

Defined in: runtime/adapter.ts:25

speed?​

optional speed?: number

Defined in: spec/types.ts:752

Ground speed of the flight, ignored when duration is given.

Inherited from​

ViewAnimation.speed

zoom?​

optional zoom?: number

Defined in: runtime/adapter.ts:24