Class: Collection

ol/Collection~Collection 


import Collection from 'ol/Collection';

An expanded version of standard JS Array, adding convenience methods for manipulation. Add and remove changes to the Collection trigger a Collection event. Note that this does not cover changes to the objects within the Collection; they trigger events on the appropriate object, not on the Collection as a whole.

new Collection(opt_array, opt_options)

Collection.js, line 75
Name Type Description
array Array.<T>

Array.
options

Collection options.

Name Type Description
unique boolean (defaults to false)

Disallow the same item from being added to the collection twice.
Fires:

Extends

Observable Properties

Name Type Settable ol/Object.ObjectEvent type Description
length number no change:length

The length of the array.

Methods

changed() inherited

Observable.js, line 70

Increases the revision counter and dispatches a 'change' event.

clear()

Collection.js, line 125

Remove all elements from the collection.

dispatchEvent(event){boolean|undefined} inherited

events/Target.js, line 85

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 type property.

Name Type Description
event module:ol/events/Event~BaseEvent | string

Event object.
Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

extend(arr){module:ol/Collection~Collection.<T>}

Collection.js, line 138

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.

forEach(f)

Collection.js, line 152

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.

get(key){*} inherited

Object.js, line 135

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getArray(){Array.<T>}

Collection.js, line 167

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.

getKeys(){Array.<string>} inherited

Object.js, line 148

Get a list of object property names.

Returns:
List of property names.

getLength(){number}

Collection.js, line 187

Get the length of this collection.

Returns:
The length of the array.

getProperties(){Object.<string, *>} inherited

Object.js, line 157

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 81

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

insertAt(index, elem)

Collection.js, line 197

Insert an element at the provided index.

Name Type Description
index number

Index.
elem T

Element.

item(index){T}

Collection.js, line 177

Get the element at the provided index.

Name Type Description
index number

Index.
Returns:
Element.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 155

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
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){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 167

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
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}

Collection.js, line 214

Remove the last element of the collection and return it. Return undefined if the collection is empty.

Returns:
Element.

push(elem){number}

Collection.js, line 224

Insert the provided element at the end of the collection.

Name Type Description
elem T

Element.
Returns:
New length of the collection.

remove(elem){T|undefined}

Collection.js, line 239

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.

removeAt(index){T|undefined}

Collection.js, line 256

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.

set(key, value, opt_silent) inherited

Object.js, line 203

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean

Update without triggering an event.

setAt(index, elem)

Collection.js, line 272

Set the element at the provided index.

Name Type Description
index number

Index.
elem T

Element.

setProperties(values, opt_silent) inherited

Object.js, line 223

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.

un(type, listener) inherited

Observable.js, line 176

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.

unset(key, opt_silent) inherited

Object.js, line 247

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.