EntityCollection

new Cesium.EntityCollection(owner)
DataSources/EntityCollection.js 56

An observable collection of Entity instances where each entity has a unique id.
Name Type Description
owner DataSource | CompositeEntityCollection optional The data source (or composite entity collection) which created this collection.

Members

readonly collectionChanged : Event.<EntityCollection.CollectionChangedEventCallback>
DataSources/EntityCollection.js 122

Gets the event that is fired when entities are added or removed from the collection. The generated event is a EntityCollection.CollectionChangedEventCallback.

readonly id : String
DataSources/EntityCollection.js 133

Gets a globally unique identifier for this collection.

readonly owner : DataSource|CompositeEntityCollection
DataSources/EntityCollection.js 211

Gets the owner of this entity collection, ie. the data source or composite entity collection which created it.

show : Boolean
DataSources/EntityCollection.js 157

Gets whether or not this entity collection should be displayed. When true, each entity is only displayed if its own show property is also true.

readonly values : Array.<Entity>
DataSources/EntityCollection.js 145

Gets the array of Entity instances in the collection. This array should not be modified directly.

Methods

add(entity) → Entity
DataSources/EntityCollection.js 270

Add an entity to the collection.
Name Type Description
entity Entity | Entity.ConstructorOptions The entity to be added.
Returns:
The entity that was added.
Throws:

computeAvailability() → TimeInterval
DataSources/EntityCollection.js 226

Computes the maximum availability of the entities in the collection. If the collection contains a mix of infinitely available data and non-infinite data, it will return the interval pertaining to the non-infinite data only. If all data is infinite, an infinite interval will be returned.
Returns:
The availability of entities in the collection.

contains(entity) → Boolean
DataSources/EntityCollection.js 323

Returns true if the provided entity is in this collection, false otherwise.
Name Type Description
entity Entity The entity.
Returns:
true if the provided entity is in this collection, false otherwise.

getById(id) → Entity|undefined
DataSources/EntityCollection.js 401

Gets an entity with the specified id.
Name Type Description
id String The id of the entity to retrieve.
Returns:
The entity with the provided id or undefined if the id did not exist in the collection.

getOrCreateEntity(id) → Entity
DataSources/EntityCollection.js 417

Gets an entity with the specified id or creates it and adds it to the collection if it does not exist.
Name Type Description
id String The id of the entity to retrieve or create.
Returns:
The new or existing object.

remove(entity) → Boolean
DataSources/EntityCollection.js 310

Removes an entity from the collection.
Name Type Description
entity Entity The entity to be removed.
Returns:
true if the item was removed, false if it did not exist in the collection.

removeAll()
DataSources/EntityCollection.js 366

Removes all Entities from the collection.

removeById(id) → Boolean
DataSources/EntityCollection.js 338

Removes an entity with the provided id from the collection.
Name Type Description
id String The id of the entity to remove.
Returns:
true if the item was removed, false if no item with the provided id existed in the collection.

resumeEvents()
DataSources/EntityCollection.js 91

Resumes raising EntityCollection#collectionChanged events immediately when an item is added or removed. Any modifications made while while events were suspended will be triggered as a single event when this function is called. This function is reference counted and can safely be called multiple times as long as there are corresponding calls to EntityCollection#resumeEvents.
Throws:
  • DeveloperError : resumeEvents can not be called before suspendEvents.

suspendEvents()
DataSources/EntityCollection.js 78

Prevents EntityCollection#collectionChanged events from being raised until a corresponding call is made to EntityCollection#resumeEvents, at which point a single event will be raised that covers all suspended operations. This allows for many items to be added and removed efficiently. This function can be safely called multiple times as long as there are corresponding calls to EntityCollection#resumeEvents.

Type Definitions

Cesium.EntityCollection.CollectionChangedEventCallback(collection, added, removed, changed)
DataSources/EntityCollection.js 104

The signature of the event generated by EntityCollection#collectionChanged.
Name Type Description
collection EntityCollection The collection that triggered the event.
added Array.<Entity> The array of Entity instances that have been added to the collection.
removed Array.<Entity> The array of Entity instances that have been removed from the collection.
changed Array.<Entity> The array of Entity instances that have been modified.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.