Class GPX

Hierarchy

GPX
- GPX

Constructors

constructor

new GPX(
    options: {
        defaultStyle?: any;
        extensions?: any;
        orderBy?: string;
        readExtensions?: Function;
    },
): GPX
Parameters
- options: {
      defaultStyle?: any;
      extensions?: any;
      orderBy?: string;
      readExtensions?: Function;
  }
  Options
  - OptionaldefaultStyle?: any
    Styles by default
  - Optionalextensions?: any
    Add properties to file root
  - OptionalorderBy?: string
    Sort by key the feature before writing. By default, no sorting
  - OptionalreadExtensions?: Function
    Reading extensions (native)
Returns GPX
Overrides olGPX.constructor
- Defined in src/packages/Formats/GPX.js:33

Properties

`Protected`dataProjection

dataProjection: undefined | Projection

`Protected`defaultFeatureProjection

defaultFeatureProjection: undefined | Projection

`Protected`featureClass

featureClass: typeof Feature

options

options: {
    defaultStyle?: any;
    extensions?: any;
    orderBy?: string;
    readExtensions?: Function;
}

source

source: null | Document | Node | HTMLElement

supportedMediaTypes

supportedMediaTypes: string[]

A list media types supported by the format in descending order of preference.

Methods

`Protected`adaptOptions

adaptOptions(
options: undefined | WriteOptions | ReadOptions,
): undefined | WriteOptions | ReadOptions
Protected
Sets the dataProjection on the options, if no dataProjection is set.
Parameters
- options: undefined | WriteOptions | ReadOptions
  Options.
Returns undefined | WriteOptions | ReadOptions
Updated options.
Inherited from olGPX.adaptOptions
- Defined in node_modules/ol/format/Feature.d.ts:252

`Protected`getReadOptions

getReadOptions(source: any, options?: ReadOptions): undefined | ReadOptions
Protected
Adds the data projection to the read options.
Parameters
- source: any
  Source.
- Optionaloptions: ReadOptions
  Options.
Returns undefined | ReadOptions
Options.
Inherited from olGPX.getReadOptions
- Defined in node_modules/ol/format/Feature.d.ts:242

`Abstract`getType

getType(): Type
Returns Type
The format type.
Inherited from olGPX.getType
- Defined in node_modules/ol/format/Feature.d.ts:257

readExtensions

readExtensions(feature: Feature<Geometry>, node: any): void
Callback to read extensions from options : readExtensions
Parameters
- feature: Feature<Geometry>
  ...
- node: any
  ...
Returns void
- Defined in src/packages/Formats/GPX.js:218

readFeature

readFeature(source: any, options?: ReadOptions): Feature<Geometry>
Read a single feature.
Parameters
- source: any
  Source.
- Optionaloptions: ReadOptions
  Read options.
Returns Feature<Geometry>
Feature.

Api
Inherited from olGPX.readFeature
- Defined in node_modules/ol/format/XMLFeature.d.ts:26

readFeatureFromDocument

readFeatureFromDocument(doc: Document, options?: ReadOptions): Feature<Geometry>
Parameters
- doc: Document
  Document.
- Optionaloptions: ReadOptions
  Options.
Returns Feature<Geometry>
Feature.
Inherited from olGPX.readFeatureFromDocument
- Defined in node_modules/ol/format/XMLFeature.d.ts:32

readFeatureFromNode

readFeatureFromNode(node: Element, options?: ReadOptions): Feature<Geometry>
Parameters
- node: Element
  Node.
- Optionaloptions: ReadOptions
  Options.
Returns Feature<Geometry>
Feature.
Inherited from olGPX.readFeatureFromNode
- Defined in node_modules/ol/format/XMLFeature.d.ts:38

readFeatures

readFeatures(source: Document | Node, options: any): Feature<Geometry>[]
Read Extend Styles for Features. This function overloads ol.format.GPX.readFeatures ...
Parameters
- source: Document | Node
  Source.
- options: any
  options. see olx.format.ReadOptions
Returns Feature<Geometry>[]
Features.

See
olGPX#readFeatures
Overrides olGPX.readFeatures
- Defined in src/packages/Formats/GPX.js:74

`Protected`readFeaturesFromDocument

readFeaturesFromDocument(
doc: Document,
options?: ReadOptions,
): Feature<Geometry>[]
Protected
Parameters
- doc: Document
  Document.
- Optionaloptions: ReadOptions
  Options.
Returns Feature<Geometry>[]
Features.
Inherited from olGPX.readFeaturesFromDocument
- Defined in node_modules/ol/format/XMLFeature.d.ts:45

`Protected` `Abstract`readFeaturesFromNode

readFeaturesFromNode(node: Element, options?: ReadOptions): Feature<Geometry>[]
Protected
Parameters
- node: Element
  Node.
- Optionaloptions: ReadOptions
  Options.
Returns Feature<Geometry>[]
Features.
Inherited from olGPX.readFeaturesFromNode
- Defined in node_modules/ol/format/XMLFeature.d.ts:53

`Abstract`readGeometry

readGeometry(source: any, options?: ReadOptions): Geometry
Read a single geometry from a source.
Parameters
- source: any
  Source.
- Optionaloptions: ReadOptions
  Read options.
Returns Geometry
Geometry.
Inherited from olGPX.readGeometry
- Defined in node_modules/ol/format/Feature.d.ts:284

`Protected`readGeometryFromDocument

readGeometryFromDocument(doc: Document, options?: ReadOptions): Geometry
Protected
Parameters
- doc: Document
  Document.
- Optionaloptions: ReadOptions
  Options.
Returns Geometry
Geometry.
Inherited from olGPX.readGeometryFromDocument
- Defined in node_modules/ol/format/XMLFeature.d.ts:60

`Protected`readGeometryFromNode

readGeometryFromNode(node: Element, options?: ReadOptions): Geometry
Protected
Parameters
- node: Element
  Node.
- Optionaloptions: ReadOptions
  Options.
Returns Geometry
Geometry.
Inherited from olGPX.readGeometryFromNode
- Defined in node_modules/ol/format/XMLFeature.d.ts:67

readMetadata

readMetadata(source: any): null | GPXMetadata
Reads a GPX file's metadata tag, reading among other things:
- the name and description of this GPX
- its author
- the copyright associated with this GPX file
Will return null if no metadata tag is present (or no valid source is given).
Parameters
- source: any
  Source.
Returns null | GPXMetadata
Metadata

Api
Inherited from olGPX.readMetadata
- Defined in node_modules/ol/format/GPX.d.ts:156

readMetadataFromDocument

readMetadataFromDocument(doc: Document): null | GPXMetadata
Parameters
- doc: Document
  Document.
Returns null | GPXMetadata
Metadata
Inherited from olGPX.readMetadataFromDocument
- Defined in node_modules/ol/format/GPX.d.ts:161

readMetadataFromNode

readMetadataFromNode(node: Element): any
Parameters
- node: Element
  Node.
Returns any
Metadata
Inherited from olGPX.readMetadataFromNode
- Defined in node_modules/ol/format/GPX.d.ts:166

readProjection

readProjection(source: any): Projection
Read the projection from the source.
Parameters
- source: any
  Source.
Returns Projection
Projection.

Api
Inherited from olGPX.readProjection
- Defined in node_modules/ol/format/XMLFeature.d.ts:76

`Protected`readProjectionFromDocument

readProjectionFromDocument(doc: Document): Projection
Protected
Parameters
- doc: Document
  Document.
Returns Projection
Projection.
Inherited from olGPX.readProjectionFromDocument
- Defined in node_modules/ol/format/XMLFeature.d.ts:82

`Protected`readProjectionFromNode

readProjectionFromNode(node: Element): Projection
Protected
Parameters
- node: Element
  Node.
Returns Projection
Projection.
Inherited from olGPX.readProjectionFromNode
- Defined in node_modules/ol/format/XMLFeature.d.ts:88

readRootExtensions

readRootExtensions(key: any): any
...
Parameters
- key: any
  ...
Returns any
json

Todo
- Defined in src/packages/Formats/GPX.js:270

writeFeature

writeFeature(feature: Feature<Geometry>, options?: WriteOptions): string
Encode a feature as string.
Parameters
- feature: Feature<Geometry>
  Feature.
- Optionaloptions: WriteOptions
  Write options.
Returns string
Encoded feature.
Inherited from olGPX.writeFeature
- Defined in node_modules/ol/format/XMLFeature.d.ts:97

`Protected`writeFeatureNode

writeFeatureNode(feature: Feature<Geometry>, options?: WriteOptions): Node
Protected
Parameters
- feature: Feature<Geometry>
  Feature.
- Optionaloptions: WriteOptions
  Options.
Returns Node
Node.
Inherited from olGPX.writeFeatureNode
- Defined in node_modules/ol/format/XMLFeature.d.ts:104

writeFeatures

writeFeatures(features: Features[], options: any): string
Write Extend Styles for Features. This function overloads ol.format.GPX.writeFeatures ...
Parameters
- features: Features[]
  Features.
- options: any
  Options.
Returns string
Result or null.

See
olGPX#writeFeatures
Overrides olGPX.writeFeatures
- Defined in src/packages/Formats/GPX.js:123

writeFeaturesNode

writeFeaturesNode(features: Feature<Geometry>[], options?: WriteOptions): Node
Parameters
- features: Feature<Geometry>[]
  Features.
- Optionaloptions: WriteOptions
  Options.
Returns Node
Node.
Inherited from olGPX.writeFeaturesNode
- Defined in node_modules/ol/format/XMLFeature.d.ts:120

writeGeometry

writeGeometry(geometry: Geometry, options?: WriteOptions): string
Encode a geometry as string.
Parameters
- geometry: Geometry
  Geometry.
- Optionaloptions: WriteOptions
  Write options.
Returns string
Encoded geometry.
Inherited from olGPX.writeGeometry
- Defined in node_modules/ol/format/XMLFeature.d.ts:129

writeGeometryNode

writeGeometryNode(geometry: Geometry, options?: WriteOptions): Node
Parameters
- geometry: Geometry
  Geometry.
- Optionaloptions: WriteOptions
  Options.
Returns Node
Node.
Inherited from olGPX.writeGeometryNode
- Defined in node_modules/ol/format/XMLFeature.d.ts:135

writeRootExtensions_

writeRootExtensions_(doc: any, extensions: any, xml?: boolean): void
...
Parameters
- doc: any
  ...
- extensions: any
  ...
- Optionalxml: boolean
  write tag xml or json
Returns void
- Defined in src/packages/Formats/GPX.js:315

Class GPX

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

OptionaldefaultStyle?: any

Optionalextensions?: any

OptionalorderBy?: string

OptionalreadExtensions?: Function

Returns GPX

Properties

ProtecteddataProjection

ProtecteddefaultFeatureProjection

ProtectedfeatureClass

options

source

supportedMediaTypes

Methods

ProtectedadaptOptions

Parameters

Returns undefined | WriteOptions | ReadOptions

ProtectedgetReadOptions

Parameters

Returns undefined | ReadOptions

AbstractgetType

Returns Type

readExtensions

Parameters

Returns void

readFeature

Parameters

Returns Feature<Geometry>

Api

readFeatureFromDocument

Parameters

Returns Feature<Geometry>

readFeatureFromNode

Parameters

Returns Feature<Geometry>

readFeatures

Parameters

Returns Feature<Geometry>[]

See

ProtectedreadFeaturesFromDocument

Parameters

Returns Feature<Geometry>[]

Protected AbstractreadFeaturesFromNode

Parameters

Returns Feature<Geometry>[]

AbstractreadGeometry

Parameters

Returns Geometry

ProtectedreadGeometryFromDocument

Parameters

Returns Geometry

ProtectedreadGeometryFromNode

Parameters

Returns Geometry

readMetadata

Parameters

Returns null | GPXMetadata

Api

readMetadataFromDocument

Parameters

Returns null | GPXMetadata

readMetadataFromNode

Parameters

Returns any

readProjection

Parameters

Returns Projection

Api

ProtectedreadProjectionFromDocument

Parameters

Returns Projection

ProtectedreadProjectionFromNode

`Optional`defaultStyle?: any

`Optional`extensions?: any

`Optional`orderBy?: string

`Optional`readExtensions?: Function

`Protected`dataProjection

`Protected`defaultFeatureProjection

`Protected`featureClass

`Protected`adaptOptions

`Protected`getReadOptions

`Abstract`getType

`Protected`readFeaturesFromDocument

`Protected` `Abstract`readFeaturesFromNode

`Abstract`readGeometry

`Protected`readGeometryFromDocument

`Protected`readGeometryFromNode

`Protected`readProjectionFromDocument

`Protected`readProjectionFromNode

`Protected`writeFeatureNode