Protected cursorThe CSS cursor to use on the map, for this controller.
If null, the map will fall back to the previous cursor that was set on the map.
Note that changing this cursor will update the cursor on the map's DOM node. When using multiple controllers (e.g. in a CompositeController), the controller that updates the cursor last (to a non-null value), will override any other non-null cursors of active controllers on the map.
A hook to customize inertia for the PanController.
You can change the speed and friction to speed up or slow down the fling animation. You can also impose a maximum speed, to avoid (accidental) fast flings.
The default implementation uses a speedMultiplier of 1, a frictionMultiplier of 1 and a maxSpeed of 5000.
Example usage:
class CustomInertiaPanController extends PanController {
getInertiaOptions(gestureEvent: GestureEvent): PanControllerInertiaOptions {
return {
speedMultiplier: 4, // speed up inertia
frictionMultiplier: 0.5, // reduce the friction, so it lasts longer
maxSpeed: 20000 // allow faster flings
};
}
}
map.controller = new CustomInertiaPanController();
The gesture event to determine inertia options for
Call this method to indicate that the controller's appearance has changed. Calling this method ensures the onDraw will be called during the next rendering pass.
A hook to enable or disable inertia for this PanController. When inertia is enabled, a pan animation is played after the user 'flings' the mouse or his finger. This animation pans the map further in the direction of the fling. You can customize this animation with getInertiaOptions.
The default implementation always returns true.
The gesture event to check
A hook to determine if a gesture event marks the end of a pan interaction.
For mouse events, the default implementation returns true for "drag end" event with a button other than the right mouse button. For touch, the default implementation returns true for all "drag end" events.
The gesture event to check
A hook to determine if a gesture event should be used for panning.
Note that this should return true for all "pan end" events, as well as "non-end" events.
For mouse events, the default implementation returns true for drag events or "drag end" events with a button other than the right mouse button. For touch, the default implementation returns true for all drag events and "drag end" events.
The gesture event to check
Callback that is invoked when this controller is activated on a map. This method allows controller implementations to perform setup work.
the map on which the controller has been activated
Callback that is invoked when this controller is deactivated on a map. This method allows controller implementations to perform cleanup work. This method must return either any resolved value or a promise to indicate completion of deactivation. This allows controller implementation to perform asynchronous deactivation work. During the period between this method being called and the resolution of the deactivation promise, this controller will no longer receive input events, but will still get the opportunity to draw itself.
the map on which the controller has been deactivated
a concrete value to indicate immediate deactivation or a deactivation promise.
Callback that allows controller implementations to perform custom drawing on the map. Controller shapes and icons are drawn on top of all other content in the map. Note that the map may perform caching which may cause this method to only be invoked once. When a controller implementation's appearance changes the implementation should call invalidate on itself.
the GeoCanvas on which the controller can draw shapes.
Callback that allows controller implementations to draw labels on the map. Note that the map may perform caching which may cause this method to only be invoked once. When a controller implementation's appearance changes the implementation should call invalidate on itself.
the LabelCanvas on which the controller can draw labels.
Called when a gesture event has been received. This is not intended to be overridden by subclasses. You should override the hooks instead (isPanEvent, isPanEndEvent, isInertia and getInertiaOptions).
The gesture event to handle
Called when a key event has been received. This method must return a HandleEventResult value to indicate if the event was handled or not, If this method returns EVENT_IGNORED, the map will be given the opportunity to perform default key event behaviour. If default event handling is not desired, this method should return EVENT_HANDLED. (See the Controller class description for the default behavior.)
The key event to be handled. Note that this is a KeyEvent and not a DOMEvent. You can access the corresponding DOMEvent through KeyEvent.domEvent.
The key event handling result.
An event indicating that this Controller has been activated. Activated means that the controller is active on the map, and the controller's onActivate has been called.
You can use this event to set up UI elements or other listeners related to the controller and the controller's map.
Optional context: any2021.0
An event indicating that this Controller has been deactivated. Deactivated means that the controller has been removed from the map, and the controller's onDeactivate has been called.
You can use this event to clean up UI elements or other listeners related to the controller and the controller's map.
Optional context: any2021.0
An event indicating that this Controller is invalidated. Invalidated means that the Controller requests for its onDraw to be called during the next rendering pass (because its appearance has changed). This event fires when invalidate is called.
Optional context: any
Allows the user to pan a map by dragging it. This controller works with both touch and mouse events.
For a list of events handled by this controller, check isPanEvent.
You can customize the controller by overriding its hooks:
See the Managing user input with LuciadRIA controllers tutorial for more information.
Since
2022.1