OpenLayers

Class: Vector

ol.source.Vector

Provides a source of features for vector layers. Vector features provided by this source are suitable for editing. See ol.source.VectorTile for vector data that is optimized for rendering.

new ol.source.Vector(opt_options)

src/ol/source/vector.js, line 38
Name Type Description
options

Vector source options.

Name Type Description
attributions ol.AttributionLike | undefined

Attributions.
features Array.<ol.Feature> | ol.Collection.<ol.Feature> | undefined

Features. If provided as ol.Collection, the features in the source and the collection will stay in sync.
format ol.format.Feature | undefined

The feature format used by the XHR feature loader when url is set. Required if url is set, otherwise ignored. Default is undefined.
loader ol.FeatureLoader | undefined

The loader function used to load features, from a remote source for example. If this is not set and url is set, the source will create and use an XHR feature loader.
logo string | olx.LogoOptions | undefined

Logo.
overlaps boolean | undefined

This source may have overlapping geometries. Default is true. Setting this to false (e.g. for sources with polygons that represent administrative boundaries or TopoJSON sources) allows the renderer to optimise fill and stroke operations.
strategy ol.LoadingStrategy | undefined

The loading strategy to use. By default an ol.loadingstrategy.all strategy is used, a one-off strategy which loads all features at once.
url string | ol.FeatureUrlFunction | undefined

Setting this option instructs the source to load features using an XHR loader (see ol.featureloader.xhr). Use a string and an ol.loadingstrategy.all for a one-off download of all features from the given URL. Use a ol.FeatureUrlFunction to generate the url with other loading strategies. Requires format to be set as well. When default XHR feature loader is provided, the features will be transformed from the data projection to the view projection during parsing. If your remote data source does not advertise its projection properly, this transformation will be incorrect. For some formats, the default projection (usually EPSG:4326) can be overridden by setting the defaultDataProjection constructor option on the format. Note that if a source contains non-feature data, such as a GeoJSON geometry or a KML NetworkLink, these will be ignored. Use a custom loader to load these.
useSpatialIndex boolean | undefined

By default, an RTree is used as spatial index. When features are removed and added frequently, and the total number of features is low, setting this to false may improve performance.

Note that ol.source.Vector#getFeaturesInExtent, ol.source.Vector#getClosestFeatureToCoordinate and ol.source.Vector#getExtent cannot be used when useSpatialIndex is set to false, and ol.source.Vector#forEachFeatureInExtent will loop through all features.

When set to false, the features will be maintained in an ol.Collection, which can be retrieved through ol.source.Vector#getFeaturesCollection.

The default is true.
wrapX boolean | undefined

Wrap the world horizontally. Default is true. For vector editing across the -180° and 180° meridians to work properly, this should be set to false. The resulting geometry coordinates will then exceed the world bounds.
Fires:

Subclasses

Extends

Classes

Event

Methods

addFeature(feature)

src/ol/source/vector.js, line 166

Add a single feature to the source. If you want to add a batch of features at once, call source.addFeatures() instead. A feature will not be added to the source if feature with the same id is already there. The reason for this behavior is to avoid feature duplication when using bbox or tile loading strategies.

Name Type Description
feature ol.Feature

Feature to add.

addFeatures(features)

src/ol/source/vector.js, line 246

Add a batch of features to the source.

Name Type Description
features Array.<ol.Feature>

Features to add.

changed() inherited

src/ol/observable.js, line 58

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

clear(opt_fast)

src/ol/source/vector.js, line 344

Remove all features from the source.

Name Type Description
fast boolean

Skip dispatching of removefeature events.

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.

forEachFeature(callback, opt_this){S|undefined}

src/ol/source/vector.js, line 391

Iterate through all features on the source, calling the provided callback with each one. If the callback returns any "truthy" value, iteration will stop and the function will return the same value.

Name Type Description
callback function

Called with each feature on the source. Return a truthy value to stop iteration.
this T

The object to use as this in the callback.
Returns:
The return value from the last call to the callback.

forEachFeatureInExtent(extent, callback, opt_this){S|undefined}

src/ol/source/vector.js, line 447

Iterate through all features whose bounding box intersects the provided extent (note that the feature's geometry may not intersect the extent), calling the callback with each feature. If the callback returns a "truthy" value, iteration will stop and the function will return the same value.

If you are interested in features whose geometry intersects an extent, call the source.forEachFeatureIntersectingExtent() method instead.

When useSpatialIndex is set to false, this method will loop through all features, equivalent to ol.source.Vector#forEachFeature.

Name Type Description
extent ol.Extent

Extent.
callback function

Called with each feature whose bounding box intersects the provided extent.
this T

The object to use as this in the callback.
Returns:
The return value from the last call to the callback.

forEachFeatureIntersectingExtent(extent, callback, opt_this){S|undefined}

src/ol/source/vector.js, line 473

Iterate through all features whose geometry intersects the provided extent, calling the callback with each feature. If the callback returns a "truthy" value, iteration will stop and the function will return the same value.

If you only want to test for bounding box intersection, call the source.forEachFeatureInExtent() method instead.

Name Type Description
extent ol.Extent

Extent.
callback function

Called with each feature whose geometry intersects the provided extent.
this T

The object to use as this in the callback.
Returns:
The return value from the last call to the callback.

get(key){*} inherited

src/ol/object.js, line 101

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getAttributions(){Array.<ol.Attribution>} inherited

src/ol/source/source.js, line 113

Get the attributions of the source.

Returns:
Attributions.

getClosestFeatureToCoordinate(coordinate, opt_filter){ol.Feature}

src/ol/source/vector.js, line 567

Get the closest feature to the provided coordinate.

This method is not available when the source is configured with useSpatialIndex set to false.

Name Type Description
coordinate ol.Coordinate

Coordinate.
filter function

Feature filter function. The filter function will receive one argument, the feature and it should return a boolean value. By default, no filtering is made.
Returns:
Closest feature.

getExtent(opt_extent){ol.Extent}

src/ol/source/vector.js, line 620

Get the extent of the features currently in the source.

This method is not available when the source is configured with useSpatialIndex set to false.

Name Type Description
extent ol.Extent

Destination extent. If provided, no new extent will be created. Instead, that extent's coordinates will be overwritten.
Returns:
Extent.

getFeatureById(id){ol.Feature}

src/ol/source/vector.js, line 634

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

src/ol/source/vector.js, line 509

Get all features on the source in random order.

Returns:
Features.

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

src/ol/source/vector.js, line 530

Get all features whose geometry intersects the provided coordinate.

Name Type Description
coordinate ol.Coordinate

Coordinate.
Returns:
Features.

getFeaturesCollection(){ol.Collection.<ol.Feature>}

src/ol/source/vector.js, line 499

Get the features collection associated with this source. Will be null unless the source was configured with useSpatialIndex set to false, or with an ol.Collection as features.

Returns:
The collection of features.

getFeaturesInExtent(extent){Array.<ol.Feature>}

src/ol/source/vector.js, line 550

Get all features in the provided extent. Note that this returns an array of all features intersecting the given extent in random order (so it may include features whose geometries do not intersect the extent).

This method is not available when the source is configured with useSpatialIndex set to false.

Name Type Description
extent ol.Extent

Extent.
Returns:
Features.

getFormat(){ol.format.Feature|undefined}

src/ol/source/vector.js, line 646

Get the format associated with this source.

Returns:
The feature format.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 115

Get a list of object property names.

Returns:
List of property names.

getLogo(){string|olx.LogoOptions|undefined} inherited

src/ol/source/source.js, line 123

Get the logo of the source.

Returns:
Logo.

getProjection(){ol.proj.Projection} inherited

src/ol/source/source.js, line 133

Get the projection of the source.

Returns:
Projection.

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.

getState(){ol.source.State} inherited

src/ol/source/source.js, line 150

Get the state of the source, see ol.source.State for possible states.

Returns:
State.

getUrl(){string|ol.FeatureUrlFunction|undefined}

src/ol/source/vector.js, line 671

Get the url associated with this source.

Returns:
The url.

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.

refresh() inherited

src/ol/source/source.js, line 167

Refreshes the source and finally dispatches a 'change' event.

removeFeature(feature)

src/ol/source/vector.js, line 772

Remove a single feature from the source. If you want to remove all features at once, use the source.clear() method instead.

Name Type Description
feature ol.Feature

Feature to remove.

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.

setAttributions(attributions) inherited

src/ol/source/source.js, line 179

Set the attributions of the source.

Name Type Description
attributions ol.AttributionLike | undefined

Attributions. Can be passed as string, Array<string>, ol.Attribution, Array<ol.Attribution> or undefined.

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.