Class VectorClusterGroupCollection

size

• get size(): number

  Returns number

uniqueKey

• get uniqueKey(): keyof T | undefined

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

  Returns keyof T | undefined

[iterator]

• "[iterator]"(): Generator<VectorClusterGroup>

  Returns Generator<VectorClusterGroup>

add

• add(item: VectorClusterGroup): number | null

  Adds an item to the collection.

  Parameters

  • item: VectorClusterGroup

    the item to be inserted

  Returns number | null

  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: unknown): VectorClusterGroup | undefined

  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 VectorClusterGroup | undefined

has

• has(item: VectorClusterGroup): boolean

  Equivalent to Array.prototype.includes

  Parameters

  • item: VectorClusterGroup

  Returns boolean

hasKey

• hasKey(value: unknown): boolean | undefined

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

  Parameters

  • value: unknown

  Returns boolean | undefined

remove

• remove(item: VectorClusterGroup): void

  Removes an item from the collection

  Parameters

  • item: VectorClusterGroup

  Returns void

Staticfrom

• from<F>(iterable: Iterable<F>, uniqueKey?: false | keyof F): Collection<F>

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

  Type Parameters

  • F

  Parameters

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

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

  Returns Collection<F>

added

removed