InterfaceMoveCameraOptions

The properties that can be used to adjust the camera.

interface MoveCameraOptions {
    animated?: boolean;
    heading?: number;
    insets?: number;
    mapSpan?: number;
    position?: Coordinates | MapPoint;
    span?: number;
}

Properties

animated?: boolean

Whether the changes to the camera are animated.

false

heading?: number

The new heading of the camera, in degrees relative to true north.

insets?: number

Additional insets around the edges of the map view in CSS pixels after accounting for the span.

If specified, this property will apply an additional factor to the camera's zoom, such that there is an additional margin around the specified span.

If neither a span or mapSpan is specified, the camera's current span is used, and the camera will zoom out slightly to account for the specified insets.

mapSpan?: number

The new span of the camera in map units.

The span adjusts the camera's zoom level such that a circle on the ground with this diameter would fit neatly on the screen. In other words, this is the distance in map units between the edges of the screen in the smaller axis.

This should not be specified at the same time as the span property.

position?: Coordinates | MapPoint

The new position of the camera.

span?: number

The new span of the camera in metres.

The span adjusts the camera's zoom level such that a circle on the ground with this diameter would fit neatly on the screen. In other words, this is the physical distance between the edges of the screen in the smaller axis.

This should not be specified at the same time as the mapSpan property.