new ol.source.TopoJSON(opt_options) experimental
Name | Type | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Options.
|
Fires:
-
addfeature
(ol.source.VectorEvent) - Triggered when a feature is added to the source. -
change
experimental - Triggered when the state of the source changes. -
changefeature
(ol.source.VectorEvent) experimental - Triggered when a feature is updated. -
clear
(ol.source.VectorEvent) experimental - Triggered when the clear method is called on the source. -
propertychange
(ol.ObjectEvent) experimental - Triggered when a property is changed. -
removefeature
(ol.source.VectorEvent) - Triggered when a feature is removed from the source. Seesource.clear()
for exceptions.
Extends
Methods
-
addFeature(feature) inherited
-
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
-
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
-
The bindTo method allows you to set up a two-way binding between a
source
andtarget
object. The method returns an object with atransform
method that you can use to providefrom
andto
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
-
Increases the revision counter and disptches a 'change' event.
Fires:
-
change
experimental
-
-
clear(opt_fast) inherited
-
Remove all features from the source.
Name Type Description fast
boolean Skip dispatching of
removefeature
events. -
forEachFeature(callback, opt_this){S|undefined} inherited
-
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
-
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
-
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
-
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
getAttributions(){Array.<ol.Attribution>} inherited
-
Returns:
Attributions.
-
getClosestFeatureToCoordinate(coordinate){ol.Feature} inherited
-
Get the closest feature to the provided coordinate.
Name Type Description coordinate
ol.Coordinate Coordinate.
Returns:
Closest feature.
-
Get the extent of the features currently in the source.
Returns:
Extent.
-
getFeatureById(id){ol.Feature} inherited
-
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'
or2
.Name Type Description id
string | number Feature identifier.
Returns:
The feature (ornull
if not found).
-
getFeatures(){Array.<ol.Feature>} inherited
-
Get all features on the source.
Returns:
Features.
-
getFeaturesAtCoordinate(coordinate){Array.<ol.Feature>} inherited
-
Get all features whose geometry intersects the provided coordinate.
Name Type Description coordinate
ol.Coordinate Coordinate.
Returns:
Features.
-
getKeys(){Array.<string>} inherited experimental
-
Get a list of object property names.
Returns:
List of property names.
-
getLogo(){string|olx.LogoOptions|undefined} inherited
-
Returns:
Logo.
-
getProjection(){ol.proj.Projection} inherited experimental
-
Returns:
Projection.
-
getProperties(){Object.<string, *>} inherited experimental
-
Get an object of all property names and values.
Returns:
Object.
-
getRevision(){number} inherited experimental
-
Returns:
Revision.
-
getState(){ol.source.State} inherited experimental
-
Returns:
State.
-
on(type, listener, opt_this){goog.events.Key} inherited
-
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
inlistener
.Returns:
Unique key for the listener.
-
once(type, listener, opt_this){goog.events.Key} inherited
-
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
inlistener
.Returns:
Unique key for the listener.
-
readFeatures(source){Array.<ol.Feature>} inherited experimental
-
Name Type Description source
ArrayBuffer | Document | Node | Object | string Source.
Returns:
Features.
-
removeFeature(feature) inherited
-
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
-
Sets a value.
Name Type Description key
string Key name.
value
* Value.
-
setProperties(values) inherited experimental
-
Sets a collection of key-value pairs.
Name Type Description values
Object.<string, *> Values.
-
un(type, listener, opt_this) inherited
-
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 thelistener
. -
unbind(key) inherited experimental
-
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
-
Removes all bindings.
-
unByKey(key) inherited
-
Removes an event listener using the key returned by
on()
oronce()
. Note that using theol.Observable.unByKey
static function is to be preferred.Name Type Description key
goog.events.Key The key returned by
on()
oronce()
.