Class: CompositeEntityCollection

CompositeEntityCollection

new CompositeEntityCollection(collectionsopt, owneropt)

Non-destructively composites multiple EntityCollection instances into a single collection. If a Entity with the same ID exists in multiple collections, it is non-destructively merged into a single new entity instance. If an entity has the same property in multiple collections, the property of the Entity in the last collection of the list it belongs to is used. CompositeEntityCollection can be used almost anywhere that a EntityCollection is used.
Parameters:
Name Type Attributes Description
collections Array.<EntityCollection> <optional>
 The initial list of EntityCollection instances to merge.
owner DataSource | CompositeEntityCollection <optional>
 The data source (or composite entity collection) which created this collection.
Source:

Members

(readonly) collectionChanged :Event

Gets the event that is fired when entities are added or removed from the collection. The generated event is a EntityCollection.collectionChangedEventCallback.
Type:
Source:

(readonly) id :String

Gets a globally unique identifier for this collection.
Type:
  • String
Source:

(readonly) owner :DataSource|CompositeEntityCollection

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

(readonly) values :Array.<Entity>

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

Methods

addCollection(collection, indexopt)

Adds a collection to the composite.
Parameters:
Name Type Attributes Description
collection EntityCollection the collection to add.
index Number <optional>
 the index to add the collection at. If omitted, the collection will added on top of all existing collections.
Source:
Throws:
index, if supplied, must be greater than or equal to zero and less than or equal to the number of collections.
Type
DeveloperError

computeAvailability() → {TimeInterval}

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.
Source:
Returns:
The availability of entities in the collection.
Type
TimeInterval

contains(entity) → {Boolean}

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

containsCollection(collection) → {Boolean}

Checks to see if the composite contains a given collection.
Parameters:
Name Type Description
collection EntityCollection the collection to check for.
Source:
Returns:
true if the composite contains the collection, false otherwise.
Type
Boolean

getById(id) → {Entity}

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

getCollection(index)

Gets a collection by index from the composite.
Parameters:
Name Type Description
index Number the index to retrieve.
Source:

getCollectionsLength()

Gets the number of collections in this composite.
Source:

indexOfCollection(collection) → {Number}

Determines the index of a given collection in the composite.
Parameters:
Name Type Description
collection EntityCollection The collection to find the index of.
Source:
Returns:
The index of the collection in the composite, or -1 if the collection does not exist in the composite.
Type
Number

lowerCollection(collection)

Lowers a collection down one position in the composite.
Parameters:
Name Type Description
collection EntityCollection the collection to move.
Source:
Throws:
collection is not in this composite.
Type
DeveloperError

lowerCollectionToBottom(collection)

Lowers a collection to the bottom of the composite.
Parameters:
Name Type Description
collection EntityCollection the collection to move.
Source:
Throws:
collection is not in this composite.
Type
DeveloperError

raiseCollection(collection)

Raises a collection up one position in the composite.
Parameters:
Name Type Description
collection EntityCollection the collection to move.
Source:
Throws:
collection is not in this composite.
Type
DeveloperError

raiseCollectionToTop(collection)

Raises a collection to the top of the composite.
Parameters:
Name Type Description
collection EntityCollection the collection to move.
Source:
Throws:
collection is not in this composite.
Type
DeveloperError

removeAllCollections()

Removes all collections from this composite.
Source:

removeCollection(collection) → {Boolean}

Removes a collection from this composite, if present.
Parameters:
Name Type Description
collection EntityCollection The collection to remove.
Source:
Returns:
true if the collection was in the composite and was removed, false if the collection was not in the composite.
Type
Boolean

resumeEvents()

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 also ensures the collection is recomposited if events are also resumed. This function is reference counted and can safely be called multiple times as long as there are corresponding calls to EntityCollection#resumeEvents.
Source:
Throws:
resumeEvents can not be called before suspendEvents.
Type
DeveloperError

suspendEvents()

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. While events are suspended, recompositing of the collections will also be suspended, as this can be a costly operation. This function can be safely called multiple times as long as there are corresponding calls to EntityCollection#resumeEvents.
Source: