Class Collection

on

once

un

addChangeListener

• addChangeListener(key: string, listener: Listener): void

  Parameters

  • key: string

    Key name.
  • listener: Listener

    Listener.

  Returns void

addEventListener

• addEventListener(type: string, listener: Listener): void

  Parameters

  • type: string

    Type.
  • listener: Listener

    Listener.

  Returns void

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

dispatchEvent

• dispatchEvent(event: string | BaseEvent): undefined | boolean

  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

  • event: string | BaseEvent

    Event object.

  Returns undefined | boolean

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

  Api

dispose

• dispose(): void

  Clean up.

  Returns void

extend

• extend(arr: (Dataset | DatasetGroup)[]): Collection<Dataset | DatasetGroup>

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

  Parameters

  • arr: (Dataset | DatasetGroup)[]

    Array.

  Returns Collection<Dataset | DatasetGroup>

  This collection.

  Api

forEach

• forEach(
      f: (
          arg0: Dataset | DatasetGroup,
          arg1: number,
          arg2: (Dataset | DatasetGroup)[],
      ) => any,
  ): void

  Iterate over each element, calling the provided callback.

  Parameters

  • f: (
        arg0: Dataset | DatasetGroup,
        arg1: number,
        arg2: (Dataset | DatasetGroup)[],
    ) => 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.

  Returns void

  Api

get

• get(key: string): any

  Gets a value.

  Parameters

  • key: string

    Key name.

  Returns any

  Value.

  Api

getArray

• getArray(): (Dataset | DatasetGroup)[]

  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 (Dataset | DatasetGroup)[]

  Array.

  Api

getKeys

• getKeys(): string[]

  Get a list of object property names.

  Returns string[]

  List of property names.

  Api

getLength

• getLength(): number

  Get the length of this collection.

  Returns number

  The length of the array.

  Observable

  Api

getListeners

• getListeners(type: string): undefined | Listener[]

  Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.

  Parameters

  • type: string

    Type.

  Returns undefined | Listener[]

  Listeners.

getProperties

• getProperties(): { [x: string]: any }

  Get an object of all property names and values.

  Returns { [x: string]: any }

  Object.

  Api

getPropertiesInternal

• getPropertiesInternal(): null | { [x: string]: any }

  Get an object of all property names and values.

  Returns null | { [x: string]: any }

  Object.

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

hasListener

• hasListener(type?: string): boolean

  Parameters

  • Optionaltype: string

    Type. If not provided, true will be returned if this event target has any listeners.

  Returns boolean

  Has listeners.

hasProperties

• hasProperties(): boolean

  Returns boolean

  The object has properties.

insertAt

• insertAt(index: number, elem: Dataset | DatasetGroup): void

  Insert an element at the provided index.

  Parameters

  • index: number

    Index.
  • elem: Dataset | DatasetGroup

    Element.

  Returns void

  Api

item

• item(index: number): Dataset | DatasetGroup

  Get the element at the provided index.

  Parameters

  • index: number

    Index.

  Returns Dataset | DatasetGroup

  Element.

  Api

notify

• notify(key: string, oldValue: any): void

  Parameters

  • key: string

    Key name.
  • oldValue: any

    Old value.

  Returns void

pop

• pop(): undefined | Dataset | DatasetGroup

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

  Returns undefined | Dataset | DatasetGroup

  Element.

  Api

push

• push(elem: Dataset | DatasetGroup): number

  Insert the provided element at the end of the collection.

  Parameters

  • elem: Dataset | DatasetGroup

    Element.

  Returns number

  New length of the collection.

  Api

removeAt

• removeAt(index: number): undefined | Dataset | DatasetGroup

  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 undefined | Dataset | DatasetGroup

  Value.

  Api

removeChangeListener

• removeChangeListener(key: string, listener: Listener): void

  Parameters

  • key: string

    Key name.
  • listener: Listener

    Listener.

  Returns void

removeEventListener

• removeEventListener(type: string, listener: Listener): void

  Parameters

  • type: string

    Type.
  • listener: Listener

    Listener.

  Returns void

set

• set(key: string, value: any, silent?: boolean): void

  Sets a value.

  Parameters

  • key: string

    Key name.
  • value: any

    Value.
  • Optionalsilent: boolean

    Update without triggering an event.

  Returns void

  Api

setAt

• setAt(index: number, elem: Dataset | DatasetGroup): void

  Set the element at the provided index.

  Parameters

  • index: number

    Index.
  • elem: Dataset | DatasetGroup

    Element.

  Returns void

  Api

setProperties

• setProperties(values: { [x: string]: any }, silent?: boolean): 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: { [x: string]: any }

    Values.
  • Optionalsilent: boolean

    Update without triggering an event.

  Returns void

  Api

unset

• unset(key: string, silent?: boolean): void

  Unsets a property.

  Parameters

  • key: string

    Key name.
  • Optionalsilent: boolean

    Unset without triggering an event.

  Returns void

  Api