GeomapSelectionControl

<ui5-geomap-selection-control>

info

The following entity is available under an experimental flag and its API and behavior are subject to change.

The ui5-geomap-selection-control defines the Selection webcomponent.

ES6 Module Import

import "@ui5/webcomponents-geomap/dist/GeomapSelectionControl.js";

Basic Sample

Properties

selectionType

Description	Type of the selection used. Can be rectangle, freehand, polygon, circle or select.
Type	string
Default	"rectangle"

modes

Description	The selection mode buttons that should be available to the end user. When empty, all selection modes are rendered. Supported values: freehand, polygon, rectangle, circle, select. The buttons render in the order given in the array. If the active selectionType is no longer rendered (because it was removed from modes), it is reassigned to the first button currently visible in the toolbar — this means the active type can stay unchanged even when modes is an empty array or contains only unknown values, since the visible toolbar then falls back to the full default list. Unknown values are dropped with a console.warn; if every supplied value is unknown, the full default list is used as a fallback. The delete button is always rendered alongside the configured mode buttons and is not affected by this property. Can be changed at runtime.
Type	Array<GeomapSelectionMode>
Default	[]

position

Description	Position of the control on the map. Can be one of the following: "TopLeft", "TopRight", "BottomLeft", "BottomRight".
Type	GeomapMapControlPosition
Default	"TopLeft"

Slots

No slots available for this component.

Events

selection-finish

Description	Fired when selection is finished.
Type	CustomEvent<SelectionFinishEventDetail>
Parameters	id: FeatureId The id of the selected feature context: OnFinishContext The context of the selected feature snapshot: Array<GeoJSONStoreFeatures> The snapshot of the selected feature
Bubbles	Yes
Cancelable	No

selection-item

Description	Fired when item is selected.
Type	CustomEvent<SelectionItemEventDetail>
Parameters	id: FeatureId The id of the selected feature snapshot: Array<GeoJSONStoreFeatures> The snapshot of the selected feature selObj: GeoJSONStoreFeatures The selected object
Bubbles	Yes
Cancelable	No

Methods

setModeStyles

Description	Changes styling of the selection control with given set of styles
Return type	void
Parameters	oStyles: SelectionStylesConfigType

setValidator

Description	API for setting custom validator used during selection.
Return type	void
Parameters	fn: Validation

CSS Parts

No CSS parts available for this component.