Class: Select

ol/interaction/Select~Select 


import Select from 'ol/interaction/Select';

Interaction for selecting vector features. By default, selected features are styled differently, so this interaction can be used for visual highlighting, as well as selecting features for other actions, such as modification or output. There are three ways of controlling which features are selected: using the browser event as defined by the condition and optionally the toggle, add/remove, and multi options; a layers filter; and a further feature filter using the filter option.

Selected features are added to an internal unmanaged layer.

new Select(opt_options)

interaction/Select.js, line 156
Name Type Description
options

Options.

Name Type Default Description
addCondition module:ol/events/condition~Condition

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

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

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

Style for the selected features. By default the default edit style is used (see module:ol/style).
removeCondition module:ol/events/condition~Condition

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

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

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

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

Wrap the world horizontally on the selection overlay.
hitTolerance number 0

Hit-detection tolerance. Pixels inside the radius around the given position will be checked for features. This only works for the canvas renderer and not for WebGL.
Fires:

Extends

Observable Properties

Name Type Settable ol/Object.ObjectEvent type Description
active boolean yes change:active

true if the interaction is active, false otherwise.

Methods

changed() inherited

Observable.js, line 36

Increases the revision counter and dispatches a 'change' event.

dispatchEvent(event){boolean|undefined} inherited

events/Target.js, line 82

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name Type Description
event Object | module:ol/events/Event~Event | string

Event object.
Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited

Object.js, line 119

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getActive(){boolean} inherited

interaction/Interaction.js, line 60

Return whether the interaction is currently active.

Returns:
true if the interaction is active, false otherwise.

getFeatures(){module:ol/Collection~Collection.<module:ol/Feature~Feature>}

interaction/Select.js, line 278

Get the selected features.

Returns:
Features collection.

getHitTolerance(){number}

interaction/Select.js, line 287

Returns the Hit-detection tolerance.

Returns:
Hit tolerance in pixels.

getKeys(){Array.<string>} inherited

Object.js, line 132

Get a list of object property names.

Returns:
List of property names.

getLayer(feature){module:ol/layer/Vector~VectorLayer}

interaction/Select.js, line 300

Returns the associated vectorlayer of the (last) selected feature. Note that this will not work with any programmatic method like pushing features to collection.

Name Type Description
feature module:ol/Feature~FeatureLike

Feature
Returns:
Layer.

getMap(){module:ol/PluggableMap~PluggableMap} inherited

interaction/Interaction.js, line 69

Get the map associated with this interaction.

Returns:
Map.

getOverlay(){module:ol/layer/Vector~VectorLayer}

interaction/Select.js, line 311

Get the overlay layer that this interaction renders selected features to.

Returns:
Overlay layer.

getProperties(){Object.<string, *>} inherited

Object.js, line 141

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 47

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

handleEvent(mapBrowserEvent){boolean} inherited

interaction/Interaction.js, line 79

Handles the map browser event.

Name Type Description
mapBrowserEvent module:ol/MapBrowserEvent~MapBrowserEvent

Map browser event.
Returns:
false to stop event propagation.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 60

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 82

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

set(key, value, opt_silent) inherited

Object.js, line 164

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean

Update without triggering an event.

setActive(active) inherited

interaction/Interaction.js, line 89

Activate or deactivate the interaction.

Name Type Description
active boolean

Active.

setHitTolerance(hitTolerance)

interaction/Select.js, line 322

Hit-detection tolerance. Pixels inside the radius around the given position will be checked for features. This only works for the canvas renderer and not for WebGL.

Name Type Description
hitTolerance number

Hit tolerance in pixels.

setProperties(values, opt_silent) inherited

Object.js, line 183

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name Type Description
values Object.<string, *>

Values.
silent boolean

Update without triggering an event.

un(type, listener) inherited

Observable.js, line 101

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.

unset(key, opt_silent) inherited

Object.js, line 195

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.