CzmlDataSource

external class CzmlDataSource(var name: String = definedExternally)(source)

A DataSource which processes CZML.

See also

Constructors

Link copied to clipboard
constructor(name: String = definedExternally)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Gets the credit that will be displayed for the data source

Link copied to clipboard

Gets the collection of Entity instances.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

An optional name for the data source. This value will be overwritten if a loaded document contains a name.

Link copied to clipboard

Gets whether or not this data source should be displayed.

Functions

Link copied to clipboard
suspend fun load(czml: Resource, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): CzmlDataSource

Loads the provided url or CZML object, replacing any existing data.

suspend fun load(czml: Any, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): CzmlDataSource
suspend fun load(czml: String, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): CzmlDataSource
Link copied to clipboard
fun loadAsync(czml: Any, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): Promise<CzmlDataSource>
fun loadAsync(czml: String, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): Promise<CzmlDataSource>
Link copied to clipboard
suspend fun process(czml: Resource, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): CzmlDataSource

Processes the provided url or CZML object without clearing any existing data.

suspend fun process(czml: Any, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): CzmlDataSource
suspend fun process(czml: String, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): CzmlDataSource
Link copied to clipboard
Link copied to clipboard

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.