Class CameraController

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

Hierarchy

PubSub<CAMERA_EVENT_PAYLOAD, E_CAMERA_EVENT>
- CameraController

Index

Properties

Accessors

Methods

Properties

core

core: ICore

Optional currentAnimation

currentAnimation?: Promise<undefined>

interactions

interactions: { disable: (() => void); enable: (() => void) } = ...

Type declaration

disable: (() => void)
- - (): void
  - Returns void
enable: (() => void)
- - (): void
  - Returns void

Accessors

maxTilt

get maxTilt(): number
set maxTilt(radians: number): void

Returns number
Parameters
- radians: number
Returns void

maxZoom

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

Returns number
Parameters
- meters: number
Returns void

minZoom

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

Returns number
Parameters
- meters: number
Returns void

position

get position(): MappedinCoordinate

Returns MappedinCoordinate

rotation

get rotation(): number

Returns number

tilt

get tilt(): number

Returns number

zoom

get zoom(): number

Returns number

Methods

animate

animate(config: TCameraTransform, options?: TAnimationOptions): Promise<undefined>

Animate the Camera's view to smoothly transition to a new state over time.

Parameters
- config: TCameraTransform
- Optional options: TAnimationOptions
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(targets: TCameraTargets, options?: TFocusOnCameraOptions & TAnimationOptions): Promise<any>

Focus the Camera view on a collection of targets and animate to that state.

Parameters
- targets: TCameraTargets
- Optional options: TFocusOnCameraOptions & TAnimationOptions
Returns Promise<any>
a Promise that resolves when the animation finishes, or rejects when it is cancelled.

getSafeAreaInsets

getSafeAreaInsets(): TPadding

Returns TPadding

off

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

Inherited from PubSub.off
Type Parameters
- EVENT_NAME extends E_CAMERA_EVENT
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 extends 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: TCameraTransform): void

Set the Camera's view to a new state.

Parameters
- positionOptions: TCameraTransform
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

translate

translate(direction: E_CAMERA_DIRECTION, distance: number, options?: TAnimationOptions): Promise<unknown>

Moves the Camera view in a relative direction by a given distance in meters.

Parameters
- direction: E_CAMERA_DIRECTION
- distance: number
- Optional options: TAnimationOptions
Returns Promise<unknown>
a Promise that resolves when the translation animation finishes, or rejects when it is cancelled.