OpenLayers 3 API Documentation

Class: Vector

ol.source.Vector

Base class for vector sources.

new ol.source.Vector(opt_options) experimental

src/ol/source/vectorsource.js, line 51
Name Type Description
options optional

Vector source options.

Name Type Description
attributions Array.<ol.Attribution> | undefined optional

Attributions.
extent ol.Extent | undefined optional

Extent.
features Array.<ol.Feature> | undefined optional

Features.
logo string | undefined optional

Logo.
projection ol.proj.ProjectionLike

Projection.
state ol.source.State | string | undefined optional

State.
Fires:

Subclasses

Extends

Methods

addFeature(feature) experimental

src/ol/source/vectorsource.js, line 107
Name Type Description
feature ol.Feature

Feature.

addFeatures(features) experimental

src/ol/source/vectorsource.js, line 156
Name Type Description
features Array.<ol.Feature>

Features.

dispatchChangeEvent() inherited experimental

src/ol/observable.js, line 41

Dispatches a change event.

Fires:
  • change experimental

forEachFeature(f, opt_this){S|undefined} experimental

src/ol/source/vectorsource.js, line 197
Name Type Description
f function

Callback.
this T optional

The object to use as this in f.

forEachFeatureInExtent(extent, f, opt_this){S|undefined} experimental

src/ol/source/vectorsource.js, line 232
Name Type Description
extent ol.Extent

Extent.
f function

Callback.
this T optional

The object to use as this in f.

getClosestFeatureToCoordinate(coordinate){ol.Feature} experimental

src/ol/source/vectorsource.js, line 294
Name Type Description
coordinate ol.Coordinate

Coordinate.
Returns:
Closest feature.

getExtent(){ol.Extent} experimental

src/ol/source/vectorsource.js, line 340
Returns:
Extent.

getFeatureById(id){ol.Feature} experimental

src/ol/source/vectorsource.js, line 354

Get a feature by its identifier (the value returned by feature.getId()). Note that the index treats string and numeric identifiers as the same. So source.getFeatureById(2) will return a feature with id '2' or 2.

Name Type Description
id string | number

Feature identifier.
Returns:
The feature (or null if not found).

getFeatures(){Array.<ol.Feature>} experimental

src/ol/source/vectorsource.js, line 256
Returns:
Features.

getFeaturesAtCoordinate(coordinate){Array.<ol.Feature>} experimental

src/ol/source/vectorsource.js, line 271
Name Type Description
coordinate ol.Coordinate

Coordinate.
Returns:
Features.

getState(){ol.source.State} inherited experimental

src/ol/source/source.js, line 142
Returns:
State.

on(type, listener, opt_this){goog.events.Key} inherited experimental

src/ol/observable.js, line 63

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 optional

The object to use as this in listener.
Returns:
Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited experimental

src/ol/observable.js, line 76

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 optional

The object to use as this in listener.
Returns:
Unique key for the listener.

removeFeature(feature) experimental

src/ol/source/vectorsource.js, line 436
Name Type Description
feature ol.Feature

Feature.

un(type, listener, opt_this) inherited experimental

src/ol/observable.js, line 88

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 optional

The object to use as this in listener.

unByKey(key) inherited experimental

src/ol/observable.js, line 98

Removes an event listener using the key returned by on() or once().

Name Type Description
key goog.events.Key

Key.