OpenLayers 3 API Documentation

Class: FormatVector

ol.source.FormatVector

Abstract base class; normally only used for creating subclasses and not instantiated in apps. Base class for vector sources in one of the supported formats.

Fires:

Subclasses

Extends

Methods

addFeature(feature) inherited

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

Add a single feature to the source. If you want to add a batch of features at once, call source.addFeatures() instead.

Name Type Description
feature ol.Feature

Feature to add.

addFeatures(features) inherited

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

Add a batch of features to the source.

Name Type Description
features Array.<ol.Feature>

Features to add.

bindTo(key, target, opt_targetKey){ol.ObjectAccessor} inherited experimental

src/ol/object.js, line 326

The bindTo method allows you to set up a two-way binding between a source and target object. The method returns an object with a transform method that you can use to provide from and to functions to transform values on the way from the source to the target and on the way back.

For example, if you had two map views (sourceView and targetView) and you wanted the target view to have double the resolution of the source view, you could transform the resolution on the way to and from the target with the following:

sourceView.bindTo('resolution', targetView)
  .transform(
    function(sourceResolution) {
      // from sourceView.resolution to targetView.resolution
      return 2 * sourceResolution;
    },
    function(targetResolution) {
      // from targetView.resolution to sourceView.resolution
      return targetResolution / 2;
    }
  );
Name Type Description
key string

Key name.
target ol.Object

Target.
targetKey string

Target key.

changed() inherited experimental

src/ol/observable.js, line 52

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

Fires:
  • change experimental

clear(opt_fast) inherited

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

Remove all features from the source.

Name Type Description
fast boolean

Skip dispatching of removefeature events.

forEachFeature(callback, opt_this){S|undefined} inherited

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

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

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

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.

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

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

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 experimental

src/ol/object.js, line 354

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

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

src/ol/source/source.js, line 96
Returns:
Attributions.

getClosestFeatureToCoordinate(coordinate){ol.Feature} inherited

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

Get the closest feature to the provided coordinate.

Name Type Description
coordinate ol.Coordinate

Coordinate.
Returns:
Closest feature.

getExtent(){ol.Extent} inherited

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

Get the extent of the features currently in the source.

Returns:
Extent.

getFeatureById(id){ol.Feature} inherited

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

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

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

Get all features on the source.

Returns:
Features.

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

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

Get all features whose geometry intersects the provided coordinate.

Name Type Description
coordinate ol.Coordinate

Coordinate.
Returns:
Features.

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

src/ol/object.js, line 373

Get a list of object property names.

Returns:
List of property names.
src/ol/source/source.js, line 105
Returns:
Logo.

getProjection(){ol.proj.Projection} inherited experimental

src/ol/source/source.js, line 114
Returns:
Projection.

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

src/ol/object.js, line 405

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

src/ol/observable.js, line 62
Returns:
Revision.

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

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

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

src/ol/observable.js, line 75

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.

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

src/ol/observable.js, line 88

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.

readFeatures(source){Array.<ol.Feature>} experimental

src/ol/source/formatvectorsource.js, line 121
Name Type Description
source ArrayBuffer | Document | Node | Object | string

Source.
Returns:
Features.

removeFeature(feature) inherited

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

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) inherited experimental

src/ol/object.js, line 437

Sets a value.

Name Type Description
key string

Key name.
value *

Value.

setProperties(values) inherited experimental

src/ol/object.js, line 456

Sets a collection of key-value pairs.

Name Type Description
values Object.<string, *>

Values.

un(type, listener, opt_this) inherited

src/ol/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.
this Object

The object which was used as this by the listener.

unbind(key) inherited experimental

src/ol/object.js, line 470

Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.

Name Type Description
key string

Key name.

unbindAll() inherited experimental

src/ol/object.js, line 487

Removes all bindings.

unByKey(key) inherited

src/ol/observable.js, line 114

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name Type Description
key goog.events.Key

The key returned by on() or once().