Class DefaultController

A controller that implements the default map behavior.

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 behavior by specifying a custom controller as a constructor option. For example, to customize selection:

class CustomSelectController extends SelectController {

  getPaintRepresentations(event: GestureEvent): PaintRepresentation[] {
    return [PaintRepresentation.BODY]; // disallow selection by label
  }

  isShowBalloon(gestureEvent: GestureEvent, selectionCandidate: PickInfo): boolean {
    return false; // don't show balloons, ever
  }

}

map.defaultController = new DefaultController({
  selectController: new CustomSelectController()
});

See

Since

2024.0

Hierarchy (View Summary)

CompositeController
- DefaultController

Index

Constructors

constructor

new DefaultController(
options?: DefaultControllerConstructorOptions,
): DefaultController
Parameters
- Optionaloptions: DefaultControllerConstructorOptions
Returns DefaultController
Overrides CompositeController.constructor

Accessors

contextMenuController

get contextMenuController(): Controller | null
The context menu controller of this DefaultController. If null, opening context menu's is disabled. Defaults to a ContextMenuController.

Returns Controller | null

`Protected`cursor

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

Since
2022.1

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

delegates

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

hoverController

get hoverController(): Controller | null
The hover controller of this DefaultController. If null, hovering is disabled. Defaults to a HoverController.

Returns Controller | null

map

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

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

navigateController

get navigateController(): Controller | null
The navigate controller of this DefaultController. If null, navigation is disabled. Defaults to a NavigateController.

Returns Controller | null

selectController

get selectController(): Controller | null
The select controller of this DefaultController. If null, selection is disabled. Defaults to a SelectController.

Returns Controller | null

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: RIAMap): void
Called when the controller becomes active on the map. Controller.onActivate is called for every controller in the chain.
Parameters
- map: RIAMap
  the map on which the controller has been activated
Returns void
Inherited from CompositeController.onActivate

onDeactivate

onDeactivate(map: RIAMap): 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: RIAMap
  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: RIAMap) => 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: RIAMap) => void
- Optionalcontext: any
Returns Handle
Since
2021.0

Inherited from CompositeController.on
on(event: "Deactivated", callback: (map: RIAMap) => 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: RIAMap) => 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 DefaultController

See

Since

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Events

Constructors

constructor

Parameters

Returns DefaultController

Accessors

contextMenuController

Returns Controller | null

Protectedcursor

Returns string | null

See

Since

Parameters

Returns void

delegates

Returns Controller[]

hoverController

Returns Controller | null

map

Returns RIAMap | null

Parameters

Returns void

navigateController

Returns Controller | null

selectController

Returns Controller | null

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