kotlin-cesium-engine/cesium.engine/GpxDataSource

GpxDataSource

external class GpxDataSource(source)

A DataSource which processes the GPS Exchange Format (GPX).

const viewer = new Viewer('cesiumContainer');
viewer.dataSources.add(GpxDataSource.load('../../SampleData/track.gpx'));
Content copied to clipboard

See also

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion
Link copied to clipboard
sealed interface LoadOptions

Properties

Link copied to clipboard
var changedEvent: DefaultEvent

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

Link copied to clipboard
var clock: DataSourceClock

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.

Link copied to clipboard
var clustering: EntityCluster

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

Link copied to clipboard
var creator: String

Gets the creator of the GPX document.

Link copied to clipboard
var entities: EntityCollection

Gets the collection of Entity instances.

Link copied to clipboard
var errorEvent: DefaultEvent

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

Link copied to clipboard
var isLoading: Boolean

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

Link copied to clipboard
var loadingEvent: DefaultEvent

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

Link copied to clipboard
var metadata: Any

Gets an object containing metadata about the GPX file.

Link copied to clipboard
var name: String

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

Link copied to clipboard
var show: Boolean

Gets whether or not this data source should be displayed.

Link copied to clipboard
var version: String

Gets the version of the GPX Schema in use.

Functions

Link copied to clipboard
suspend fun load(data: Any, options: GpxDataSource.LoadOptions? = definedExternally): GpxDataSource

Asynchronously loads the provided GPX data, replacing any existing data.

Link copied to clipboard
fun loadAsync(data: Any, options: GpxDataSource.LoadOptions? = definedExternally): Promise<GpxDataSource>
Link copied to clipboard
fun update(time: JulianDate): Boolean

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.