org.cesiumjs.cs.datasources

Class KmlDataSource

java.lang.Object

org.cesiumjs.cs.datasources.KmlDataSource

All Implemented Interfaces:

DataSource

@JsType(isNative=true,
        namespace="Cesium",
        name="KmlDataSource")
public class KmlDataSource
extends Object
implements DataSource

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Event	changedEvent Gets an event that will be raised when the underlying data changes.
DataSourceClock	clock Gets the clock settings defined by the loaded KML.
EntityCluster	clustering Gets or sets the clustering options for this data source.
EntityCollection	entities Gets the collection of Entity instances.
Event	errorEvent Gets an event that will be raised if an error is encountered during processing.
boolean	isLoading Gets a value indicating if the data source is currently loading data.
Event	loadingEvent Gets an event that will be raised when the data source either starts or stops loading.
String	name Gets a human-readable name for this instance.
Event	refreshEvent Gets an event that will be raised when the data source refreshes a network link.
boolean	show Gets whether or not this data source should be displayed.
Event	unsupportedNodeEvent Gets an event that will be raised when the data source finds an unsupported node type.

Constructor Summary

Constructors

Constructor and Description
KmlDataSource(KmlDataSourceOptions options) A DataSource which processes Keyhole Markup Language 2.2 (KML).

Method Summary

Modifier and Type	Method and Description
Promise<KmlDataSource,Void>	load(String data) Creates a Promise to a new instance loaded with the provided KML data.
Promise<KmlDataSource,Void>	load(String data, KmlDataSourceLoadOptions options) Creates a Promise to a new instance loaded with the provided KML data.
static Promise<KmlDataSource,Void>	load(String data, KmlDataSourceLoadStaticOptions options) Creates a Promise to a new instance loaded with the provided KML data.
boolean	update(JulianDate time) Updates the data source to the provided time.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

changedEvent

@JsProperty
public Event changedEvent

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

clock

@JsProperty
public DataSourceClock clock

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

@JsProperty
public EntityCluster clustering

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

entities

@JsProperty
public EntityCollection entities

Gets the collection of Entity instances.

errorEvent

@JsProperty
public Event errorEvent

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

isLoading

@JsProperty
public boolean isLoading

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

loadingEvent

@JsProperty
public Event loadingEvent

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

name

@JsProperty
public String name

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

refreshEvent

@JsProperty
public Event refreshEvent

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

show

@JsProperty
public boolean show

Gets whether or not this data source should be displayed.

unsupportedNodeEvent

@JsProperty
public Event unsupportedNodeEvent

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

Constructor Detail

KmlDataSource

@JsConstructor
public KmlDataSource(KmlDataSourceOptions options)

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 support. 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.

Parameters:

options - Options

See Also:

Open Geospatial Consortium KML Standard, Google KML Documentation

Method Detail

load

@JsMethod
public static Promise<KmlDataSource,Void> load(String data,
                                                         KmlDataSourceLoadStaticOptions options)

Creates a Promise to a new instance loaded with the provided KML data.

Parameters:

data - A url containing binary KMZ data or a parsed KML document.

options - KmlDataSourceLoadStaticOptions

Returns:

A promise that will resolve to a new KmlDataSource instance once the KML is loaded.

load

@JsMethod
public Promise<KmlDataSource,Void> load(String data)

Creates a Promise to a new instance loaded with the provided KML data.

Parameters:

data - A url containing binary KMZ data or a parsed KML document.

Returns:

A promise that will resolve to a new KmlDataSource instance once the KML is loaded.

load

@JsMethod
public Promise<KmlDataSource,Void> load(String data,
                                                  KmlDataSourceLoadOptions options)

Creates a Promise to a new instance loaded with the provided KML data.

Parameters:

data - A url containing binary KMZ data or a parsed KML document.

options - KmlDataSourceLoadStaticOptions

Returns:

A promise that will resolve to a new KmlDataSource instance once the KML is loaded.

update

@JsMethod
public boolean update(JulianDate time)

Description copied from interface: DataSource

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.

Specified by:

update in interface DataSource

Parameters:

time - The simulation time.

Returns:

True if this data source is ready to be displayed at the provided time, false otherwise.