Class HoverController

A controller that allows the user to hover objects on the map.

Note that FeatureLayer.hoverable needs to be enabled as well, for hovering to work.

This controller only handles mouse events.

Note that this controller consumes GestureEventType.MOVE events. Controllers down the chain (see MOVE events, for example to update an icon under mouse. Because of this, it's recommended to put this controller after other controllers.

For a list of events handled by this controller, see isPickEvent.

const defaultController = new CompositeController();
defaultController.appendController(new SelectController());
defaultController.appendController(new ContextMenuController());
defaultController.appendController(new PanController());
defaultController.appendController(new RotateController());
defaultController.appendController(new ZoomController());
defaultController.appendController(new HoverController());

You can customize this controller's behavior by overriding its hooks:

class CustomHoverController extends HoverController {

  getPaintRepresentations(event: GestureEvent): PaintRepresentation[] {
    return [PaintRepresentation.BODY]; // disallow hovering over label. Consider keeping this consistent with a custom SelectController as well.
  }

  getSensitivity(event: GestureEvent): number {
    return 30; // use a bigger sensitivity (interaction radius)
  }

}

map.controller = new CustomHoverController();

When customizing a HoverController, consider doing the same customizations to SelectController. This ensures that hovering and selection are consistent. Objects that are hovered, are also selection candidates.

See the Managing user input with LuciadRIA controllers tutorial for more information.

Since

2022.1

Hierarchy

Constructors

constructor

Accessors

cursor map

Methods

getCandidates getPaintRepresentations getPickPoint getSensitivity handleCandidates invalidate isPickEvent onActivate onDeactivate onDraw onDrawLabel onGestureEvent onKeyEvent

Events

Activated Deactivated Invalidated

Constructors

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

  • set cursor(cssCursor): void

  • Parameters

    • cssCursor: null | string

    Returns void

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

  • set map(_value): void

  • Parameters

    • _value: null | Map

    Returns void

Methods

getCandidates

getPaintRepresentations

getPickPoint

getSensitivity

  • A hook to customize the sensitivity of a pick event. The sensitivity is the number of pixels 'padded' around the event's location used to retrieve candidates.

    The default behavior returns a small sensitivity for mouse events, and a larger sensitivity for touch events. The type of event is determined by GestureEvent.inputType.

    Parameters

    Returns number

handleCandidates

invalidate

  • 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.

    Returns void

isPickEvent

onActivate

  • Callback that is invoked when this controller is activated on a map. This method allows controller implementations to perform setup work.

    Parameters

    • map: Map

      the map on which the controller has been activated

    Returns void

onDeactivate

  • 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.

    Parameters

    • map: Map

      the map on which the controller has been deactivated

    Returns any

    a concrete value to indicate immediate deactivation or a deactivation promise.

onDraw

  • 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.

    Parameters

    • geoCanvas: GeoCanvas

      the GeoCanvas on which the controller can draw shapes.

    Returns void

onDrawLabel

  • 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.

    Parameters

    • labelCanvas: LabelCanvas

      the LabelCanvas on which the controller can draw labels.

    Returns void

onGestureEvent

onKeyEvent

  • 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.)

    Parameters

    • keyEvent: KeyEvent

      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.

    Returns HandleEventResult

    The key event handling result.

Events

"Activated" event

  • on("Activated", callback: ((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) => void)
        • (map): void

        • Parameters

          Returns void

    • Optional context: any

    Returns Handle

    Since

    2021.0

"Deactivated" event

  • on("Deactivated", callback: ((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) => void)
        • (map): void

        • Parameters

          Returns void

    • Optional context: any

    Returns Handle

    Since

    2021.0

"Invalidated" event

  • on("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)
        • (): void

        • Returns void

    • Optional context: any

    Returns Handle

Settings

Member Visibility

Theme