CzmlDataSource

new CzmlDataSource(name)

A DataSource which processes CZML.
Name Type Description
name String optional An optional name for the data source. This value will be overwritten if a loaded document contains a name.
Demo:
Source: DataSources/CzmlDataSource.js, line 1452

Members

staticCzmlDataSource.updaters :Array

Gets the array of CZML processing functions.
Source: DataSources/CzmlDataSource.js, line 1544

changedEvent :Event

Gets an event that will be raised when the underlying data changes.
Source: DataSources/CzmlDataSource.js, line 1512

clock :DataSourceClock

Gets the clock settings defined by the loaded CZML. If no clock is explicitly defined in the CZML, the combined availability of all objects is returned. If only static data exists, this value is undefined.
Source: DataSources/CzmlDataSource.js, line 1482

entities :EntityCollection

Gets the collection of Entity instances.
Source: DataSources/CzmlDataSource.js, line 1492

errorEvent :Event

Gets an event that will be raised if an error is encountered during processing.
Source: DataSources/CzmlDataSource.js, line 1522

isLoading :Boolean

Gets a value indicating if the data source is currently loading data.
Source: DataSources/CzmlDataSource.js, line 1502

loadingEvent :Event

Gets an event that will be raised when the data source either starts or stops loading.
Source: DataSources/CzmlDataSource.js, line 1532

name :String

Gets a human-readable name for this instance.
Source: DataSources/CzmlDataSource.js, line 1470

Methods

staticCzmlDataSource.processMaterialPacketData(object, propertyName, packetData, interval, sourceUri, entityCollection)

A helper function used by custom CZML updater functions which creates or updates a MaterialProperty from a CZML packet.
Name Type Description
object Object The object on which the property will be added or updated.
propertyName String The name of the property on the object.
packetData Object The CZML packet being processed.
interval TimeInterval A constraining interval for which the data is valid.
sourceUri String The originating uri of the data being processed.
entityCollection EntityCollection The collection being processsed.
Source: DataSources/CzmlDataSource.js, line 1691

staticCzmlDataSource.processPacketData(type, object, propertyName, packetData, interval, sourceUri, entityCollection)

A helper function used by custom CZML updater functions which creates or updates a Property from a CZML packet.
Name Type Description
type function The constructor function for the property being processed.
object Object The object on which the property will be added or updated.
propertyName String The name of the property on the object.
packetData Object The CZML packet being processed.
interval TimeInterval A constraining interval for which the data is valid.
sourceUri String The originating uri of the data being processed.
entityCollection EntityCollection The collection being processsed.
Source: DataSources/CzmlDataSource.js, line 1663

staticCzmlDataSource.processPositionPacketData(object, propertyName, packetData, interval, sourceUri, entityCollection)

A helper function used by custom CZML updater functions which creates or updates a PositionProperty from a CZML packet.
Name Type Description
object Object The object on which the property will be added or updated.
propertyName String The name of the property on the object.
packetData Object The CZML packet being processed.
interval TimeInterval A constraining interval for which the data is valid.
sourceUri String The originating uri of the data being processed.
entityCollection EntityCollection The collection being processsed.
Source: DataSources/CzmlDataSource.js, line 1677

load(czml, source)

Replaces any existing data with the provided CZML.
Name Type Description
czml Object The CZML to be processed.
source String The source URI of the CZML.
Source: DataSources/CzmlDataSource.js, line 1585

loadUrl(url) → Promise

Asynchronously loads the CZML at the provided url, replacing any existing data.
Name Type Description
url Object The url to be processed.
Returns:
a promise that will resolve when the CZML is processed.
Source: DataSources/CzmlDataSource.js, line 1630

process(czml, sourceUri)

Processes the provided CZML without clearing any existing data.
Name Type Description
czml Object The CZML to be processed.
sourceUri String The source URI of the CZML.
Source: DataSources/CzmlDataSource.js, line 1569

processUrl(url) → Promise

Asynchronously processes the CZML at the provided url without clearing any existing data.
Name Type Description
url Object The url to be processed.
Returns:
a promise that will resolve when the CZML is processed.
Source: DataSources/CzmlDataSource.js, line 1604