kotlin-cesium-engine/cesium.engine/DataSourceCollection

DataSourceCollection

external class DataSourceCollection(source)

A collection of DataSource instances.

Constructors

constructor()

Properties

dataSourceAdded

val dataSourceAdded: DefaultEvent

An event that is raised when a data source is added to the collection. Event handlers are passed the data source that was added.

dataSourceMoved

val dataSourceMoved: DefaultEvent

An event that is raised when a data source changes position in the collection. Event handlers are passed the data source that was moved, its new index after the move, and its old index prior to the move.

dataSourceRemoved

val dataSourceRemoved: DefaultEvent

An event that is raised when a data source is removed from the collection. Event handlers are passed the data source that was removed.

length

val length: Int

Gets the number of data sources in this collection.

Functions

add

suspend fun add(dataSource: DataSource): DataSource

Adds a data source to the collection.

suspend fun add(dataSource: Promise<DataSource>): DataSource

addAsync

fun addAsync(dataSource: DataSource): Promise<DataSource>

fun addAsync(dataSource: Promise<DataSource>): Promise<DataSource>

contains

fun contains(dataSource: DataSource): Boolean

Checks to see if the collection contains a given data source.

destroy

fun destroy()

Destroys the resources held by all data sources in this collection. Explicitly destroying this object allows for deterministic release of WebGL resources, instead of relying on the garbage collector. Once this object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.

get

operator fun get(index: Int): DataSource

Gets a data source by index from the collection.

getByName

fun getByName(name: String): ReadonlyArray<DataSource>

Gets a data source by name from the collection.

indexOf

fun indexOf(dataSource: DataSource): Int

Determines the index of a given data source in the collection.

isDestroyed

fun isDestroyed(): Boolean

Returns true if this object was destroyed; otherwise, false. If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

lower

fun lower(dataSource: DataSource)

Lowers a data source down one position in the collection.

lowerToBottom

fun lowerToBottom(dataSource: DataSource)

Lowers a data source to the bottom of the collection.

raise

fun raise(dataSource: DataSource)

Raises a data source up one position in the collection.

raiseToTop

fun raiseToTop(dataSource: DataSource)

Raises a data source to the top of the collection.