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. |
Members
-
staticCzmlDataSource.updaters :Array
-
Gets the array of CZML processing functions.
-
changedEvent :Event
-
Gets an event that will be raised when the underlying data changes.
-
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.
-
entities :EntityCollection
-
Gets the collection of
Entity
instances. -
errorEvent :Event
-
Gets an event that will be raised if an error is encountered during processing.
-
isLoading :Boolean
-
Gets a value indicating if the data source is currently loading data.
-
loadingEvent :Event
-
Gets an event that will be raised when the data source either starts or stops loading.
-
name :String
-
Gets a human-readable name for this instance.
Methods
-
staticCzmlDataSource.load(data, options) → Promise
-
Creates a Promise to a new instance loaded with the provided CZML data.
Name Type Description data
String | Object A url or CZML object to be processed. options
Object optional An object with the following properties: Name Type Description sourceUri
String optional Overrides the url to use for resolving relative links. Returns:
A promise that resolves to the new instance once the data is processed. -
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. -
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. -
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. -
load(data, options) → Promise
-
Loads the provided url or CZML object, replacing any existing data.
Name Type Description data
String | Object A url or CZML object to be processed. options
Object optional An object with the following properties: Name Type Description sourceUri
String optional Overrides the url to use for resolving relative links. Returns:
A promise that resolves to this instances once the data is processed. -
process(data, options) → Promise
-
Processes the provided url or CZML object without clearing any existing data.
Name Type Description data
String | Object A url or CZML object to be processed. options
Object optional An object with the following properties: Name Type Description sourceUri
String optional Overrides the url to use for resolving relative links. Returns:
A promise that resolves to this instances once the data is processed.