HandlerResult
HandlerResult =
object
Defined in: ui/handler_manager.ts:111
All handler methods that are called with events can optionally return a HandlerResult.
Properties
around?
optionalaround?:Point|null
Defined in: ui/handler_manager.ts:120
the point to not move when changing the camera
easeTo?
optionaleaseTo?:EaseToOptions
Defined in: ui/handler_manager.ts:130
A one-off easing of the camera, such as a double click's zoom, that ends the gesture: every handler is reset
before it starts, so that the next frame of a handler does not stop it, and its events carry the input event that
asked for it as originalEvent.
needsRenderFrame?
optionalneedsRenderFrame?:boolean
Defined in: ui/handler_manager.ts:145
Makes the manager trigger a frame, allowing the handler to return multiple results over time (see scrollzoom).
noInertia?
optionalnoInertia?:boolean
Defined in: ui/handler_manager.ts:149
The camera changes won't get recorded for inertial zooming.
originalEvent?
optionaloriginalEvent?:Event
Defined in: ui/handler_manager.ts:141
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?
optionalpinchAround?:Point|null
Defined in: ui/handler_manager.ts:124
same as above, except for pinch actions, which are given higher priority
timeout?
optionaltimeout?:object
Defined in: ui/handler_manager.ts:136
Asks the manager to call the handler's onTimeout with token after delay milliseconds, for a handler that
waits for input that may not come, such as a wheel zoom telling a mouse wheel from a trackpad. The handler
ignores a timeout whose token it no longer waits for, so it never needs to cancel one.
delay
delay:
number
token
token:
unknown