GpxDataSource

new Cesium.GpxDataSource()
DataSources/GpxDataSource.js 753

A DataSource which processes the GPS Exchange Format (GPX).
Example:
const viewer = new Cesium.Viewer('cesiumContainer');
viewer.dataSources.add(Cesium.GpxDataSource.load('../../SampleData/track.gpx'));
Demo:
See:

Members

changedEvent : Event
DataSources/GpxDataSource.js 863

Gets an event that will be raised when the underlying data changes.

clock : DataSourceClock
DataSources/GpxDataSource.js 833

Gets the clock settings defined by the loaded GPX. This represents the total availability interval for all time-dynamic data. If the GPX does not contain time-dynamic data, this value is undefined.

clustering : EntityCluster
DataSources/GpxDataSource.js 908

Gets or sets the clustering options for this data source. This object can be shared between multiple data sources.

creator : String
DataSources/GpxDataSource.js 811

Gets the creator of the GPX document.

entities : EntityCollection
DataSources/GpxDataSource.js 843

Gets the collection of Entity instances.

errorEvent : Event
DataSources/GpxDataSource.js 873

Gets an event that will be raised if an error is encountered during processing.

isLoading : Boolean
DataSources/GpxDataSource.js 853

Gets a value indicating if the data source is currently loading data.

loadingEvent : Event
DataSources/GpxDataSource.js 883

Gets an event that will be raised when the data source either starts or stops loading.

metadata : Object
DataSources/GpxDataSource.js 821

Gets an object containing metadata about the GPX file.

name : String
DataSources/GpxDataSource.js 791

Gets a human-readable name for this instance. This will be automatically be set to the GPX document name on load.

show : Boolean
DataSources/GpxDataSource.js 893

Gets whether or not this data source should be displayed.

version : String
DataSources/GpxDataSource.js 801

Gets the version of the GPX Schema in use.

Methods

static Cesium.GpxDataSource.load(data, options) → Promise.<GpxDataSource>
DataSources/GpxDataSource.js 780

Creates a Promise to a new instance loaded with the provided GPX data.
Name Type Description
data String | Document | Blob A url, parsed GPX document, or Blob containing binary GPX data.
options Object optional An object with the following properties:
Name Type Description
clampToGround Boolean optional True if the symbols should be rendered at the same height as the terrain
waypointImage String optional Image to use for waypoint billboards.
trackImage String optional Image to use for track billboards.
trackColor String optional Color to use for track lines.
routeColor String optional Color to use for route lines.
Returns:
A promise that will resolve to a new GpxDataSource instance once the gpx is loaded.

load(data, options) → Promise.<GpxDataSource>
DataSources/GpxDataSource.js 948

Asynchronously loads the provided GPX data, replacing any existing data.
Name Type Description
data String | Document | Blob A url, parsed GPX document, or Blob containing binary GPX data or a parsed GPX document.
options Object optional An object with the following properties:
Name Type Description
clampToGround Boolean optional True if the symbols should be rendered at the same height as the terrain
waypointImage String optional Image to use for waypoint billboards.
trackImage String optional Image to use for track billboards.
trackColor String optional Color to use for track lines.
routeColor String optional Color to use for route lines.
Returns:
A promise that will resolve to this instances once the GPX is loaded.

update(time) → Boolean
DataSources/GpxDataSource.js 932

Updates the data source to the provided time. This function is optional and is not required to be implemented. It is provided for data sources which retrieve data based on the current animation time or scene state. If implemented, update will be called by DataSourceDisplay once a frame.
Name Type Description
time JulianDate The simulation time.
Returns:
True if this data source is ready to be displayed at the provided time, false otherwise.