Class DOMOrderElementList

An ElementList that ensures the elements remain in order of appearance in the DOM.

Note: this does not watch the DOM tree, it only updates the order when elements are added or the consumer instructs the DOMOrderElementList to update.

Hierarchy (View Summary)

ElementList
- DOMOrderElementList

Index

Constructors

constructor

new DOMOrderElementList(
container: Elemental,
elements?: null | Iterable<Elemental, any, any>,
): DOMOrderElementList
Parameters
- container: Elemental
 Any parent container to observe for child DOM order. It's best to reduce the total number of elements within the container.
- Optionalelements: null | Iterable<Elemental, any, any>
 A list of Elemental to store in DOM order
Returns DOMOrderElementList
Overrides ElementList.constructor
- Defined in src/domain/DOMOrderElementList.ts:18

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

container

container: Elemental

elements

elements: Elemental[]

`Readonly`size

size: number

Returns

the number of (unique) elements in Set.

`Static` `Readonly`[species]

"[species]": SetConstructor

Methods

[iterator]

"[iterator]"(): SetIterator<Elemental>
Iterates over values in the set.

Returns SetIterator<Elemental>
Inherited from ElementList.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:198

add

add(element: Elemental): this
Adds an Elemental to the ElementList and updates the order.
Parameters
- element: Elemental
  An Elemental to add to the ElementList
Returns this
Overrides ElementList.add
- Defined in src/domain/DOMOrderElementList.ts:30

asArray

asArray(): Elemental[]
Converts the ElementList to an array.

Returns Elemental[]
An array of the elements in the ElementList.
Inherited from ElementList.asArray
- Defined in src/domain/ElementList.ts:80

clear

clear(): void
Clears all elements from the ElementList.

Returns void
Inherited from ElementList.clear
- Defined in src/domain/ElementList.ts:70

delete

delete(element: Elemental): boolean
Deletes an Elemental from the ElementList.
Parameters
- element: Elemental
  The Elemental to delete.
Returns boolean
True if the element was deleted, false otherwise.
Inherited from ElementList.delete
- Defined in src/domain/ElementList.ts:57

difference

difference(other: ReadonlySetLike): Set<Elemental>
Type Parameters
- U
Parameters
- other: ReadonlySetLike
Returns Set<Elemental>
a new Set containing all the elements in this Set which are not also in the argument.
Inherited from ElementList.difference
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:48

entries

entries(): SetIterator<[Elemental, Elemental]>
Returns an iterable of [v,v] pairs for every value v in the set.

Returns SetIterator<[Elemental, Elemental]>
Inherited from ElementList.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:203

forEach

forEach(
 callbackfn: (
 value: Elemental,
 value2: Elemental,
 set: Set<Elemental>,
 ) => void,
 thisArg?: any,
): void
Executes a provided function once per each value in the Set object, in insertion order.
Parameters
- callbackfn: (value: Elemental, value2: Elemental, set: Set<Elemental>) => void
- OptionalthisArg: any
Returns void
Inherited from ElementList.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:104

get

get(index: number): Elemental
Gets an element at the specified index.
Parameters
- index: number
  The index of the element to retrieve.
Returns Elemental
The element at the specified index, or undefined if the index is out of bounds.
Inherited from ElementList.get
- Defined in src/domain/ElementList.ts:32

has

has(value: Elemental): boolean
Parameters
- value: Elemental
Returns boolean
a boolean indicating whether an element with the specified value exists in the Set or not.
Inherited from ElementList.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:108

intersection

intersection(other: ReadonlySetLike): Set<Elemental & U>
Type Parameters
- U
Parameters
- other: ReadonlySetLike
Returns Set<Elemental & U>
a new Set containing all the elements which are both in this Set and in the argument.
Inherited from ElementList.intersection
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:44

isDisjointFrom

isDisjointFrom(other: ReadonlySetLike<unknown>): boolean
Parameters
- other: ReadonlySetLike<unknown>
Returns boolean
a boolean indicating whether this Set has no elements in common with the argument.
Inherited from ElementList.isDisjointFrom
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:64

isSubsetOf

isSubsetOf(other: ReadonlySetLike<unknown>): boolean
Parameters
- other: ReadonlySetLike<unknown>
Returns boolean
a boolean indicating whether all the elements in this Set are also in the argument.
Inherited from ElementList.isSubsetOf
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:56

isSupersetOf

isSupersetOf(other: ReadonlySetLike<unknown>): boolean
Parameters
- other: ReadonlySetLike<unknown>
Returns boolean
a boolean indicating whether all the elements in the argument are also in this Set.
Inherited from ElementList.isSupersetOf
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:60

keys

keys(): SetIterator<Elemental>
Despite its name, returns an iterable of the values in the set.

Returns SetIterator<Elemental>
Inherited from ElementList.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:208

symmetricDifference

symmetricDifference(other: ReadonlySetLike): Set<Elemental | U>
Type Parameters
- U
Parameters
- other: ReadonlySetLike
Returns Set<Elemental | U>
a new Set containing all the elements which are in either this Set or in the argument, but not in both.
Inherited from ElementList.symmetricDifference
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:52

union

union(other: ReadonlySetLike): Set<Elemental | U>
Type Parameters
- U
Parameters
- other: ReadonlySetLike
Returns Set<Elemental | U>
a new Set containing all the elements in this Set and also all the elements in the argument.
Inherited from ElementList.union
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:40

update

update(): void
Updates the order of elements in the ElementList to match their order in the DOM.

Automatically called anytime an element is added.

Returns void
- Defined in src/domain/DOMOrderElementList.ts:42

values

values(): SetIterator<Elemental>
Returns an iterable of values in the set.

Returns SetIterator<Elemental>
Inherited from ElementList.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:213

Class DOMOrderElementList

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DOMOrderElementList

Properties

Readonly[toStringTag]

container

elements

Readonlysize

Returns

Static Readonly[species]

Methods

[iterator]

Returns SetIterator<Elemental>

add

Parameters

Returns this

asArray

Returns Elemental[]

clear

Returns void

delete

Parameters

Returns boolean

difference

Type Parameters

Parameters

Returns Set<Elemental>

entries

Returns SetIterator<[Elemental, Elemental]>

forEach

Parameters

Returns void

get

Parameters

Returns Elemental

has

Parameters

Returns boolean

intersection

Type Parameters

Parameters

Returns Set<Elemental & U>

isDisjointFrom

Parameters

Returns boolean

isSubsetOf

Parameters

Returns boolean

isSupersetOf

Parameters

Returns boolean

keys

Returns SetIterator<Elemental>

symmetricDifference

Type Parameters

Parameters

Returns Set<Elemental | U>

union

Type Parameters

Parameters

Returns Set<Elemental | U>

update

Returns void

values

Returns SetIterator<Elemental>

Settings

On This Page

`Readonly`[toStringTag]

`Readonly`size

`Static` `Readonly`[species]