new ol.Collection(opt_array, opt_options)
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
array |
Array.<T> |
Array. |
||||||
options |
Collection options.
|
|||||||
Fires:
-
add(ol.Collection.Event) - Triggered when an item is added to the collection. -
change(ol.events.Event) - Generic change event. Triggered when the revision counter is increased. -
change:length(ol.Object.Event) -
propertychange(ol.Object.Event) - Triggered when a property is changed. -
remove(ol.Collection.Event) - Triggered when an item is removed from the collection.
Extends
Classes
Observable Properties
| Name | Type | Settable | ol.Object.Event type | Description |
|---|---|---|---|---|
length |
number | no | change:length |
The length of the array. |
Methods
-
Increases the revision counter and dispatches a 'change' event.
-
clear()
src/ol/collection.js, line 65 -
Remove all elements from the collection.
-
Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a
typeproperty.Name Type Description eventObject | ol.events.Event | string Event object.
-
Add elements to the collection. This pushes each item in the provided array to the end of the collection.
Name Type Description arrArray.<T> Array.
Returns:
This collection.
-
forEach(f, opt_this)
src/ol/collection.js, line 97 -
Iterate over each element, calling the provided callback.
Name Type Description ffunction The function to call for every element. This function takes 3 arguments (the element, the index and the array). The return value is ignored.
thisS The object to use as
thisinf. -
Gets a value.
Name Type Description keystring Key name.
Returns:
Value.
-
getArray(){Array.<T>}
src/ol/collection.js, line 114 -
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.
-
getLength(){number}
src/ol/collection.js, line 136 -
Get the length of this collection.
Returns:
The length of the array.
-
Get an object of all property names and values.
Returns:
Object.
-
Get the version number for this object. Each time the object is modified, its version number will be incremented.
Returns:
Revision.
-
insertAt(index, elem)
src/ol/collection.js, line 147 -
Insert an element at the provided index.
Name Type Description indexnumber Index.
elemT Element.
-
item(index){T}
src/ol/collection.js, line 125 -
Get the element at the provided index.
Name Type Description indexnumber Index.
Returns:
Element.
-
on(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited
src/ol/observable.js, line 99 -
Listen for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object to use as
thisinlistener.Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.
-
once(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited
src/ol/observable.js, line 124 -
Listen once for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object to use as
thisinlistener.Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.
-
pop(){T|undefined}
src/ol/collection.js, line 164 -
Remove the last element of the collection and return it. Return
undefinedif the collection is empty.Returns:
Element.
-
push(elem){number}
src/ol/collection.js, line 175 -
Insert the provided element at the end of the collection.
Name Type Description elemT Element.
Returns:
New length of the collection.
-
remove(elem){T|undefined}
src/ol/collection.js, line 191 -
Remove the first occurrence of an element from the collection.
Name Type Description elemT Element.
Returns:
The removed element or undefined if none found.
-
removeAt(index){T|undefined}
src/ol/collection.js, line 210 -
Remove the element at the provided index and return it. Return
undefinedif the collection does not contain this index.Name Type Description indexnumber Index.
Returns:
Value.
-
Sets a value.
Name Type Description keystring Key name.
value* Value.
silentboolean Update without triggering an event.
-
setAt(index, elem)
src/ol/collection.js, line 226 -
Set the element at the provided index.
Name Type Description indexnumber Index.
elemT 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 valuesObject.<string, *> Values.
silentboolean Update without triggering an event.
-
Unlisten for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object which was used as
thisby thelistener. -
Unsets a property.
Name Type Description keystring Key name.
silentboolean Unset without triggering an event.
OpenLayers