Optional
options: NavigateControllerConstructorOptionsProtected
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.
The pan controller used by this NavigateController.
Defaults to a PanController.
If null
, panning is disabled.
The rotate controller used by this NavigateController.
Defaults to a RotateController.
If null
, rotation is disabled.
The zoom controller used by this NavigateController.
Defaults to a ZoomController.
If null
, zooming is disabled.
Chains a new controller at the end of this CompositeController's delegates. Note that you cannot append controllers while the CompositeController is active on the map.
The new controller to append to the chain of controllers
Invalidates this controller. Controller.invalidate is called for every controller in the chain.
Called when the controller becomes active on the map. Controller.onActivate is called for every controller in the chain.
the map on which the controller has been activated
Called when the controller is removed from the map. Controller.onDeactivate is called for every controller in the chain. The returned promise resolves to an array containing the results of calling Controller.onDeactivate on the chained controllers.
the map on which the controller is being deactivated
Callback for drawing shapes on the map. Controller.onDraw is called for every controller in the chain.
The geoCanvas to draw on
Callback for drawing labels on the map. Controller.onDrawLabel is called for every controller in the chain.
The labelCanvas to draw on
Called when a gesture event has been received. Controller.onGestureEvent is called for controllers down the chain, until a controller handles the event.
The gesture event that was received.
Called when a key event has been received. Controller.onKeyEvent is called for controllers down the chain, until a controller handles the event.
The key event that was received.
Chains a new controller to the start of this CompositeController's delegates. Note that you cannot prepend controllers while the CompositeController is active on the map.
The new controller to prepend to the chain of controllers
2024.0
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
A controller that implements the default map navigation.
See the Managing user input with LuciadRIA controllers dev article for a description of the default map behavior.
You can override parts of the default navigation by specifying a custom controller as a constructor option. For example, to customize panning:
Since
2024.0