Class Camera

The Camera object specifies a view of the map and allows manipulation of that view.

Hierarchy

PubSub<CAMERA_EVENT_PAYLOAD, E_CAMERA_EVENT>
- Camera

Index

Accessors

Methods

Accessors

currentAnimation

get currentAnimation(): undefined | Promise<undefined>

The current camera animation, if any. Resolves when the animation finishes.

Returns undefined | Promise<undefined>

maxZoom

get maxZoom(): number
set maxZoom(meters: number): void

Maximum distance (in meters) the camera is allowed to get to the ground.

Returns number
Maximum distance (in meters) the camera is allowed to get to the ground.

Parameters
- meters: number
Returns void

minZoom

get minZoom(): number
set minZoom(meters: number): void

Minimum distance (in meters) the camera is allowed to get to the ground.

Returns number
Minimum distance (in meters) the camera is allowed to get to the ground.

Parameters
- meters: number
Returns void

rotation

get rotation(): number

Current Camera rotation (in radians)

Returns number

tilt

get tilt(): number

Current Camera tilt

Returns number

zoom

get zoom(): number

Current Camera zoom (in meters)

Returns number

Methods

animate

animate(options: { animationOptions?: TCameraAnimationOptions; positionOptions?: TAnimatePositionOptions }): Promise<undefined>

Animate the Camera's view to smoothly transition to a new state over time. Returns a promise that resolves when the animation completes and gets rejected if the animation is cancelled.

Parameters
- options: { animationOptions?: TCameraAnimationOptions; positionOptions?: TAnimatePositionOptions }
  - Optional animationOptions?: TCameraAnimationOptions
  - Optional positionOptions?: TAnimatePositionOptions
Returns Promise<undefined>

a Promise that resolves when the animation finishes, or rejects when it is cancelled.

cancelAnimation

cancelAnimation(): void

Cancel the currently active Camera animation.

Returns void

focusOn

focusOn(options: TFocusOnOptions): Promise<any>

Determine a new Camera view state based on a collection of targets, and start animating to that state.

Parameters
- options: TFocusOnOptions
Returns Promise<any>

a Promise that resolves when the animation finishes, or rejects when it is cancelled.

getSafeAreaInsets

getSafeAreaInsets(): any

Returns any

off

off<EVENT_NAME>(eventName: EVENT_NAME, fn: (payload: CAMERA_EVENT_PAYLOAD[EVENT_NAME]) => void): void

Inherited from PubSub.off

Type parameters
- EVENT_NAME: keyof CAMERA_EVENT_PAYLOAD
Parameters
- eventName: EVENT_NAME
- fn: (payload: CAMERA_EVENT_PAYLOAD[EVENT_NAME]) => void
  - - (payload: CAMERA_EVENT_PAYLOAD[EVENT_NAME]): void
    - Parameters
      - payload: CAMERA_EVENT_PAYLOAD[EVENT_NAME]
      Returns void
Returns void

on

on<EVENT_NAME>(eventName: EVENT_NAME, fn: (payload: CAMERA_EVENT_PAYLOAD[EVENT_NAME] extends { data: null } ? any[any]["data"] : CAMERA_EVENT_PAYLOAD[EVENT_NAME]) => void): void

Inherited from PubSub.on

Type parameters
- EVENT_NAME: E_CAMERA_EVENT
Parameters
- eventName: EVENT_NAME
- fn: (payload: CAMERA_EVENT_PAYLOAD[EVENT_NAME] extends { data: null } ? any[any]["data"] : CAMERA_EVENT_PAYLOAD[EVENT_NAME]) => void
  - - (payload: CAMERA_EVENT_PAYLOAD[EVENT_NAME] extends { data: null } ? any[any]["data"] : CAMERA_EVENT_PAYLOAD[EVENT_NAME]): void
    - Parameters
      - payload: CAMERA_EVENT_PAYLOAD[EVENT_NAME] extends { data: null } ? any[any]["data"] : CAMERA_EVENT_PAYLOAD[EVENT_NAME]
      Returns void
Returns void

set

set(positionOptions?: TAnimatePositionOptions): void

Set the Camera's view to a new state.

Parameters
- Optional positionOptions: TAnimatePositionOptions
Returns void

setSafeAreaInsets

setSafeAreaInsets(insets: { bottom: number; left: number; right: number; top: number }): void

Parameters
- insets: { bottom: number; left: number; right: number; top: number }
  - bottom: number
  - left: number
  - right: number
  - top: number
Returns void