HandlerResult

HandlerResult: object

All handler methods that are called with events can optionally return a HandlerResult.

Type declaration

around?

optional around: Point | null

the point to not move when changing the camera

bearingDelta?

optional bearingDelta: number

cameraAnimation()?

optional cameraAnimation: (map: Map) => any

A method that can fire a one-off easing by directly changing the map’s camera.

Parameters

Returns

any

needsRenderFrame?

optional needsRenderFrame: boolean

Makes the manager trigger a frame, allowing the handler to return multiple results over time (see scrollzoom).

noInertia?

optional noInertia: boolean

The camera changes won’t get recorded for inertial zooming.

originalEvent?

optional originalEvent: Event

The last three properties are needed by only one handler: scrollzoom. The DOM event to be used as the originalEvent on any camera change events.

panDelta?

optional panDelta: Point

pinchAround?

optional pinchAround: Point | null

same as above, except for pinch actions, which are given higher priority

pitchDelta?

optional pitchDelta: number

zoomDelta?

optional zoomDelta: number