ol. ol.Collection

new Collection

A mutable MVC Array.

Parameters:
Name Type Argument Description
array Array <optional>
(Optional)

Array.

Source:
  • collection.js, line 61

Extends

Methods

bindTo

Binds a View to a Model.

Parameters:
Name Type Argument Description
key string

Key.

target ol.Object

Target.

targetKey string <optional>
(Optional)

Target key.

noNotify boolean <optional>
(Optional)

No notify.

Inherited From:
Source:
  • object.js, line 147

clear

Remove all elements from the collection.

Source:
  • collection.js, line 80

forEach

Iterate over each element, calling the provided callback.

Parameters:
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.

obj Object <optional>
(Optional)

The object to be used as the value of 'this' within f.

Source:
  • collection.js, line 106

get

Gets a value.

Parameters:
Name Type Description
key string

Key.

Inherited From:
Source:
  • object.js, line 170
Returns:

Value.

Type
*

getAt

Get the element at the provided index.

Parameters:
Name Type Description
index number

Index.

Source:
  • collection.js, line 124
Returns:

Element.

Type
*

getLength

Get the length of this collection.

Source:
  • collection.js, line 133
Returns:

Length.

Type
number

insertAt

Insert an element at the provided index.

Parameters:
Name Type Description
index number

Index.

elem *

Element.

Source:
  • collection.js, line 143

notify

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.

Parameters:
Name Type Description
key string

Key.

Inherited From:
Source:
  • object.js, line 208

on

Listen for a certain type of event.

Parameters:
Name Type Argument Description
type string | Array.<string>

The event type or array of event types.

listener Function

The listener function.

scope Object <optional>
(Optional)

Object is whose scope to call the listener.

Inherited From:
Source:
  • object.js, line 240
Returns:

Unique key for the listener.

Type
goog.events.Key

once

Listen once for a certain type of event.

Parameters:
Name Type Argument Description
type string | Array.<string>

The event type or array of event types.

listener Function

The listener function.

scope Object <optional>
(Optional)

Object is whose scope to call the listener.

Inherited From:
Source:
  • object.js, line 253
Returns:

Unique key for the listener.

Type
goog.events.Key

pop

Remove the last element of the collection.

Source:
  • collection.js, line 155
Returns:

Element.

Type
*

push

Insert the provided element at the end of the collection.

Parameters:
Name Type Description
elem *

Element.

Source:
  • collection.js, line 165
Returns:

Length.

Type
number

remove

Removes the first occurence of elem from the collection.

Parameters:
Name Type Description
elem *

Element.

Source:
  • collection.js, line 177
Returns:

The removed element or undefined if elem was not found.

Type
*

removeAt

Remove the element at the provided index.

Parameters:
Name Type Description
index number

Index.

Source:
  • collection.js, line 194
Returns:

Value.

Type
*

set

Sets a value.

Parameters:
Name Type Description
key string

Key.

value *

Value.

Inherited From:
Source:
  • object.js, line 263

setAt

Set the element at the provided index.

Parameters:
Name Type Description
index number

Index.

elem *

Element.

Source:
  • collection.js, line 209

setValues

Sets a collection of key-value pairs.

Parameters:
Name Type Description
values Object.<string, *>

Values.

Inherited From:
Source:
  • object.js, line 286

un

Unlisten for a certain type of event.

Parameters:
Name Type Argument Description
type string | Array.<string>

The event type or array of event types.

listener Function

The listener function.

scope Object <optional>
(Optional)

Object is whose scope to call the listener.

Inherited From:
Source:
  • object.js, line 326

unbind

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.

Parameters:
Name Type Description
key string

Key.

Inherited From:
Source:
  • object.js, line 305

unbindAll

Removes all bindings.

Inherited From:
Source:
  • object.js, line 344

unByKey

Removes an event listener which was added with listen() by the key returned by on().

Parameters:
Name Type Argument Description
key number <nullable>

Key.

Inherited From:
Source:
  • object.js, line 336