Visualizes a collection of
DataSource instances.
| Name | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
Object with the following properties:
|
Members
Gets the collection of data sources to display.
defaultDataSource : CustomDataSource
Gets the default data source instance which can be used to
manually create and visualize entities not tied to
a specific data source. This instance is always available
and does not appear in the list dataSources collection.
Gets a value indicating whether or not all entities in the data source are ready
Gets the scene associated with this display.
Methods
Gets or sets the default function which creates an array of visualizers used for visualization.
By default, this function uses all standard visualizers.
Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
release of WebGL resources, instead of relying on the garbage collector to destroy this object.
Once an object is destroyed, it should not be used; calling any function other than
Once an 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.
Throws:
-
DeveloperError : This object was destroyed, i.e., destroy() was called.
Example:
dataSourceDisplay = dataSourceDisplay.destroy();See:
getSensor(entity) → Sensor|undefined
Gets the unified
Sensor created for the specified entity.
The returned sensor is owned by the entity's SensorVisualizer; the
caller must not destroy it. This returns undefined when the entity is not in
the default or a registered data source, before an update creates its
sensor, when it has no sensor visualization, or while a compatible conic
sensor is rendered by the instanced batch.
| Name | Type | Description |
|---|---|---|
entity |
Entity | The entity whose sensor to retrieve. |
Returns:
The entity's current unified sensor, or undefined
when it does not currently have an individual sensor.
Returns true if this object was destroyed; otherwise, false.
If this object was destroyed, it should not be used; calling any function other than
If this object was destroyed, it should not be used; calling any function other than
isDestroyed will result in a DeveloperError exception.
Returns:
True if this object was destroyed; otherwise, false.
Updates the display to the provided time.
| Name | Type | Description |
|---|---|---|
time |
JulianDate | The simulation time. |
Returns:
True if all data sources are ready to be displayed, false otherwise.
Type Definitions
Cesium.DataSourceDisplay.VisualizersCallback(scene, entityCluster, dataSource) → Array.<Visualizer>
A function which creates an array of visualizers used for visualization.
| Name | Type | Description |
|---|---|---|
scene |
Scene | The scene to create visualizers for. |
entityCluster |
EntityCluster | The entity cluster to create visualizers for. |
dataSource |
DataSource | The data source to create visualizers for. |
Returns:
An array of visualizers used for visualization.
Example:
function createVisualizers(scene, entityCluster, dataSource) {
return [new Cesium.BillboardVisualizer(entityCluster, dataSource.entities)];
}