kotlin-cesium-engine/cesium.engine/DataSource

DataSource

abstract external class DataSource(source)

Defines the interface for data sources, which turn arbitrary data into a EntityCollection for generic consumption. This object is an interface for documentation purposes and is not intended to be instantiated directly.

See also

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
abstract var changedEvent: DefaultEvent

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

Link copied to clipboard
abstract var clock: DataSourceClock

Gets the preferred clock settings for this data source.

Link copied to clipboard
abstract var clustering: EntityCluster

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

Link copied to clipboard
abstract var entities: EntityCollection

Gets the collection of Entity instances.

Link copied to clipboard
abstract var errorEvent: Event<(arg1: RequestErrorEvent) -> Unit>

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

Link copied to clipboard
abstract var isLoading: Boolean

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

Link copied to clipboard
abstract var loadingEvent: Event<(arg1: Boolean) -> Unit>

Gets an event that will be raised when the value of isLoading changes.

Link copied to clipboard
abstract var name: String

Gets a human-readable name for this instance.

Link copied to clipboard
abstract var show: Boolean

Gets whether or not this data source should be displayed.

Functions

Link copied to clipboard
abstract fun update(time: JulianDate): 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.