Name | Type | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
array |
Array.<T> |
Array. |
||||||||
options |
Collection options.
|
Fires:
-
add
(module:ol/Collection.CollectionEvent) - Triggered when an item is added to the collection. -
change
(module:ol/events/Event~Event) - Generic change event. Triggered when the revision counter is increased. -
change:length
(module:ol/Object.ObjectEvent) -
propertychange
(module:ol/Object.ObjectEvent) - Triggered when a property is changed. -
remove
(module:ol/Collection.CollectionEvent) - Triggered when an item is removed from the collection.
Extends
Observable Properties
Name | Type | Settable | ol/Object.ObjectEvent type | Description |
---|---|---|---|---|
length |
number | no | change:length |
The length of the array. |
Methods
-
Remove all elements from the collection.
-
Add elements to the collection. This pushes each item in the provided array to the end of the collection.
Name Type Description arr
Array.<T> Array.
Returns:
This collection.
-
Iterate over each element, calling the provided callback.
Name Type Description f
function The function to call for every element. This function takes 3 arguments (the element, the index and the array). The return value is ignored.
-
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
Get a reference to the underlying Array object. Warning: if the array is mutated, no events will be dispatched by the collection, and the collection's "length" property won't be in sync with the actual length of the array.
Returns:
Array.
-
Get a list of object property names.
Returns:
List of property names.
-
Get the length of this collection.
Returns:
The length of the array.
-
Get an object of all property names and values.
Returns:
Object.
-
Insert an element at the provided index.
Name Type Description index
number Index.
elem
T Element.
-
Get the element at the provided index.
Name Type Description index
number Index.
Returns:
Element.
-
Remove the last element of the collection and return it. Return
undefined
if the collection is empty.Returns:
Element.
-
Insert the provided element at the end of the collection.
Name Type Description elem
T Element.
Returns:
New length of the collection.
-
Remove the first occurrence of an element from the collection.
Name Type Description elem
T Element.
Returns:
The removed element or undefined if none found.
-
Remove the element at the provided index and return it. Return
undefined
if the collection does not contain this index.Name Type Description index
number Index.
Returns:
Value.
-
Sets a value.
Name Type Description key
string Key name.
value
* Value.
silent
boolean Update without triggering an event.
-
Set the element at the provided index.
Name Type Description index
number Index.
elem
T Element.
-
Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).
Name Type Description values
Object.<string, *> Values.
silent
boolean Update without triggering an event.
-
Unsets a property.
Name Type Description key
string Key name.
silent
boolean Unset without triggering an event.