Class Camera

Index

Accessors

bearing center maxPitch maxZoomLevel minPitch minZoomLevel pitch zoomLevel

Methods

animateTo focusOn set setMaxPitch setMaxZoomLevel setMinPitch setMinZoomLevel setScreenOffsets

Accessors

bearing

get bearing(): number
The current bearing of the camera in degrees.

Returns number

center

get center(): Coordinate
The current center coordinate (Coordinate) of the camera.

Returns Coordinate

maxPitch

get maxPitch(): number
The maximum pitch of the camera in degrees.

Returns number

maxZoomLevel

get maxZoomLevel(): number
The maximum zoom level of the camera in mercator zoom levels.

Returns number
See
https://wiki.openstreetmap.org/wiki/Zoom_levels

minPitch

get minPitch(): number
The minimum pitch of the camera in degrees.

Returns number

minZoomLevel

get minZoomLevel(): number
The minimum zoom level of the camera in mercator zoom levels.

Returns number
See
https://wiki.openstreetmap.org/wiki/Zoom_levels

pitch

get pitch(): number
The current pitch of the camera in degrees.

Returns number

zoomLevel

get zoomLevel(): number
The current zoom level of the camera in mercator zoom levels.

Returns number
See
https://wiki.openstreetmap.org/wiki/Zoom_levels

Methods

animateTo

animateTo(target, options?): Promise<void>
Animates the camera to a specified target.
Parameters
- target: TCameraTarget
  The target configuration for the camera.
- Optionaloptions: TCameraAnimationOptions
  Optional settings for the camera animation.
Returns Promise<void>
Example
```
map.Camera.animateTo({ center: coordinate, zoomLevel: 10 }, { duration: 500 });
```

focusOn

focusOn(target, options?): Promise<void>
Focuses the camera on a specific target or array of targets.
Parameters
- target: TCameraFocusOnTarget
  The target(s) to focus on, either a single element or an array of elements.
- Optionaloptions: TFocusOnOptions
  Optional settings for focusing the camera.
Returns Promise<void>
Example
```
// Focus on a single space
map.Camera.focusOn(space, { minZoomLevel: 5, duration: 1000 });
```

set

set(target): void
Sets the camera to a specified target without animation.
Parameters
- target: TCameraTarget
  The target configuration for the camera.
Returns void
Example
```
map.Camera.set({ center: coordinate, zoomLevel: 10 });
```

setMaxPitch

setMaxPitch(maxPitch): void
Update the maximum pitch of the camera in degrees.
Parameters
- maxPitch: number
  The new maximum pitch.
Returns void

setMaxZoomLevel

setMaxZoomLevel(zoomLevel): void
Update the maximum zoom level of the camera in mercator zoom levels.
Parameters
- zoomLevel: number
  The new maximum zoom level.
Returns void
See
https://wiki.openstreetmap.org/wiki/Zoom_levels

Default
```
12
```

setMinPitch

setMinPitch(minPitch): void
Update the minimum pitch of the camera in degrees.
Parameters
- minPitch: number
  The new minimum pitch.
Returns void

setMinZoomLevel

setMinZoomLevel(zoomLevel): void
Update the minimum zoom level of the camera in mercator zoom levels.
Parameters
- zoomLevel: number
  The new minimum zoom level.
Returns void
See
https://wiki.openstreetmap.org/wiki/Zoom_levels

Default
```
22
```

setScreenOffsets

setScreenOffsets(padding): void
Parameters
- padding: InsetPadding
Returns void