User interaction handlers
Items related to the ways in which the map responds to user input.
BoxZoomHandler
src/ui/handler/box_zoom.tsThe BoxZoomHandler allows the user to zoom the map to fit within a bounding box.
The bounding box is defined by clicking and holding shift while dragging the cursor.
Instance Members
Related
DoubleClickZoomHandler
src/ui/handler/shim/dblclick_zoom.tsThe DoubleClickZoomHandler allows the user to zoom the map at a point by
double clicking or double tapping.
Instance Members
Related
DragPanHandler
src/ui/handler/shim/drag_pan.tsThe DragPanHandler allows the user to pan the map by clicking and dragging
the cursor.
Instance Members
Related
DragRotateHandler
src/ui/handler/shim/drag_rotate.tsThe DragRotateHandler allows the user to rotate the map by clicking and
dragging the cursor while holding the right mouse button or ctrl key.
Instance Members
Related
FeaturesetDescriptor
src/util/vectortile_to_geojson.tsFeaturesetDescriptor references a featureset in a style. If importId is not specified, the featureset is assumed to be in the root style.
{featuresetId: string, importId: string?}Properties
| Name | Description |
|---|---|
Interaction
src/ui/interactions.tsInteraction is a configuration object used with Map#addInteraction to handle user events, such as clicks and hovers.
Interactions can be applied globally or to specific targets, such as layers or featuresets.
{type: MapInteractionEventType, target: TargetDescriptor?, namespace: string?, filter: FilterSpecification?, handler: function (event: InteractionEvent): (boolean | void)}Properties
| Name | Description |
|---|---|
filterFilterSpecification? | |
handlerfunction (event: InteractionEvent): (boolean | void) | |
typeMapInteractionEventType |
Static Members
InteractionEvent
src/ui/interactions.tsInteractionEvent is an event object that is passed to the interaction handler.
Instance Members
KeyboardHandler
src/ui/handler/keyboard.tsThe KeyboardHandler allows the user to zoom, rotate, and pan the map using
the following keyboard shortcuts:
=/+: Increase the zoom level by 1.Shift-=/Shift-+: Increase the zoom level by 2.-: Decrease the zoom level by 1.Shift--: Decrease the zoom level by 2.- Arrow keys: Pan by 100 pixels.
Shift+⇢: Increase the rotation by 15 degrees.Shift+⇠: Decrease the rotation by 15 degrees.Shift+⇡: Increase the pitch by 10 degrees.Shift+⇣: Decrease the pitch by 10 degrees.
Instance Members
Related
ScrollZoomHandler
src/ui/handler/scroll_zoom.tsThe ScrollZoomHandler allows the user to zoom the map by scrolling.
Instance Members
Related
TargetDescriptor
src/util/vectortile_to_geojson.tsTargetDescriptor defines the target for a Map#queryRenderedFeatures query to inspect,
referencing either a style layer ID or a FeaturesetDescriptor.
It acts as a universal target for Map#addInteraction and Map#queryRenderedFeatures.
({layerId: string} | FeaturesetDescriptor)TargetFeature
src/util/vectortile_to_geojson.tsTargetFeature is a GeoJSON Feature object representing a feature
associated with a specific query target in Map#queryRenderedFeatures. For featuresets in imports, TargetFeature includes a target reference as a TargetDescriptor
and may also include a namespace property to prevent feature ID collisions when layers defined in the query target reference multiple sources.
Unlike features returned for root style featuresets, TargetFeature omits the layer, source, and sourceLayer properties if the feature belongs to import style.
Instance Members
TouchPitchHandler
src/ui/handler/touch_zoom_rotate.tsThe TouchPitchHandler allows the user to pitch the map by dragging up and down with two fingers.
Parameters
| Name | Description |
|---|---|
Related
TouchZoomRotateHandler
src/ui/handler/shim/touch_zoom_rotate.tsThe TouchZoomRotateHandler allows the user to zoom and rotate the map by
pinching on a touchscreen.
They can zoom with one finger by double tapping and dragging. On the second tap, hold the finger down and drag up or down to zoom in or out.