Class: Collection

Extends

• ol.Object

Observable Properties

Name	Type	Settable	ol.ObjectEvent type	Description
length	number	no	change:length	The length of the array.

Methods

experimental inherited bindTo(key, target, opt_targetKey){ol.ObjectAccessor}

src/ol/object.js, line 247

The bindTo method allows you to set up a two-way binding between a source and target object. The method returns an ol.ObjectAccessor with a transform method that lets you transform values on the way from the source to the target and on the way back.

For example, if you had two map views (sourceView and targetView) and you wanted the target view to have double the resolution of the source view, you could transform the resolution on the way to and from the target with the following:

sourceView.bindTo('resolution', targetView)
  .transform(
    function(sourceResolution) {
      // from sourceView.resolution to targetView.resolution
      return 2 * sourceResolution;
    },
    function(targetResolution) {
      // from targetView.resolution to sourceView.resolution
      return targetResolution / 2;
    }
  );

Name	Type	Argument	Description
key	string		Key name.
target	ol.Object		Target.
targetKey	string	<optional>	optional Target key.

experimental clear()

src/ol/collection.js, line 94

Remove all elements from the collection.

experimental inherited dispatchChangeEvent()

src/ol/observable.js, line 39

Dispatches a change event. Register a listener for this event to get notified of changes.

Fires:

• change

experimental extend(arr){ol.Collection}

src/ol/collection.js, line 106

Name	Type	Description
arr	Array	Array.

Returns:

collection.

experimental forEach(f, opt_this)

src/ol/collection.js, line 124

Iterate over each element, calling the provided callback.

Name	Type	Argument	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.
this	S	<optional>	optional The object to use as this in f.

experimental inherited get(key){*}

src/ol/object.js, line 304

Gets a value.

Name	Type	Description
key	string	Key name.

experimental getArray(){Array}

src/ol/collection.js, line 137

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.

experimental getAt(index){*}

src/ol/collection.js, line 148

Get the element at the provided index.

Name	Type	Description
index	number	Index.

experimental inherited getKeys(){Array.<string>}

src/ol/object.js, line 332

Get a list of object property names.

Returns:

of property names.

experimental getLength(){number}

src/ol/collection.js, line 159

Get the length of this collection.

Returns:

length of the array.

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

src/ol/object.js, line 364

Get an object of all property names and values.

experimental insertAt(index, elem)

src/ol/collection.js, line 170

Insert an element at the provided index.

Name	Type	Description
index	number	Index.
elem	*	Element.

experimental inherited notify(key)

src/ol/object.js, line 384

Notify all observers of a change on this property. This notifies both objects that are bound to the object's property as well as the object that it is bound to.

Name	Type	Description
key	string	Key name.

experimental inherited on(type, listener, opt_this){goog.events.Key}

src/ol/observable.js, line 61

Listen for a certain type of event.

Name	Type	Argument	Description
type	string | Array.<string>		The event type or array of event types.
listener	function		The listener function.
this	Object	<optional>	optional The object to use as this in listener.

Returns:

key for the listener.

experimental inherited once(type, listener, opt_this){goog.events.Key}

src/ol/observable.js, line 74

Listen once for a certain type of event.

Name	Type	Argument	Description
type	string | Array.<string>		The event type or array of event types.
listener	function		The listener function.
this	Object	<optional>	optional The object to use as this in listener.

Returns:

key for the listener.

experimental pop(){*}

src/ol/collection.js, line 183

Remove the last element of the collection.

experimental push(elem){number}

src/ol/collection.js, line 194

Insert the provided element at the end of the collection.

Name	Type	Description
elem	*	Element.

experimental remove(elem){*}

src/ol/collection.js, line 207

Removes the first occurence of elem from the collection.

Name	Type	Description
elem	*	Element.

Returns:

removed element or undefined if elem was not found.

experimental removeAt(index){*}

src/ol/collection.js, line 225

Remove the element at the provided index.

Name	Type	Description
index	number	Index.

experimental inherited set(key, value)

src/ol/object.js, line 415

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.

experimental setAt(index, elem)

src/ol/collection.js, line 241

Set the element at the provided index.

Name	Type	Description
index	number	Index.
elem	*	Element.

experimental inherited setValues(values)

src/ol/object.js, line 444

Sets a collection of key-value pairs.

Name	Type	Description
values	Object.<string, *>	Values.

experimental inherited un(type, listener, opt_this)

src/ol/observable.js, line 86

Unlisten for a certain type of event.

Name	Type	Argument	Description
type	string | Array.<string>		The event type or array of event types.
listener	function		The listener function.
this	Object	<optional>	optional The object to use as this in listener.

experimental inherited unbind(key)

src/ol/object.js, line 458

Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.

Name	Type	Description
key	string	Key name.

experimental inherited unbindAll()

src/ol/object.js, line 482

Removes all bindings.

experimental inherited unByKey(key)

src/ol/observable.js, line 96

Removes an event listener using the key returned by on() or once().

Name	Type	Description
key	goog.events.Key	Key.