CzmlDataSource

new Ditap.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:

Members

static Ditap.CzmlDataSource.updaters : Array.<CzmlDataSource.UpdaterFunction>

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.

clustering : EntityCluster

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

credit : Credit

Gets the credit that will be displayed for the data source

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.

show : boolean

Gets whether or not this data source should be displayed.

Methods

static Ditap.CzmlDataSource.load(czml, options) → Promise.<CzmlDataSource>

Creates a Promise to a new instance loaded with the provided CZML data.
Name Type Description
czml Resource | string | object A url or CZML object to be processed.
options CzmlDataSource.LoadOptions optional An object specifying configuration options
Returns:
A promise that resolves to the new instance once the data is processed.

static Ditap.CzmlDataSource.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.

static Ditap.CzmlDataSource.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.

static Ditap.CzmlDataSource.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(czml, options) → Promise.<CzmlDataSource>

Loads the provided url or CZML object, replacing any existing data.
Name Type Description
czml Resource | string | object A url or CZML object to be processed.
options CzmlDataSource.LoadOptions optional An object specifying configuration options
Returns:
A promise that resolves to this instances once the data is processed.

process(czml, options) → Promise.<CzmlDataSource>

Processes the provided url or CZML object without clearing any existing data.
Name Type Description
czml Resource | string | object A url or CZML object to be processed.
options CzmlDataSource.LoadOptions optional An object specifying configuration options
Returns:
A promise that resolves to this instances once the data is processed.

update(time) → 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.
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.

Type Definitions

Ditap.CzmlDataSource.LoadOptions

Initialization options for the load method.
Properties:
Name Type Attributes Description
sourceUri Resource | string <optional>
 Overrides the url to use for resolving relative links.
credit Credit | string <optional>
 A credit for the data source, which is displayed on the canvas.

Ditap.CzmlDataSource.UpdaterFunction(entity, packet, entityCollection, sourceUri)

Name Type Description
entity Entity
packet object
entityCollection EntityCollection
sourceUri string
packages/engine
packages/widgets