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: Projection | undefined

`Protected`defaultFeatureProjection

defaultFeatureProjection: Projection | undefined

`Protected`featureClass

featureClass: typeof Feature

options

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

source

source: Document | Node | HTMLElement | null

supportedMediaTypes

supportedMediaTypes: string[] | undefined

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

Methods

`Protected`adaptOptions

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

`Protected`getReadOptions

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

`Abstract`getType

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

readExtensions

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

readFeature

readFeature(
source: any,
options?: ReadOptions,
): Feature<Geometry, { [x: string]: any }> | null
Read a single feature.
Parameters
- source: any
  Source.
- Optionaloptions: ReadOptions
  Read options.
Returns Feature<Geometry, { [x: string]: any }> | null
Feature.

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

readFeatureFromDocument

readFeatureFromDocument(
doc: Document,
options?: ReadOptions,
): Feature<Geometry, { [x: string]: any }> | null
Parameters
- doc: Document
  Document.
- Optionaloptions: ReadOptions
  Options.
Returns Feature<Geometry, { [x: string]: any }> | null
Feature.
Inherited from olGPX.readFeatureFromDocument
- Defined in node_modules/ol/format/XMLFeature.d.ts:34

readFeatureFromNode

readFeatureFromNode(
node: Element,
options?: ReadOptions,
): Feature<Geometry, { [x: string]: any }> | null
Parameters
- node: Element
  Node.
- Optionaloptions: ReadOptions
  Options.
Returns Feature<Geometry, { [x: string]: any }> | null
Feature.
Inherited from olGPX.readFeatureFromNode
- Defined in node_modules/ol/format/XMLFeature.d.ts:40

readFeatures

readFeatures(
source: Document | Node,
options: any,
): Feature<Geometry, { [x: string]: any }>[]
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, { [x: string]: any }>[]
Features.

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

`Protected`readFeaturesFromDocument

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

`Protected` `Abstract`readFeaturesFromNode

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

`Abstract`readGeometry

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

`Protected`readGeometryFromDocument

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

`Protected`readGeometryFromNode

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

readMetadata

readMetadata(source: any): GPXMetadata | null
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 GPXMetadata | null
Metadata

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

readMetadataFromDocument

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

readMetadataFromNode

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

`Abstract`readProjection

readProjection(source: any): Projection | undefined
Read the projection from a source.
Parameters
- source: any
  Source.
Returns Projection | undefined
Projection.
Inherited from olGPX.readProjection
- Defined in node_modules/ol/format/Feature.d.ts:294

`Protected`readProjectionFromDocument

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

`Protected`readProjectionFromNode

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

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, { [x: string]: any }>,
options?: WriteOptions,
): string
Encode a feature as string.
Parameters
- feature: Feature<Geometry, { [x: string]: any }>
  Feature.
- Optionaloptions: WriteOptions
  Write options.
Returns string
Encoded feature.
Inherited from olGPX.writeFeature
- Defined in node_modules/ol/format/XMLFeature.d.ts:90

`Protected`writeFeatureNode

writeFeatureNode(
feature: Feature<Geometry, { [x: string]: any }>,
options?: WriteOptions,
): Node | null
Protected
Parameters
- feature: Feature<Geometry, { [x: string]: any }>
  Feature.
- Optionaloptions: WriteOptions
  Options.
Returns Node | null
Node.
Inherited from olGPX.writeFeatureNode
- Defined in node_modules/ol/format/XMLFeature.d.ts:97

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, { [x: string]: any }>[],
options?: WriteOptions,
): Node
Encode an array of features in the GPX format as an XML node. LineString geometries are output as routes (<rte>), and MultiLineString as tracks (<trk>).
Parameters
- features: Feature<Geometry, { [x: string]: any }>[]
  Features.
- Optionaloptions: WriteOptions
  Options.
Returns Node
Node.

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

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:122

writeGeometryNode

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

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 WriteOptions | ReadOptions | undefined

ProtectedgetReadOptions

Parameters

Returns ReadOptions | undefined

AbstractgetType

Returns Type

readExtensions

Parameters

Returns void

readFeature

Parameters

Returns Feature<Geometry, { [x: string]: any }> | null

Api

readFeatureFromDocument

Parameters

Returns Feature<Geometry, { [x: string]: any }> | null

readFeatureFromNode

Parameters

Returns Feature<Geometry, { [x: string]: any }> | null

readFeatures

Parameters

Returns Feature<Geometry, { [x: string]: any }>[]

See

ProtectedreadFeaturesFromDocument

Parameters

Returns Feature<Geometry, { [x: string]: any }>[]

Protected AbstractreadFeaturesFromNode

Parameters

Returns Feature<Geometry, { [x: string]: any }>[]

AbstractreadGeometry

Parameters

Returns Geometry | null

ProtectedreadGeometryFromDocument

Parameters

Returns Geometry | null

ProtectedreadGeometryFromNode

Parameters

Returns Geometry | null

readMetadata

Parameters

Returns GPXMetadata | null

Api

readMetadataFromDocument

Parameters

Returns GPXMetadata | null

readMetadataFromNode

Parameters

Returns GPXMetadata | null

AbstractreadProjection

Parameters

Returns Projection | undefined

ProtectedreadProjectionFromDocument

Parameters

Returns Projection | undefined

ProtectedreadProjectionFromNode

Parameters

`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

`Abstract`readProjection

`Protected`readProjectionFromDocument

`Protected`readProjectionFromNode

`Protected`writeFeatureNode