Module: ol/interaction/Select

Classes

SelectEvent

Select

Type Definitions

FilterFunction()

interaction/Select.js, line 28

A function that takes an module:ol/Feature~Feature or module:ol/render/Feature~RenderFeature and an module:ol/layer/Layer~Layer and returns true if the feature may be selected or false otherwise.

Options{Object}

Properties:

Name	Type	Argument	Default	Description
addCondition	module:ol/events/condition~Condition	<optional>		A function that takes an module:ol/MapBrowserEvent~MapBrowserEvent and returns a boolean to indicate whether that event should be handled. By default, this is module:ol/events/condition.never. Use this if you want to use different events for add and remove instead of toggle.
condition	module:ol/events/condition~Condition	<optional>		A function that takes an module:ol/MapBrowserEvent~MapBrowserEvent and returns a boolean to indicate whether that event should be handled. This is the event for the selected features as a whole. By default, this is module:ol/events/condition.singleClick. Clicking on a feature selects that feature and removes any that were in the selection. Clicking outside any feature removes all from the selection. See toggle, add, remove options for adding/removing extra features to/ from the selection.
layers	Array.<module:ol/layer/Layer~Layer> | function	<optional>		A list of layers from which features should be selected. Alternatively, a filter function can be provided. The function will be called for each layer in the map and should return true for layers that you want to be selectable. If the option is absent, all visible layers will be considered selectable.
style	module:ol/style/Style~StyleLike | null	<optional>		Style for the selected features. By default the default edit style is used (see module:ol/style/Style~Style). Set to null if this interaction should not apply any style changes for selected features. If set to a falsey value, the selected feature's style will not change.
removeCondition	module:ol/events/condition~Condition	<optional>		A function that takes an module:ol/MapBrowserEvent~MapBrowserEvent and returns a boolean to indicate whether that event should be handled. By default, this is module:ol/events/condition.never. Use this if you want to use different events for add and remove instead of toggle.
toggleCondition	module:ol/events/condition~Condition	<optional>		A function that takes an module:ol/MapBrowserEvent~MapBrowserEvent and returns a boolean to indicate whether that event should be handled. This is in addition to the condition event. By default, module:ol/events/condition.shiftKeyOnly, i.e. pressing shift as well as the condition event, adds that feature to the current selection if it is not currently selected, and removes it if it is. See add and remove if you want to use different events instead of a toggle.
multi	boolean	<optional>	false	A boolean that determines if the default behaviour should select only single features or all (overlapping) features at the clicked map position. The default of false means single select.
features	module:ol/Collection~Collection.<module:ol/Feature~Feature>	<optional>		Collection where the interaction will place selected features. Optional. If not set the interaction will create a collection. In any case the collection used by the interaction is returned by module:ol/interaction/Select~Select#getFeatures.
filter	module:ol/interaction/Select~FilterFunction	<optional>		A function that takes an module:ol/Feature~Feature and an module:ol/layer/Layer~Layer and returns true if the feature may be selected or false otherwise.
hitTolerance	number	<optional>	0	Hit-detection tolerance. Pixels inside the radius around the given position will be checked for features.