OpenLayers 3 API Documentation

Class: GPX

ol.format.GPX

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

new ol.format.GPX(opt_options)

src/ol/format/gpxformat.js, line 28
Name Type Description
options

Options.

Name Type Description
readExtensions function

Callback function to process extensions nodes. To prevent memory leaks, this callback function must not store any references to the node. Note that the extensions node is not allowed in GPX 1.0. Moreover, only extensions nodes from wpt, rte and trk can be processed, as those are directly mapped to a feature.

Extends

Methods

readFeature(source, opt_options){ol.Feature}

src/ol/format/gpxformat.js, line 434

Read the first feature from a GPX source.

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

Source.
options

Read options.

Name Type Description
dataProjection ol.proj.ProjectionLike

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

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/gpxformat.js, line 467

Read all features from a GPX source.

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

Source.
options

Read options.

Name Type Description
dataProjection ol.proj.ProjectionLike

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

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

readProjection(source){ol.proj.Projection}

src/ol/format/gpxformat.js, line 501

Read the projection from a GPX source.

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

Source.
Returns:
Projection.

writeFeatures(features, opt_options){string}

src/ol/format/gpxformat.js, line 856

Encode an array of features in the GPX format.

Name Type Description
features Array.<ol.Feature>

Features.
options

Write options.

Name Type Description
dataProjection ol.proj.ProjectionLike

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.

writeFeaturesNode(features, opt_options){Node} experimental

src/ol/format/gpxformat.js, line 867

Encode an array of features in the GPX format as an XML node.

Name Type Description
features Array.<ol.Feature>

Features.
options

Options.

Name Type Description
dataProjection ol.proj.ProjectionLike

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:
Node.