HandlerResult

HandlerResult = object

Defined in: src/ui/handler_manager.ts:81

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

Properties

around?

optional around: Point | null

Defined in: src/ui/handler_manager.ts:90

the point to not move when changing the camera

---

cameraAnimation()?

optional cameraAnimation: (map: Map) => any

Defined in: src/ui/handler_manager.ts:98

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

Parameters

Parameter	Type
map	Map

Returns

any

---

needsRenderFrame?

optional needsRenderFrame: boolean

Defined in: src/ui/handler_manager.ts:107

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

---

noInertia?

optional noInertia: boolean

Defined in: src/ui/handler_manager.ts:111

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

---

originalEvent?

optional originalEvent: Event

Defined in: src/ui/handler_manager.ts:103

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.

---

pinchAround?

optional pinchAround: Point | null

Defined in: src/ui/handler_manager.ts:94

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