Handler

Defined in: ui/handler_manager.ts:59

Handlers interpret dom events and return camera changes that should be applied to the map (HandlerResults). The camera changes are all deltas. The handler itself should have no knowledge of the map's current state. This makes it easier to merge multiple results and keeps handlers simpler. For example, if there is a mousedown and mousemove, the mousePan handler would return a panDelta on the mousemove.

Methods

isActive()

isActive(): boolean

Defined in: ui/handler_manager.ts:68

This is used to indicate if the handler is currently active or not. In case a handler is active, it will block other handlers from getting the relevant events. There is an allow list of handlers that can be active at the same time, which is configured when adding a handler.

Returns

boolean

isZooming()?

optional isZooming(): boolean

Defined in: ui/handler_manager.ts:99

Whether the handler is zooming the map apart from the zoom deltas it returns, such as a wheel zoom between a wheel event and its first frame.

Returns

boolean

onTimeout()?

optional onTimeout(token: unknown): void | HandlerResult

Defined in: ui/handler_manager.ts:105

Called by the manager when a timeout the handler asked for runs out, see HandlerResult.timeout. The manager runs a render frame when the result asks for one. The token is opaque to the manager, so a handler declares the parameter as the type of the tokens it hands out.