Class Collection<T>

Classdesc

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.

Fires

ol.Collection.Event

Param: opt_array

Array.

Api

stable

Type Parameters

  • T

Hierarchy

Constructors

constructor

Methods

changed clear dispatchEvent extend forEach get getArray getKeys getLength getProperties getRevision insertAt item on once pop push remove removeAt set setAt setProperties un unByKey unByKey unset

Constructors

constructor

  • new Collection<T>(opt_array?): Collection<T>

  • Type Parameters

    • T

    Parameters

    • Optional opt_array: T[]

      Array.

    Returns Collection<T>

    Classdesc

    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.

    Fires

    ol.Collection.Event

    Api

    stable

Methods

changed

  • changed(): void

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

    Returns void

    Api

clear

  • clear(): void

  • Remove all elements from the collection.

    Returns void

    Api

    stable

dispatchEvent

  • dispatchEvent(event): void

  • 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.

    Parameters

    Returns void

    Function

    Api

extend

  • extend(arr): Collection<T>

  • Add elements to the collection. This pushes each item in the provided array to the end of the collection.

    Parameters

    • arr: T[]

      Array.

    Returns Collection<T>

    This collection.

    Api

    stable

forEach

  • forEach<S>(f, opt_this?): void

  • Iterate over each element, calling the provided callback.

    Type Parameters

    • S

    Parameters

    • f: ((item, index, array) => any)

      The function to call for every element. This function takes 3 arguments (the element, the index and the array). The return value is ignored.

        • (item, index, array): any

        • Parameters

          • item: T
          • index: number
          • array: T[]

          Returns any

    • Optional opt_this: S

      The object to use as this in f.

    Returns void

    Api

    stable

get

  • get(key): any

  • Gets a value.

    Parameters

    • key: string

      Key name.

    Returns any

    Value.

    Api

    stable

getArray

  • getArray(): T[]

  • 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 T[]

    Array.

    Api

    stable

getKeys

  • getKeys(): string[]

  • Get a list of object property names.

    Returns string[]

    List of property names.

    Api

    stable

getLength

  • getLength(): number

  • Get the length of this collection.

    Returns number

    The length of the array.

    Observable

    Api

    stable

getProperties

  • getProperties(): {
        [k: string]: any;
    }

  • Get an object of all property names and values.

    Returns {
        [k: string]: any;
    }

    Object.

    • [k: string]: any

    Api

    stable

getRevision

  • getRevision(): number

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

    Returns number

    Revision.

    Api

insertAt

  • insertAt(index, elem): void

  • Insert an element at the provided index.

    Parameters

    • index: number

      Index.

    • elem: T

      Element.

    Returns void

    Api

    stable

item

  • item(index): T

  • Get the element at the provided index.

    Parameters

    • index: number

      Index.

    Returns T

    Element.

    Api

    stable

on

  • on(type, listener, opt_this?): Object | Object[]

  • Listen for a certain type of event.

    Parameters

    • type: string | string[]

      The event type or array of event types.

    • listener: Function

      The listener function.

    • Optional opt_this: Object

      The object to use as this in listener.

    Returns Object | Object[]

    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.

    Api

    stable

once

  • once(type, listener, opt_this?): Object | Object[]

  • Listen once for a certain type of event.

    Parameters

    • type: string | string[]

      The event type or array of event types.

    • listener: Function

      The listener function.

    • Optional opt_this: Object

      The object to use as this in listener.

    Returns Object | Object[]

    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.

    Api

    stable

pop

  • pop(): T

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

    Returns T

    Element.

    Api

    stable

push

  • push(elem): number

  • Insert the provided element at the end of the collection.

    Parameters

    • elem: T

      Element.

    Returns number

    Length.

    Api

    stable

remove

  • remove(elem): T

  • Remove the first occurrence of an element from the collection.

    Parameters

    • elem: T

      Element.

    Returns T

    The removed element or undefined if none found.

    Api

    stable

removeAt

  • removeAt(index): T

  • Remove the element at the provided index and return it. Return undefined if the collection does not contain this index.

    Parameters

    • index: number

      Index.

    Returns T

    Value.

    Api

    stable

set

  • set(key, value, opt_silent?): void

  • Sets a value.

    Parameters

    • key: string

      Key name.

    • value: any

      Value.

    • Optional opt_silent: boolean

      Update without triggering an event.

    Returns void

    Api

    stable

setAt

  • setAt(index, elem): void

  • Set the element at the provided index.

    Parameters

    • index: number

      Index.

    • elem: T

      Element.

    Returns void

    Api

    stable

setProperties

  • setProperties(values, opt_silent?): void

  • 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).

    Parameters

    • values: {
          [k: string]: any;
      }

      Values.

      • [k: string]: any
    • Optional opt_silent: boolean

      Update without triggering an event.

    Returns void

    Api

    stable

un

  • un(type, listener, opt_this?): void

  • Unlisten for a certain type of event.

    Parameters

    • type: string | string[]

      The event type or array of event types.

    • listener: Function

      The listener function.

    • Optional opt_this: Object

      The object which was used as this by the listener.

    Returns void

    Api

    stable

Static unByKey

  • unByKey(key): void

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

    Parameters

    • key: Object | Object[]

      The key returned by on() or once() (or an array of keys).

    Returns void

    Api

    stable

unByKey

  • unByKey(key): void

  • Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

    Parameters

    • key: Object | Object[]

      The key returned by on() or once() (or an array of keys).

    Returns void

    Function

    Api

    stable

unset

  • unset(key, opt_silent?): void

  • Unsets a property.

    Parameters

    • key: string

      Key name.

    • Optional opt_silent: boolean

      Unset without triggering an event.

    Returns void

    Api

    stable

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc