OpenLayers 3 API Documentation

Class: KML

ol.source. KML

experimental new ol.source.KML(opt_options)

src/ol/source/kmlsource.js, line 15
Name Type Argument Description
options optional

Options.

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

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

Default style.
doc Document | undefined

Document.
extent ol.Extent | undefined

Extent.
logo string | undefined

Logo.
node Node | undefined

Node.
projection ol.proj.ProjectionLike

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

Text.
url string | undefined

URL.
urls Array.<string> | undefined

URLs.
Fires:

Extends

Methods

experimental inherited addFeature(feature)

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

Feature.

experimental inherited addFeatures(features)

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

Features.

experimental inherited dispatchChangeEvent()

src/ol/observable.js, line 39

Dispatches a change event. Register a listener for this event to get notified of changes.

Fires:
  • change

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

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

Callback.
this T <optional>
 optional

The object to use as this in f.

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

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

Extent.
f function

Callback.
this T <optional>
 optional

The object to use as this in f.

experimental inherited getClosestFeatureToCoordinate(coordinate){ol.Feature}

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

Coordinate.
Returns:
feature.

experimental inherited getExtent(){ol.Extent}

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

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

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

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

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

Coordinate.

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

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

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

src/ol/observable.js, line 61

Listen for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>
 optional

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

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

src/ol/observable.js, line 74

Listen once for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>
 optional

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

experimental inherited removeFeature(feature)

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

Feature.

experimental inherited un(type, listener, opt_this)

src/ol/observable.js, line 86

Unlisten for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>
 optional

The object to use as this in listener.

experimental inherited unByKey(key)

src/ol/observable.js, line 96

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

Name Type Description
key goog.events.Key

Key.