new CompositeDynamicObjectCollection(collections)
Non-destructively composites multiple
DynamicObjectCollection instances into a single collection.
If a DynamicObject with the same ID exists in multiple collections, it is non-destructively
merged into a single new object instance. If an object has the same property in multiple
collections, the property of the DynamicObject in the last collection of the list it
belongs to is used. CompositeDynamicObjectCollection can be used almost anywhere that a
DynamicObjectCollection is used.
| Name | Type | Description |
|---|---|---|
collections |
DynamicObjectCollection[] | optional The initial list of DynamicObjectCollection instances to merge. |
Members
-
collectionChanged :Event
-
Gets the event that is fired when objects are added or removed from the collection. The generated event is a
DynamicObjectCollection.collectionChangedEventCallback. -
id :String
-
Gets a globally unique identifier for this collection.
Methods
-
addCollection(collection, index)
-
Adds a collection to the composite.
Name Type Description collectionDynamicObjectCollection the collection to add. indexNumber optional the index to add the collection at. If omitted, the collection will added on top of all existing collections. Throws:
-
DeveloperError : index, if supplied, must be greater than or equal to zero and less than or equal to the number of collections.
-
-
computeAvailability() → TimeInterval
-
Computes the maximum availability of the DynamicObjects 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 DynamicObjects in the collection. -
containsCollection(collection) → Boolean
-
Checks to see if the composite contains a given collection.
Name Type Description collectionDynamicObjectCollection the collection to check for. Returns:
true if the composite contains the collection, false otherwise. -
getById(id) → DynamicObject
-
Gets an object with the specified id.
Name Type Description idObject The id of the object to retrieve. Returns:
The object with the provided id or undefined if the id did not exist in the collection. -
getCollection(index)
-
Gets a collection by index from the composite.
Name Type Description indexNumber the index to retrieve. -
getCollectionsLength()
-
Gets the number of collections in this composite.
-
getObjects() → DynamicObject[]
-
Gets the array of DynamicObject instances in the collection. The array should not be modified directly.
Returns:
the array of DynamicObject instances in the collection. -
indexOfCollection(collection) → Number
-
Determines the index of a given collection in the composite.
Name Type Description collectionDynamicObjectCollection The collection to find the index of. Returns:
The index of the collection in the composite, or -1 if the collection does not exist in the composite. -
lowerCollection(collection)
-
Lowers a collection down one position in the composite.
Name Type Description collectionDynamicObjectCollection the collection to move. Throws:
-
DeveloperError : collection is not in this composite.
-
-
lowerCollectionToBottom(collection)
-
Lowers a collection to the bottom of the composite.
Name Type Description collectionDynamicObjectCollection the collection to move. Throws:
-
DeveloperError : collection is not in this composite.
-
-
raiseCollection(collection)
-
Raises a collection up one position in the composite.
Name Type Description collectionDynamicObjectCollection the collection to move. Throws:
-
DeveloperError : collection is not in this composite.
-
-
raiseCollectionToTop(collection)
-
Raises a collection to the top of the composite.
Name Type Description collectionDynamicObjectCollection the collection to move. Throws:
-
DeveloperError : collection is not in this composite.
-
-
removeAllCollections()
-
Removes all collections from this composite.
-
removeCollection(collection) → Boolean
-
Removes a collection from this composite, if present.
Name Type Description collectionDynamicObjectCollection The collection to remove. Returns:
true if the collection was in the composite and was removed, false if the collection was not in the composite. -
resumeEvents()
-
Resumes raising
DynamicObjectCollection#collectionChangedevents 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 toDynamicObjectCollection#resumeEvents.Throws:
-
DeveloperError : resumeEvents can not be called before suspendEvents.
-
-
suspendEvents()
-
Prevents
DynamicObjectCollection#collectionChangedevents from being raised until a corresponding call is made toDynamicObjectCollection#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 toDynamicObjectCollection#resumeEvents.