CzmlDataSource

Members

changedEvent :Event

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

clock :DynamicClock

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.

dynamicObjects :DynamicObjectCollection

Gets the collection of DynamicObject 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.

<static> updaters :Array

Gets the array of CZML processing functions.

Methods

<static> processMaterialPacketData

A helper function used by custom CZML updater functions which creates or updates a MaterialProperty from a CZML packet.

Parameters:

Name	Type	Argument	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.y
interval	TimeInterval	<optional>	A constraining interval for which the data is valid.
sourceUri	String	<optional>	The originating uri of the data being processed.

Returns:

Boolean True if a new property was created, false otherwise.

<static> processPacketData

A helper function used by custom CZML updater functions which creates or updates a Property from a CZML packet.

Parameters:

Name	Type	Argument	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.y
interval	TimeInterval	<optional>	A constraining interval for which the data is valid.
sourceUri	String	<optional>	The originating uri of the data being processed.

Returns:

Boolean True if a new property was created, false otherwise.

<static> processPositionPacketData

A helper function used by custom CZML updater functions which creates or updates a PositionProperty from a CZML packet.

Parameters:

Name	Type	Argument	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.y
interval	TimeInterval	<optional>	A constraining interval for which the data is valid.
sourceUri	String	<optional>	The originating uri of the data being processed.

Returns:

Boolean True if a new property was created, false otherwise.

<static> prototype.load

Replaces any existing data with the provided CZML.

Parameters:

Name	Type	Description
czml	Object	The CZML to be processed.
source	String	The source URI of the CZML.

<static> prototype.loadUrl

Asynchronously loads the CZML at the provided url, replacing any existing data.

Parameters:

Name	Type	Description
url	Object	The url to be processed.

Returns:

Promise a promise that will resolve when the CZML is processed.

<static> prototype.process

Processes the provided CZML without clearing any existing data.

Parameters:

Name	Type	Description
czml	Object	The CZML to be processed.
sourceUri	String	The source URI of the CZML.

<static> prototype.processUrl

Asynchronously processes the CZML at the provided url without clearing any existing data.

Parameters:

Name	Type	Description
url	Object	The url to be processed.

Returns:

Promise a promise that will resolve when the CZML is processed.