new ol.format.GPX(opt_options)
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
options |
Options.
|
Extends
Methods
-
readFeature(source, opt_options){ol.Feature}
src/ol/format/gpxformat.js, line 446 -
Read the first feature from a GPX source.
Name Type Description source
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 nodefaultDataProjection
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 480 -
Read all features from a GPX source.
Name Type Description source
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 nodefaultDataProjection
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 515 -
Read the projection from a GPX source.
Name Type Description source
Document | Node | Object | string Source.
Returns:
Projection.
-
writeFeatures(features, opt_options){string}
src/ol/format/gpxformat.js, line 876 -
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 nodefaultDataProjection
is set for a format, the features will be returned in thefeatureProjection
.featureProjection
ol.proj.ProjectionLike Projection of the feature geometries that will be serialized by the format writer.
rightHanded
boolean | undefined When writing geometries, follow the right-hand rule for linear ring orientation. This means that polygons will have counter-clockwise exterior rings and clockwise interior rings. By default, coordinates are serialized as they are provided at construction. If
true
, the right-hand rule will be applied. Iffalse
, the left-hand rule will be applied (clockwise for exterior and counter-clockwise for interior rings). Note that not all formats support this. The GeoJSON format does use this property when writing geometries.Returns:
Result.
-
writeFeaturesNode(features, opt_options){Node} experimental
src/ol/format/gpxformat.js, line 887 -
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 nodefaultDataProjection
is set for a format, the features will be returned in thefeatureProjection
.featureProjection
ol.proj.ProjectionLike Projection of the feature geometries that will be serialized by the format writer.
rightHanded
boolean | undefined When writing geometries, follow the right-hand rule for linear ring orientation. This means that polygons will have counter-clockwise exterior rings and clockwise interior rings. By default, coordinates are serialized as they are provided at construction. If
true
, the right-hand rule will be applied. Iffalse
, the left-hand rule will be applied (clockwise for exterior and counter-clockwise for interior rings). Note that not all formats support this. The GeoJSON format does use this property when writing geometries.Returns:
Node.