OpenLayers v4.0.1 API - Class: Select

# Class: Select

This documentation is for OpenLayers v4.0.1. The latest is v.

## 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 ol.interaction.Select(opt_options)

src/ol/interaction/select.js, line 36

  Name | Type | Description
  --- | --- | ---

  `options`

  Options.

  Name | Type | Description
  --- | --- | ---
  `addCondition` | ol.EventsConditionType | undefined | A function that takes an `ol.MapBrowserEvent` and returns a boolean to indicate whether that event should be handled. By default, this is `ol.events.condition.never`. Use this if you want to use different events for add and remove instead of `toggle`.
  `condition` | ol.EventsConditionType | undefined | A function that takes an `ol.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 `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` | undefined | Array.<ol.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` | ol.style.Style | Array.<ol.style.Style> | ol.StyleFunction | undefined | Style for the selected features. By default the default edit style is used (see `ol.style`).
  `removeCondition` | ol.EventsConditionType | undefined | A function that takes an `ol.MapBrowserEvent` and returns a boolean to indicate whether that event should be handled. By default, this is `ol.events.condition.never`. Use this if you want to use different events for add and remove instead of `toggle`.
  `toggleCondition` | ol.EventsConditionType | undefined | A function that takes an `ol.MapBrowserEvent` and returns a boolean to indicate whether that event should be handled. This is in addition to the `condition` event. By default, `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 | undefined | A boolean that determines if the default behaviour should select only single features or all (overlapping) features at the clicked map position. Default is false i.e single select
  `features` | ol.Collection.<ol.Feature> | undefined | 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 `ol.interaction.Select#getFeatures`.
  `filter` | ol.SelectFilterFunction | undefined | A function that takes an `ol.Feature` and an `ol.layer.Layer` and returns `true` if the feature may be selected or `false` otherwise.
  `wrapX` | boolean | undefined | Wrap the world horizontally on the selection overlay. Default is `true`.
  `hitTolerance` | number | undefined | 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:

  - `change` (ol.events.Event) - Generic change event. Triggered when the revision counter is increased.
  - `change:active` (ol.Object.Event)
  - `propertychange` (ol.Object.Event) - Triggered when a property is changed.
  - `select` (ol.interaction.Select.Event) - Triggered when feature(s) has been (de)selected.

### Extends

- ol.interaction.Interaction

### Classes

Event

### Observable Properties

Name | Type | Settable | ol.Object.Event type | Description
--- | --- | --- | --- | ---
`active` | boolean | yes | `change:active` | `true` if the interaction is active, `false` otherwise.

### Methods

#### ol.interaction.Select.handleEvent(mapBrowserEvent){boolean}

src/ol/interaction/select.js, line 202

  Handles the `map browser event` and may change the selected state of features.

  ##### This:

  - {ol.interaction.Select}

  Name | Type | Description
  --- | --- | ---
  `mapBrowserEvent` | ol.MapBrowserEvent | Map browser event.

  ##### Returns:

  `false` to stop event propagation.

#### changed() inherited

src/ol/observable.js, line 58

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

#### dispatchEvent(event) inherited

src/ol/observable.js, line 75

  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 | ol.events.Event | string | Event object.

#### get(key){*} inherited

src/ol/object.js, line 101

  Gets a value.

  Name | Type | Description
  --- | --- | ---
  `key` | string | Key name.

  ##### Returns:

  Value.

#### getActive(){boolean} inherited

src/ol/interaction/interaction.js, line 55

  Return whether the interaction is currently active.

  ##### Returns:

  `true` if the interaction is active, `false` otherwise.

#### getFeatures(){ol.Collection.<ol.Feature>}

src/ol/interaction/select.js, line 164

  Get the selected features.

  ##### Returns:

  Features collection.

#### getHitTolerance(){number}

src/ol/interaction/select.js, line 174

  Returns the Hit-detection tolerance.

  ##### Returns:

  Hit tolerance in pixels.

#### getKeys(){Array.<string>} inherited

src/ol/object.js, line 115

  Get a list of object property names.

  ##### Returns:

  List of property names.

#### getLayer(feature){ol.layer.Vector}

src/ol/interaction/select.js, line 188

  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` | ol.Feature | ol.render.Feature | Feature

  ##### Returns:

  Layer.

#### getMap(){ol.Map} inherited

src/ol/interaction/interaction.js, line 66

  Get the map associated with this interaction.

  ##### Returns:

  Map.

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

src/ol/object.js, line 125

  Get an object of all property names and values.

  ##### Returns:

  Object.

#### getRevision(){number} inherited

src/ol/observable.js, line 84

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

  ##### Returns:

  Revision.

#### on(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 99

  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.
  `this` | Object | The object to use as `this` in `listener`.

  ##### 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, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 124

  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.
  `this` | Object | The object to use as `this` in `listener`.

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

src/ol/object.js, line 150

  Sets a value.

  Name | Type | Description
  --- | --- | ---
  `key` | string | Key name.
  `value` | * | Value.
  `silent` | boolean | Update without triggering an event.

#### setActive(active) inherited

src/ol/interaction/interaction.js, line 77

  Activate or deactivate the interaction.

  Name | Type | Description
  --- | --- | ---
  `active` | boolean | Active.

#### setHitTolerance(hitTolerance)

src/ol/interaction/select.js, line 297

  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.

#### setMap(map)

src/ol/interaction/select.js, line 309

  Remove the interaction from its current map, if any, and attach it to a new map, if any. Pass `null` to just remove the interaction from the current map.

  Name | Type | Description
  --- | --- | ---
  `map` | ol.Map | Map.

#### setProperties(values, opt_silent) inherited

src/ol/object.js, line 170

  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, opt_this) inherited

src/ol/observable.js, line 147

  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.
  `this` | Object | The object which was used as `this` by the `listener`.

#### unset(key, opt_silent) inherited

src/ol/object.js, line 184

  Unsets a property.

  Name | Type | Description
  --- | --- | ---
  `key` | string | Key name.
  `silent` | boolean | Unset without triggering an event.