OpenLayers. Format.KML

Read/Wite KML.  Create a new instance with the OpenLayers.Format.KML constructor.

Inherits from

Summary
Read/Wite KML.
{String} KML Namespace to use.
{String} Name of the placemarks.
{String} Name of the folders.
{String} Description of the folders.
{Boolean} Extract attributes from KML.
{String} KML Namespace to use -- defaults to the namespace of the Placemark node being parsed, but falls back to kmlns.
Create a new parser for KML.
Read data from a string, and return a list of features.
This function is the core of the KML parsing code in OpenLayers.
Properties of this object are the functions that parse geometries based on their type.
Given a KML node representing a point geometry, create an OpenLayers point geometry.
Given a KML node representing a linestring geometry, create an OpenLayers linestring geometry.
Given a KML node representing a polygon geometry, create an OpenLayers polygon geometry.
Given a KML node representing a multigeometry, create an OpenLayers geometry collection.
Accept Feature Collection, and return a string.
Creates and returns a KML folder node
Creates and returns a KML placemark node representing the given feature.
Builds and returns a KML geometry node with the given geometry.
Object containing methods to do the actual geometry node building based on geometry type.
Given an OpenLayers point geometry, create a KML point.
Given an OpenLayers multipoint geometry, create a KML GeometryCollection.
Given an OpenLayers linestring geometry, create a KML linestring.
Given an OpenLayers multilinestring geometry, create a KML GeometryCollection.
Given an OpenLayers linearring geometry, create a KML linearring.
Given an OpenLayers polygon geometry, create a KML polygon.
Given an OpenLayers multipolygon geometry, create a KML GeometryCollection.
Given an OpenLayers geometry collection, create a KML MultiGeometry.
Builds and returns the KML coordinates node with the given geometry <coordinates>...</coordinates>

Properties

kmlns

{String} KML Namespace to use.  Defaults to 2.0 namespace.

placemarksDesc

{String} Name of the placemarks.  Default is “No description available.”

foldersName

{String} Name of the folders.  Default is “OpenLayers export.”

foldersDesc

{String} Description of the folders.  Default is “Exported on [date].”

extractAttributes

{Boolean} Extract attributes from KML.  Default is true.

internalns

{String} KML Namespace to use -- defaults to the namespace of the Placemark node being parsed, but falls back to kmlns.

Constructor

OpenLayers. Format.KML

Create a new parser for KML.

Parameters

options{Object} An optional object whose properties will be set on this instance.

Functions and Properties

read

read: function(data)

Read data from a string, and return a list of features.

Parameters

data{String} or {DOMElement} data to read/parse.

Returns

{Array(OpenLayers.Feature.Vector)} List of features.

parseFeature

parseFeature: function(node)

This function is the core of the KML parsing code in OpenLayers.  It creates the geometries that are then attached to the returned feature, and calls parseAttributes() to get attribute data out.

Parameters

node{<DOMElement>}

Returns

{OpenLayers.Feature.Vector} A vector feature.

parseGeometry

Properties of this object are the functions that parse geometries based on their type.

parseGeometry. point

Given a KML node representing a point geometry, create an OpenLayers point geometry.

Parameters

node{DOMElement} A KML Point node.

Returns

{OpenLayers.Geometry.Point} A point geometry.

parseGeometry. linestring

Given a KML node representing a linestring geometry, create an OpenLayers linestring geometry.

Parameters

node{DOMElement} A KML LineString node.

Returns

{OpenLayers.Geometry.LineString} A linestring geometry.

parseGeometry. polygon

Given a KML node representing a polygon geometry, create an OpenLayers polygon geometry.

Parameters

node{DOMElement} A KML Polygon node.

Returns

{OpenLayers.Geometry.Polygon} A polygon geometry.

parseGeometry. multigeometry

Given a KML node representing a multigeometry, create an OpenLayers geometry collection.

Parameters

node{DOMElement} A KML MultiGeometry node.

Returns

{OpenLayers.Geometry.Collection} A geometry collection.

parseAttributes

parseAttributes: function(node)

Parameters

node{<DOMElement>}

Returns

{Object} An attributes object.

write

write: function(features)

Accept Feature Collection, and return a string.

Parameters

featuresAn array of OpenLayers.Feature.Vector features.

Returns

{String} A KML string.

createFolderXML

createFolderXML: function()

Creates and returns a KML folder node

Returns

{DOMElement}

createPlacemarkXML

createPlacemarkXML: function(feature)

Creates and returns a KML placemark node representing the given feature.

Parameters

feature{OpenLayers.Feature.Vector}

Returns

{DOMElement}

buildGeometryNode

buildGeometryNode: function(geometry)

Builds and returns a KML geometry node with the given geometry.

Parameters

geometry{OpenLayers.Geometry}

Returns

{DOMElement}

buildGeometry

Object containing methods to do the actual geometry node building based on geometry type.

buildGeometry. point

Given an OpenLayers point geometry, create a KML point.

Parameters

geometry{OpenLayers.Geometry.Point} A point geometry.

Returns

{DOMElement} A KML point node.

buildGeometry. multipoint

Given an OpenLayers multipoint geometry, create a KML GeometryCollection.

Parameters

geometry{OpenLayers.Geometry.Point} A multipoint geometry.

Returns

{DOMElement} A KML GeometryCollection node.

buildGeometry. linestring

Given an OpenLayers linestring geometry, create a KML linestring.

Parameters

geometry{OpenLayers.Geometry.LineString} A linestring geometry.

Returns

{DOMElement} A KML linestring node.

buildGeometry. multilinestring

Given an OpenLayers multilinestring geometry, create a KML GeometryCollection.

Parameters

geometry{OpenLayers.Geometry.Point} A multilinestring geometry.

Returns

{DOMElement} A KML GeometryCollection node.

buildGeometry. linearring

Given an OpenLayers linearring geometry, create a KML linearring.

Parameters

geometry{OpenLayers.Geometry.LinearRing} A linearring geometry.

Returns

{DOMElement} A KML linearring node.

buildGeometry. polygon

Given an OpenLayers polygon geometry, create a KML polygon.

Parameters

geometry{OpenLayers.Geometry.Polygon} A polygon geometry.

Returns

{DOMElement} A KML polygon node.

buildGeometry. multipolygon

Given an OpenLayers multipolygon geometry, create a KML GeometryCollection.

Parameters

geometry{OpenLayers.Geometry.Point} A multipolygon geometry.

Returns

{DOMElement} A KML GeometryCollection node.

buildGeometry. collection

Given an OpenLayers geometry collection, create a KML MultiGeometry.

Parameters

geometry{OpenLayers.Geometry.Collection} A geometry collection.

Returns

{DOMElement} A KML MultiGeometry node.

buildCoordinatesNode

buildCoordinatesNode: function(geometry)

Builds and returns the KML coordinates node with the given geometry <coordinates>...</coordinates>

Parameters

geometry{OpenLayers.Geometry}

Return

{DOMElement}

read: function(data)
Read data from a string, and return a list of features.
parseFeature: function(node)
This function is the core of the KML parsing code in OpenLayers.
parseAttributes: function(node)
write: function(features)
Accept Feature Collection, and return a string.
createFolderXML: function()
Creates and returns a KML folder node
createPlacemarkXML: function(feature)
Creates and returns a KML placemark node representing the given feature.
buildGeometryNode: function(geometry)
Builds and returns a KML geometry node with the given geometry.
buildCoordinatesNode: function(geometry)
Builds and returns the KML coordinates node with the given geometry coordinates...</coordinates>
Create a new parser for KML.
Read and write XML.
Vector features use the OpenLayers.Geometry classes as geometry description.
Point geometry class.
A LineString is a Curve which, once two points have been added to it, can never be less than two points long.
Polygon is a collection of Geometry.LinearRings.
A Collection is exactly what it sounds like: A collection of different Geometries.
A Geometry is a description of a geographic object.
A Linear Ring is a special LineString which is closed.