Class IndexedCollection<T>

A generic array based collection. Implements the Symbol.iterator (e.g. [...collection])

Type Parameters

T

Hierarchy

Collection<T>
- IndexedCollection
  - CategoryCollection
  - LayerCollection

Index

Accessors

previousIndexSymbol size uniqueKey

Constructors

Methods

[iterator] _checkUniqueness _move _remove add clear destroy get getByKey has hasKey indexOf indexOfKey lower moveTo raise remove from

Properties

_array _previousIndexSymbol added moved removed

Accessors

previousIndexSymbol

get previousIndexSymbol(): symbol
Get the symbol which is attached to an item prior to its removal. If an item is removed, the current index of the item is set on the item with this symbol.

Returns symbol
- Defined in src/util/indexedCollection.ts:44

size

get size(): number
Returns number
Inherited from Collection.size
- Defined in src/util/collection.ts:71

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
Inherited from Collection.uniqueKey
- Defined in src/util/collection.ts:67

Constructors

constructor

new IndexedCollection<T>(uniqueKey?): IndexedCollection<T>
Type Parameters
- T
Parameters
- Optional uniqueKey: false | keyof T
  
  a key to maintain uniquely within the collection. passing false disables uniqueness.
Returns IndexedCollection<T>
Overrides Collection.constructor
- Defined in src/util/indexedCollection.ts:32

Methods

[iterator]

[iterator](): Generator<T, any, unknown>
Returns Generator<T, any, unknown>
Inherited from Collection.[iterator]
- Defined in src/util/collection.ts:57

`Protected` _checkUniqueness

_checkUniqueness(item): boolean
Parameters
- item: T
Returns boolean
Inherited from Collection._checkUniqueness
- Defined in src/util/collection.ts:86

`Protected` _move

_move(item, itemIndex, targetIndex): number
Parameters
- item: T
- itemIndex: number
- targetIndex: number
Returns number
- Defined in src/util/indexedCollection.ts:84

`Protected` _remove

_remove(item): number
Protected
internal remove function, to remove an item from the collection, does not raise an event.
Parameters
- item: T
Returns number
returns the index of the removed item or -1 if the item has not been found.
Inherited from Collection._remove
- Defined in src/util/collection.ts:123

add

add(item, index?): null | number
Adds an item to the collection. Can optionally be passed an index at which to insert the item.
Parameters
- item: T
  
  the item to be inserted
- Optional index: null | number
  
  an optional index at which to insert the item. clipped to the last entry
Returns null | number
the index at which the item was inserted
Overrides Collection.add
- Defined in src/util/indexedCollection.ts:62

clear

clear(): void
clears the array

Returns void
Inherited from Collection.clear
- Defined in src/util/collection.ts:164

destroy

destroy(): void
Destroys the collection, clearing the array and all its events

Returns void
Overrides Collection.destroy
- Defined in src/util/indexedCollection.ts:151

get

get(index): T
Returns an item at index.
Parameters
- index: number
Returns T
- Defined in src/util/indexedCollection.ts:52

getByKey

getByKey(value): undefined | T
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 | T
Inherited from Collection.getByKey
- Defined in src/util/collection.ts:79

has

has(item): boolean
Equivalent to Array.prototype.includes
Parameters
- item: T
Returns boolean
Inherited from Collection.has
- Defined in src/util/collection.ts:146

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
Inherited from Collection.hasKey
- Defined in src/util/collection.ts:154

indexOf

indexOf(item): number
Returns the index of an item or -1 if it is not part of this collection
Parameters
- item: T
Returns number
- Defined in src/util/indexedCollection.ts:137

indexOfKey

indexOfKey(value): undefined | number
Returns the index of a key. Returns undefined, if there is no uniqueness constraint
Parameters
- value: unknown
Returns undefined | number
- Defined in src/util/indexedCollection.ts:144

lower

lower(item, steps?): null | number
Lowers an item within the array
Parameters
- item: T
- Optional steps: number = 1
  
  an integer number to lower by
Returns null | number
the new index of the item
- Defined in src/util/indexedCollection.ts:113

moveTo

moveTo(item, targetIndex): null | number
Moves an item to a provided index
Parameters
- item: T
- targetIndex: number
Returns null | number
the new index of the item
- Defined in src/util/indexedCollection.ts:100

raise

raise(item, steps?): null | number
Raises an item within the array
Parameters
- item: T
- Optional steps: number = 1
  
  an integer number to lower by
Returns null | number
the new index of the item
- Defined in src/util/indexedCollection.ts:126

remove

remove(item): void
Removes an item from the collection
Parameters
- item: T
Returns void
Overrides Collection.remove
- Defined in src/util/indexedCollection.ts:77

`Static` from

from<F>(iterable, uniqueKey?): IndexedCollection<F>
Creates a Collection from an iterable, such as an Array.
Type Parameters
- F
Parameters
- iterable: Iterable<F>
- Optional uniqueKey: false | keyof F
  
  a key to maintain uniquely within the collection. passing false disables uniqueness.
Returns IndexedCollection<F>
Overrides Collection.from
- Defined in src/util/indexedCollection.ts:8

Properties

`Protected` _array

_array: T[]

`Private` _previousIndexSymbol

_previousIndexSymbol: symbol

added

added: VcsEvent<T>

Event raised if an item is added. Is passed the added item.

moved

moved: VcsEvent<T>

Event raised if an item is relocated within the collection. Is passed the moved item.

removed

removed: VcsEvent<T>

Event raised if an item is removed. Is passed the removed item.

Generated using TypeDoc