Module: ol/format/KML

ol/format/KML


Classes

KML

Type Definitions

GxTrackObject{Object}

Properties:
Name Type Description
coordinates Array.<Array.<number>>

Coordinates.

whens Array.<number>

Whens.

IconUrlFunction()

A function that takes a url {string} and returns a url {string}. Might be used to change an icon path or to substitute a data url obtained from a KMZ array buffer.

Options{Object}

Properties:
Name Type Argument Default Description
extractStyles boolean <optional>
true

Extract styles from the KML.

showPointNames boolean <optional>
true

Show names as labels for placemarks which contain points.

defaultStyle Array.<module:ol/style/Style~Style> <optional>

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

writeStyles boolean <optional>
true

Write styles into KML.

crossOrigin null | string <optional>
'anonymous'

The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you want to access pixel data with the Canvas renderer.

iconUrlFunction module:ol/format/KML~IconUrlFunction <optional>

Function that takes a url string and returns a url string. Might be used to change an icon path or to substitute a data url obtained from a KMZ array buffer.

Vec2{Object}

Properties:
Name Type Argument Description
x number

X coordinate.

xunits module:ol/style/IconAnchorUnits

Units of x.

y number

Y coordinate.

yunits module:ol/style/IconAnchorUnits

Units of Y.

origin module:ol/style/IconOrigin <optional>

Origin.