Class Collection

Hierarchy

Constructors

constructor

Properties

disposed on once un

Accessors

length

Methods

add addChangeListener addEventListener applyProperties changed clear contains dispatchEvent dispose disposeInternal extend forEach get getArray getKeys getLength getListeners getProperties getPropertiesInternal getRevision hasListener hasProperties insertAt item move notify onceInternal onInternal pop push remove removeAt removeChangeListener removeEventListener set setAt setProperties toggle unInternal unset

Constructors

constructor

  • new Collection(
        array?: (Dataset | DatasetGroup)[],
        options?: Options,
    ): Collection

  • Parameters

    Returns Collection

Properties

Protecteddisposed

disposed: boolean

The object has already been disposed.

on

on: CollectionOnSignature<Dataset | DatasetGroup, EventsKey>

once

once: CollectionOnSignature<Dataset | DatasetGroup, EventsKey>

un

un: CollectionOnSignature<Dataset | DatasetGroup, void>

Accessors

length

  • get length(): number

  • The length of the collection. Shorthand for getLength

    Returns number

  • set length(length: number): void

  • Change the length of the collection

    Parameters

    • length: number

    Returns void

Methods

add

  • add(dataset: Dataset | DatasetGroup, index?: number): number

  • Add a Dataset to the collection

    Parameters

    Returns number

    New length of the collection.

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

ProtectedapplyProperties

  • applyProperties(source: BaseObject): void
  • Protected

    Apply any properties from another object without triggering events.

    Parameters

    • source: BaseObject

      The source object.

    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

contains

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

ProtecteddisposeInternal

  • disposeInternal(): void
  • Protected

    Extension point for disposable objects.

    Returns void

extend

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

    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

move

  • move(from: number, to: number): void

  • Move a Dataset in the collection to at specific postion

    Parameters

    • from: number

      Index of the Dataset to move

    • to: number

      The index the Dataset will be moved to

    Returns void

notify

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

  • Parameters

    • key: string

      Key name.

    • oldValue: any

      Old value.

    Returns void

ProtectedonceInternal

  • onceInternal(
        type: string | string[],
        listener: (arg0: Event | BaseEvent) => unknown,
    ): EventsKey | EventsKey[]
  • Protected

    Parameters

    • type: string | string[]

      Type.

    • listener: (arg0: Event | BaseEvent) => unknown

      Listener.

    Returns EventsKey | EventsKey[]

    Event key.

ProtectedonInternal

  • onInternal(
        type: string | string[],
        listener: (arg0: Event | BaseEvent) => unknown,
    ): EventsKey | EventsKey[]
  • Protected

    Parameters

    • type: string | string[]

      Type.

    • listener: (arg0: Event | BaseEvent) => unknown

      Listener.

    Returns EventsKey | EventsKey[]

    Event key.

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

    Returns number

    New length of the collection.

    Api

remove

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

    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

toggle

ProtectedunInternal

  • unInternal(
        type: string | string[],
        listener: (arg0: Event | BaseEvent) => unknown,
    ): void
  • Protected

    Unlisten for a certain type of event.

    Parameters

    • type: string | string[]

      Type.

    • listener: (arg0: Event | BaseEvent) => unknown

      Listener.

    Returns void

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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods