OpenLayers 3 API Documentation

Class: KML

ol.source.KML

Static vector source in KML format

new ol.source.KML(opt_options) experimental

src/ol/source/kmlsource.js, line 18
Name Type Description
options

Options.

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

Attributions.
defaultStyle Array.<ol.style.Style> | undefined experimental

Default style.
doc Document | undefined experimental

Document.
extractStyles boolean | undefined experimental

Extract styles from the KML document. Default is true.
logo string | olx.LogoOptions | undefined experimental

Logo.
node Node | undefined experimental

Node.
projection ol.proj.ProjectionLike experimental

Destination projection. If provided, features will be transformed to this projection. If not provided, features will not be transformed.
text string | undefined experimental

Text.
url string | undefined experimental

URL.
urls Array.<string> | undefined experimental

URLs.
Fires:

Extends

Methods

addFeature(feature) inherited

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

Feature.

addFeatures(features) inherited

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

Features.

clear() inherited

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

Remove all features.

dispatchChangeEvent() inherited experimental

src/ol/observable.js, line 42

Dispatches a change event.

Fires:
  • change experimental

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

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

Callback.
this T

The object to use as this in f.

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

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

Extent.
f function

Callback.
this T

The object to use as this in f.

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 292
Name Type Description
coordinate ol.Coordinate

Coordinate.
Returns:
Closest feature.

getExtent(){ol.Extent} inherited

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

Get the extent of the features currently in the source.

Returns:
Extent.

getFeatureById(id){ol.Feature} inherited

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

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 254
Returns:
Features.

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

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

Coordinate.
Returns:
Features.
src/ol/source/source.js, line 105
Returns:
Logo.

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

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

getRevision(){number} inherited experimental

src/ol/observable.js, line 52
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 65

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 78

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

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

Source.
Returns:
Features.

removeFeature(feature) inherited

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

Feature.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 91

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.

unByKey(key) inherited

src/ol/observable.js, line 101

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

Name Type Description
key goog.events.Key

Key.