new DataSource()
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.
- Source:
- See:
Members
changedEvent :Event
Gets an event that will be raised when the underlying data changes.
Type:
- Source:
clock :DataSourceClock
Gets the preferred clock settings for this data source.
Type:
- Source:
clustering :EntityCluster
Gets or sets the clustering options for this data source. This object can be shared between multiple data sources.
Type:
- Source:
entities :EntityCollection
Gets the collection of
Entity instances.
Type:
- Source:
errorEvent :Event
Gets an event that will be raised if an error is encountered during processing.
Type:
- Source:
isLoading :Boolean
Gets a value indicating if the data source is currently loading data.
Type:
- Boolean
- Source:
loadingEvent :Event
Gets an event that will be raised when the value of isLoading changes.
Type:
- Source:
name :String
Gets a human-readable name for this instance.
Type:
- String
- Source:
show :Boolean
Gets whether or not this data source should be displayed.
Type:
- Boolean
- Source:
Methods
update(time) → {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.
Parameters:
| Name | Type | Description |
|---|---|---|
time |
JulianDate | The simulation time. |
- Source:
Returns:
True if this data source is ready to be displayed at the provided time, false otherwise.
- Type
- Boolean