CzmlDataSource - Cesium Documentation

# CzmlDataSource

#### new CzmlDataSource(name)

  A `DataSource` which processes CZML.

  Name | Type | Description
  --- | --- | ---
  `name` | String | optional An optional name for the data source. This value will be overwritten if a loaded document contains a name.

  ##### Demo:

  - Cesium Sandcastle CZML Demo
  Source: DataSources/CzmlDataSource.js, line 1524

### Members

#### staticCzmlDataSource.updaters :Array

  Gets the array of CZML processing functions.
  Source: DataSources/CzmlDataSource.js, line 1628

#### changedEvent :Event

  Gets an event that will be raised when the underlying data changes.
  Source: DataSources/CzmlDataSource.js, line 1596

#### clock :DataSourceClock

  Gets the clock settings defined by the loaded CZML. If no clock is explicitly defined in the CZML, the combined availability of all objects is returned. If only static data exists, this value is undefined.
  Source: DataSources/CzmlDataSource.js, line 1566

#### entities :EntityCollection

  Gets the collection of `Entity` instances.
  Source: DataSources/CzmlDataSource.js, line 1576

#### errorEvent :Event

  Gets an event that will be raised if an error is encountered during processing.
  Source: DataSources/CzmlDataSource.js, line 1606

#### isLoading :Boolean

  Gets a value indicating if the data source is currently loading data.
  Source: DataSources/CzmlDataSource.js, line 1586

#### loadingEvent :Event

  Gets an event that will be raised when the data source either starts or stops loading.
  Source: DataSources/CzmlDataSource.js, line 1616

#### name :String

  Gets a human-readable name for this instance.
  Source: DataSources/CzmlDataSource.js, line 1554

### Methods

#### staticCzmlDataSource.load(data, options) → Promise.<CzmlDataSource>

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

  Name | Type | Description
  --- | --- | ---
  `data` | String | Object | A url or CZML object to be processed.

  `options`

  Object

  optional An object with the following properties:

  Name | Type | Description
  --- | --- | ---
  `sourceUri` | String | optional Overrides the url to use for resolving relative links.

  ##### Returns:

  A promise that resolves to the new instance once the data is processed.
  Source: DataSources/CzmlDataSource.js, line 1544

#### staticCzmlDataSource.processMaterialPacketData(object, propertyName, packetData, interval, sourceUri, entityCollection)

  A helper function used by custom CZML updater functions which creates or updates a `MaterialProperty` from a CZML packet.

  Name | Type | Description
  --- | --- | ---
  `object` | Object | The object on which the property will be added or updated.
  `propertyName` | String | The name of the property on the object.
  `packetData` | Object | The CZML packet being processed.
  `interval` | TimeInterval | A constraining interval for which the data is valid.
  `sourceUri` | String | The originating uri of the data being processed.
  `entityCollection` | EntityCollection | The collection being processsed.

  Source: DataSources/CzmlDataSource.js, line 1712

#### staticCzmlDataSource.processPacketData(type, object, propertyName, packetData, interval, sourceUri, entityCollection)

  A helper function used by custom CZML updater functions which creates or updates a `Property` from a CZML packet.

  Name | Type | Description
  --- | --- | ---
  `type` | function | The constructor function for the property being processed.
  `object` | Object | The object on which the property will be added or updated.
  `propertyName` | String | The name of the property on the object.
  `packetData` | Object | The CZML packet being processed.
  `interval` | TimeInterval | A constraining interval for which the data is valid.
  `sourceUri` | String | The originating uri of the data being processed.
  `entityCollection` | EntityCollection | The collection being processsed.

  Source: DataSources/CzmlDataSource.js, line 1684

#### staticCzmlDataSource.processPositionPacketData(object, propertyName, packetData, interval, sourceUri, entityCollection)

  A helper function used by custom CZML updater functions which creates or updates a `PositionProperty` from a CZML packet.

  Name | Type | Description
  --- | --- | ---
  `object` | Object | The object on which the property will be added or updated.
  `propertyName` | String | The name of the property on the object.
  `packetData` | Object | The CZML packet being processed.
  `interval` | TimeInterval | A constraining interval for which the data is valid.
  `sourceUri` | String | The originating uri of the data being processed.
  `entityCollection` | EntityCollection | The collection being processsed.

  Source: DataSources/CzmlDataSource.js, line 1698

#### load(czml, options) → Promise.<CzmlDataSource>

  Loads the provided url or CZML object, replacing any existing data.

  Name | Type | Description
  --- | --- | ---
  `czml` | String | Object | A url or CZML object to be processed.

  `options`

  Object

  optional An object with the following properties:

  Name | Type | Description
  --- | --- | ---
  `sourceUri` | String | optional Overrides the url to use for resolving relative links.

  ##### Returns:

  A promise that resolves to this instances once the data is processed.
  Source: DataSources/CzmlDataSource.js, line 1667

#### process(czml, options) → Promise.<CzmlDataSource>

  Processes the provided url or CZML object without clearing any existing data.

  Name | Type | Description
  --- | --- | ---
  `czml` | String | Object | A url or CZML object to be processed.

  `options`

  Object

  optional An object with the following properties:

  Name | Type | Description
  --- | --- | ---
  `sourceUri` | String | optional Overrides the url to use for resolving relative links.

  ##### Returns:

  A promise that resolves to this instances once the data is processed.
  Source: DataSources/CzmlDataSource.js, line 1655