# Class: Select

This documentation is for OpenLayers v10.9.0. The latest is v.

## ol/interaction/Select~Select

    import Select from 'ol/interaction/Select.js';

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.

#### new Select(options)

interaction/Select.js, line 158

  Name | Type | Description
  --- | --- | ---
  `addCondition` | Condition | undefined | A function that takes a `MapBrowserEvent` and returns a boolean to indicate whether that event should be handled. By default, this is `never`. Use this if you want to use different events for add and remove instead of `toggle`.
  `condition` | Condition | undefined | A function that takes a `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 `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<Layer> | function | undefined | 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` | StyleLike | null | undefined | Style for the selected features. By default the default edit style is used (see `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` | Condition | undefined | A function that takes a `MapBrowserEvent` and returns a boolean to indicate whether that event should be handled. By default, this is `never`. Use this if you want to use different events for add and remove instead of `toggle`.
  `toggleCondition` | Condition | undefined | A function that takes a `MapBrowserEvent` and returns a boolean to indicate whether that event should be handled. This is in addition to the `condition` event. By default, `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 (defaults to 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` | Collection<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 `getFeatures`.
  `filter` | FilterFunction | undefined | A function that takes a `Feature` and a `Layer` and returns `true` if the feature may be selected or `false` otherwise.
  `hitTolerance` | number (defaults to 0) | Hit-detection tolerance. Pixels inside the radius around the given position will be checked for features.

  ##### Fires:

  - `change` (BaseEvent) - Generic change event. Triggered when the revision counter is increased.
  - `change:active` (ObjectEvent)
  - `error` (BaseEvent) - Generic error event. Triggered when an error occurs.
  - `propertychange` (ObjectEvent) - Triggered when a property is changed.
  - `select` (SelectEvent) - Triggered when feature(s) has been (de)selected.

### Extends

- Interaction

### Observable Properties

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

### Methods

#### changed() inherited

Observable.js, line 68

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

#### clearSelection()

interaction/Select.js, line 535

  Deselect all features as if a user deselected them. Compared to `select.getFeatures().clear()` this causes a SelectEvent. The `SelectEvent` fired by this won't have a mapBrowserEvent property

#### deselectFeature(feature){boolean}

interaction/Select.js, line 503

  Try to deselect a feature as if it was clicked. Compared to `select.getFeatures().remove(feature)` this causes a SelectEvent. The `SelectEvent` fired by this won't have a mapBrowserEvent property

  Name | Type | Description
  --- | --- | ---
  `feature` | Feature | The feature to deselect

  ##### Returns:

  True if the feature was deselected

#### dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

  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` | BaseEvent | 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 136

  Gets a value.

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

  ##### Returns:

  Value.

#### getActive(){boolean} inherited

interaction/Interaction.js, line 82

  Return whether the interaction is currently active.

  ##### Returns:

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

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

interaction/Select.js, line 295

  Get the selected features.

  ##### Returns:

  Features collection.

#### getHitTolerance(){number}

interaction/Select.js, line 304

  Returns the Hit-detection tolerance.

  ##### Returns:

  Hit tolerance in pixels.

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

Object.js, line 149

  Get a list of object property names.

  ##### Returns:

  List of property names.

#### getLayer(feature){VectorLayer}

interaction/Select.js, line 315

  Returns the associated `vector layer` of a selected feature.

  Name | Type | Description
  --- | --- | ---
  `feature` | Feature | Feature

  ##### Returns:

  Layer.

#### getMap(){Map | null} inherited

interaction/Interaction.js, line 91

  Get the map associated with this interaction.

  ##### Returns:

  Map.

#### getProperties(){NoInfer.<Properties>} inherited

Object.js, line 158

  Get an object of all property names and values.

  ##### Returns:

  Object.

#### getRevision(){number} inherited

Observable.js, line 79

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

  ##### Returns:

  Revision.

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

Observable.js, line 152

  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){EventsKey | Array<EventsKey>} inherited

Observable.js, line 164

  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.

#### selectFeature(feature){boolean}

interaction/Select.js, line 478

  Try to select a feature as if it was clicked and `addCondition` evaluated to True. Unlike modifying `select.getFeatures()` directly, this respects the `filter` and `layers` options (except `multi`, which is ignored). The `SelectEvent` fired by this won't have a mapBrowserEvent property

  Name | Type | Description
  --- | --- | ---
  `feature` | Feature | The feature to select

  ##### Returns:

  True if the feature was selected

#### set(key, value, silent) inherited

Object.js, line 218

  Sets a value.

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

#### setActive(active) inherited

interaction/Interaction.js, line 111

  Activate or deactivate the interaction.

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

#### setHitTolerance(hitTolerance)

interaction/Select.js, line 327

  Hit-detection tolerance. Pixels inside the radius around the given position will be checked for features.

  Name | Type | Description
  --- | --- | ---
  `hitTolerance` | number | Hit tolerance in pixels.

#### setMap(map)

interaction/Select.js, line 338

  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` | Map | null | Map.

#### setProperties(values, silent) inherited

Object.js, line 238

  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` | Partial.<NoInfer.<Properties>> | Values.
  `silent` | boolean | undefined | Update without triggering an event.

#### toggleFeature(feature)

interaction/Select.js, line 523

  Try to toggle a feature as if it was clicked and `toggleCondition` was True. Unlike modifying `select.getFeatures()` directly, this respects the `filter` and `layers` options (except `multi`, which is ignored). The `SelectEvent` fired by this won't have a mapBrowserEvent property

  Name | Type | Description
  --- | --- | ---
  `feature` | Feature | The feature to deselect

#### un(type, listener) inherited

Observable.js, line 173

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

Object.js, line 262

  Unsets a property.

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