OpenLayers 3 API Documentation

Class: KML

ol.format.KML

Feature format for reading and writing data in the KML format.

new ol.format.KML(opt_options)

src/ol/format/kmlformat.js, line 69
Name Type Description
options

Options.

Name Type Description
extractStyles boolean | undefined

Extract styles from the KML. Default is true.
defaultStyle Array.<ol.style.Style> | undefined

Default style. The default default style is the same as Google Earth.

Extends

Methods

readFeature(source, opt_options){ol.Feature}

src/ol/format/kmlformat.js, line 1514

Read the first feature from a KML source.

Name Type Description
source ArrayBuffer | Document | Node | Object | string

Source.
options

Read options.

Name Type Description
dataProjection ol.proj.ProjectionLike | undefined

Projection of the data we are reading. If not provided, the projection will be derived from the data (where possible) or the defaultDataProjection of the format is assigned (where set). If the projection can not be derived from the data and if no defaultDataProjection is set for a format, the features will not be reprojected.
featureProjection ol.proj.ProjectionLike | undefined

Projection of the feature geometries created by the format reader. If not provided, features will be returned in the dataProjection.
Returns:
Feature.

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

src/ol/format/kmlformat.js, line 1545

Read all features from a KML source.

Name Type Description
source ArrayBuffer | Document | Node | Object | string

Source.
options

Read options.

Name Type Description
dataProjection ol.proj.ProjectionLike | undefined

Projection of the data we are reading. If not provided, the projection will be derived from the data (where possible) or the defaultDataProjection of the format is assigned (where set). If the projection can not be derived from the data and if no defaultDataProjection is set for a format, the features will not be reprojected.
featureProjection ol.proj.ProjectionLike | undefined

Projection of the feature geometries created by the format reader. If not provided, features will be returned in the dataProjection.
Returns:
Features.

readName(source){string|undefined}

src/ol/format/kmlformat.js, line 1596
Name Type Description
source Document | Node | string

Souce.
Returns:
Name.

readProjection(source){ol.proj.Projection}

src/ol/format/kmlformat.js, line 1666

Read the projection from a KML source.

Name Type Description
source ArrayBuffer | Document | Node | Object | string

Source.
Returns:
Projection.

writeFeatures(features, opt_options){Node}

src/ol/format/kmlformat.js, line 2531

Encode an array of features in the KML format.

Name Type Description
features Array.<ol.Feature>

Features.
options

Options.

Name Type Description
dataProjection ol.proj.ProjectionLike | undefined

Projection of the data we are writing. If not provided, the defaultDataProjection of the format is assigned (where set). If no defaultDataProjection is set for a format, the features will be returned in the featureProjection.
featureProjection ol.proj.ProjectionLike

Projection of the feature geometries that will be serialized by the format writer.
Returns:
Result.