Class VectorClusterGroupCollection

size

• get size(): number

• Returns number

uniqueKey

• get uniqueKey(): undefined | keyof T

• The key by which to check uniqueness against. undefined if no uniqueness constraint is set.

  Returns undefined | keyof T

[iterator]

• [iterator](): Generator<VectorClusterGroup, any, any>

• Returns Generator<VectorClusterGroup, any, any>

add

• add(item): null | number

• Adds an item to the collection.

  Parameters

  • item: VectorClusterGroup

    the item to be inserted

  Returns null | number

  the index at which the item was inserted

clear

• clear(): void

• clears the array

  Returns void

destroy

• destroy(): void

• Destroys the collection, clearing the array and all its events

  Returns void

getByKey

• getByKey(value): undefined | VectorClusterGroup

• Returns an item identified by the unique constraint key. Returns null, if there is no uniqueness constraint.

  Parameters

  • value: unknown

    the value to test against. does a shallow comparison, if the passed a non-atomic value

  Returns undefined | VectorClusterGroup

has

• has(item): boolean

• Equivalent to Array.prototype.includes

  Parameters

  • item: VectorClusterGroup

  Returns boolean

hasKey

• hasKey(value): undefined | boolean

• Returns true, if the key exists. Returns undefined, if there is no uniqueness constraint.

  Parameters

  • value: unknown

  Returns undefined | boolean

remove

• remove(item): void

• Removes an item from the collection

  Parameters

  • item: VectorClusterGroup

  Returns void

Staticfrom

• from<F>(iterable, uniqueKey?): Collection<F>

• Creates a Collection from an iterable, such as an Array.

  Type Parameters

  • F

  Parameters

  • iterable: Iterable<F, any, any>
  • OptionaluniqueKey: false | keyof F

    a key to maintain uniquely within the collection. passing false disables uniqueness.

  Returns Collection<F>

added

removed