kotlin-cesium-engine/cesium.engine/KmlDataSource

KmlDataSource

external class KmlDataSource(options: KmlDataSource.ConstructorOptions? = definedExternally)(source)

A DataSource which processes Keyhole Markup Language 2.2 (KML).

KML support in Cesium is incomplete, but a large amount of the standard, as well as Google's gx extension namespace, is supported. See Github issue #873 for a detailed list of what is and isn't supported. Cesium will also write information to the console when it encounters most unsupported features.

Non visual feature data, such as atom:author and ExtendedData is exposed via an instance of KmlFeatureData, which is added to each Entity under the kml property.

const viewer = new Viewer('cesiumContainer');
viewer.dataSources.add(KmlDataSource.load('../../SampleData/facilities.kmz',
     {
          camera: viewer.scene.camera,
          canvas: viewer.scene.canvas
     })
);

Constructors

KmlDataSource

constructor(options: KmlDataSource.ConstructorOptions? = definedExternally)

Types

Companion

object Companion

ConstructorOptions

sealed interface ConstructorOptions

Options for constructing a new KmlDataSource, or calling the static load method.

Properties

camera

var camera: Camera?

The position and orientation of this Camera will be used to populate various camera parameters when making network requests. Camera movement will determine when to trigger NetworkLink refresh if viewRefreshMode is onStop.

canvas

var canvas: HTMLCanvasElement?

The current size of this Canvas will be used to populate the Link parameters for client height and width.

changedEvent

var changedEvent: DefaultEvent

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

clock

var clock: DataSourceClock

Gets the clock settings defined by the loaded KML. This represents the total availability interval for all time-dynamic data. If the KML does not contain time-dynamic data, this value is undefined.

clustering

var clustering: EntityCluster

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

credit

var credit: Credit

Gets the credit that will be displayed for the data source

entities

var entities: EntityCollection

Gets the collection of Entity instances.

errorEvent

var errorEvent: DefaultEvent

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

isLoading

var isLoading: Boolean

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

kmlTours

var kmlTours: ReadonlyArray<KmlTour>

Gets the KML Tours that are used to guide the camera to specified destinations on given time intervals.

loadingEvent

var loadingEvent: DefaultEvent

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

name

var name: String

Gets or sets a human-readable name for this instance. This will be automatically be set to the KML document name on load.

refreshEvent

var refreshEvent: DefaultEvent

Gets an event that will be raised when the data source refreshes a network link.

show

var show: Boolean

Gets whether or not this data source should be displayed.

unsupportedNodeEvent

var unsupportedNodeEvent: DefaultEvent

Gets an event that will be raised when the data source finds an unsupported node type.

Functions

destroy

fun destroy()

Cleans up any non-entity elements created by the data source. Currently this only affects ScreenOverlay elements.

load

suspend fun load(data: Resource, options: KmlDataSource.Companion.LoadOptions? = definedExternally): KmlDataSource

Asynchronously loads the provided KML data, replacing any existing data.

suspend fun load(data: String, options: KmlDataSource.Companion.LoadOptions? = definedExternally): KmlDataSource

suspend fun load(data: Blob, options: KmlDataSource.Companion.LoadOptions? = definedExternally): KmlDataSource

suspend fun load(data: Document, options: KmlDataSource.Companion.LoadOptions? = definedExternally): KmlDataSource

loadAsync

fun loadAsync(data: Resource, options: KmlDataSource.Companion.LoadOptions? = definedExternally): Promise<KmlDataSource>

fun loadAsync(data: String, options: KmlDataSource.Companion.LoadOptions? = definedExternally): Promise<KmlDataSource>

fun loadAsync(data: Blob, options: KmlDataSource.Companion.LoadOptions? = definedExternally): Promise<KmlDataSource>

fun loadAsync(data: Document, options: KmlDataSource.Companion.LoadOptions? = definedExternally): Promise<KmlDataSource>

update

fun update(time: JulianDate): Boolean

Updates any NetworkLink that require updating.

KmlDataSource

See also

Constructors

Types

Properties

Functions