Class NavigateController

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:

  class CustomPanController extends PanController {

    isInertia(gestureEvent: GestureEvent): boolean {
      return gestureEvent.inputType === "touch"; // only enable inertia for touch
    }

  }

  const navigateController = new NavigateController({
    panController: new CustomPanController()
  });
  map.defaultController = new DefaultController({
    navigateController
  });

Since

2024.0

Hierarchy (View Summary)

CompositeController
- NavigateController

Index

Constructors

constructor

new NavigateController(
options?: NavigateControllerConstructorOptions,
): NavigateController
Parameters
- Optionaloptions: NavigateControllerConstructorOptions
Returns NavigateController
Overrides CompositeController.constructor

Accessors

`Protected`cursor

get cursor(): null | string
The 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.

Returns null | string
See
Map.cursorManager

Since
2022.1

Inherited from CompositeController.cursor
set cursor(cssCursor: null | string): void
Parameters
- cssCursor: null | string
Returns void
Inherited from CompositeController.cursor

delegates

get delegates(): Controller[]
Returns Controller[]
Inherited from CompositeController.delegates

map

get map(): null | Map
The map on which this controller is currently active or null if this controller is not currently active. This property is read-only.

Returns null | Map
Inherited from CompositeController.map
set map(_value: null | Map): void
Parameters
- _value: null | Map
Returns void
Inherited from CompositeController.map

panController

get panController(): null | Controller
The pan controller used by this NavigateController. Defaults to a PanController. If null, panning is disabled.

Returns null | Controller

rotateController

get rotateController(): null | Controller
The rotate controller used by this NavigateController. Defaults to a RotateController. If null, rotation is disabled.

Returns null | Controller

zoomController

get zoomController(): null | Controller
The zoom controller used by this NavigateController. Defaults to a ZoomController. If null, zooming is disabled.

Returns null | Controller

Methods

appendController

appendController(controller: Controller): void
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.
Parameters
- controller: Controller
  The new controller to append to the chain of controllers
Returns void
Inherited from CompositeController.appendController

invalidate

invalidate(): void
Invalidates this controller. Controller.invalidate is called for every controller in the chain.

Returns void
Inherited from CompositeController.invalidate

onActivate

onActivate(map: Map): void
Called when the controller becomes active on the map. Controller.onActivate is called for every controller in the chain.
Parameters
- map: Map
  the map on which the controller has been activated
Returns void
Inherited from CompositeController.onActivate

onDeactivate

onDeactivate(map: Map): void | Promise<void>
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.
Parameters
- map: Map
  the map on which the controller is being deactivated
Returns void | Promise<void>
Inherited from CompositeController.onDeactivate

onDraw

onDraw(geoCanvas: GeoCanvas): void
Callback for drawing shapes on the map. Controller.onDraw is called for every controller in the chain.
Parameters
- geoCanvas: GeoCanvas
  The geoCanvas to draw on
Returns void
Inherited from CompositeController.onDraw

onDrawLabel

onDrawLabel(labelCanvas: LabelCanvas): void
Callback for drawing labels on the map. Controller.onDrawLabel is called for every controller in the chain.
Parameters
- labelCanvas: LabelCanvas
  The labelCanvas to draw on
Returns void
Inherited from CompositeController.onDrawLabel

onGestureEvent

onGestureEvent(gestureEvent: GestureEvent): HandleEventResult
Called when a gesture event has been received. Controller.onGestureEvent is called for controllers down the chain, until a controller handles the event.
Parameters
- gestureEvent: GestureEvent
  The gesture event that was received.
Returns HandleEventResult
Inherited from CompositeController.onGestureEvent

onKeyEvent

onKeyEvent(keyEvent: KeyEvent): HandleEventResult
Called when a key event has been received. Controller.onKeyEvent is called for controllers down the chain, until a controller handles the event.
Parameters
- keyEvent: KeyEvent
  The key event that was received.
Returns HandleEventResult
Inherited from CompositeController.onKeyEvent

prependController

prependController(controller: Controller): void
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.
Parameters
- controller: Controller
  The new controller to prepend to the chain of controllers
Returns void
Since
2024.0

Inherited from CompositeController.prependController

Events

on

on(event: "Activated", callback: (map: Map) => void, context?: any): Handle
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.
Parameters
- event: "Activated"
- callback: (map: Map) => void
- Optionalcontext: any
Returns Handle
Since
2021.0

Inherited from CompositeController.on
on(event: "Deactivated", callback: (map: Map) => void, context?: any): Handle
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.
Parameters
- event: "Deactivated"
- callback: (map: Map) => void
- Optionalcontext: any
Returns Handle
Since
2021.0

Inherited from CompositeController.on
on(event: "Invalidated", callback: () => void, context?: any): Handle
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.
Parameters
- event: "Invalidated"
- callback: () => void
- Optionalcontext: any
Returns Handle
Inherited from CompositeController.on

Class NavigateController

Since

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Events

Constructors

constructor

Parameters

Returns NavigateController

Accessors

Protectedcursor

Returns null | string

See

Since

Parameters

Returns void

delegates

Returns Controller[]

map

Returns null | Map

Parameters

Returns void

panController

Returns null | Controller

rotateController

Returns null | Controller

zoomController

Returns null | Controller

Methods

appendController

Parameters

Returns void

invalidate

Returns void

onActivate

Parameters

Returns void

onDeactivate

Parameters

Returns void | Promise<void>

onDraw

Parameters

Returns void

onDrawLabel

Parameters

Returns void

onGestureEvent

Parameters

Returns HandleEventResult

onKeyEvent

Parameters

Returns HandleEventResult

prependController

Parameters

Returns void

Since

Events

on

Parameters

Returns Handle

Since

Parameters

Returns Handle

Since

Parameters

Returns Handle

Settings

On This Page

`Protected`cursor