Class HTMLMathList<N, T, D>

Implement the HTMLMathList class (extends AbstractMathList)

Type Parameters

N
The HTMLElement node class
T
The Text node class
D
The Document class

Hierarchy (View Summary)

AbstractMathList<N, T, D>
- HTMLMathList

Index

Constructors

constructor

new HTMLMathList<N, T, D>(...args: MathItem<N, T, D>[]): HTMLMathList<N, T, D>
This.list is a special ListItem whose next property points to the head of the list and whose prev property points to the tail. This lets us relink the head and tail items in the same way as any other item in the list, without having to handle special cases.
Type Parameters
- N
- T
- D
Parameters
- ...args: MathItem<N, T, D>[]
  The data items that form the initial list
Returns HTMLMathList<N, T, D>
Inherited from AbstractMathList.constructor
- Defined in ts/util/LinkedList.ts:94

Properties

`Protected`list

list: ListItem<MathItem<N, T, D>>

The linked list

Methods

[iterator]

"[iterator]"(): IterableIterator<MathItem<N, T, D>>
An iterator for the list in forward order

Returns IterableIterator<MathItem<N, T, D>>
Yields
The next item in the iteration sequence
Inherited from AbstractMathList.[iterator]
- Defined in ts/util/LinkedList.ts:217

clear

clear(): LinkedList<MathItem<N, T, D>>
Empty the list

Returns LinkedList<MathItem<N, T, D>>
The LinkedList object (for chaining)
Inherited from AbstractMathList.clear
- Defined in ts/util/LinkedList.ts:206

insert

insert(
data: MathItem,
isBefore?: SortFn<MathItem<N, T, D>>,
): HTMLMathList<N, T, D>
Insert a new item into a sorted list in the correct locations
Parameters
- data: MathItem
  The data item to add
- isBefore: SortFn<MathItem<N, T, D>> = null
  The function used to order the data
Returns HTMLMathList<N, T, D>
The LinkedList object (for chaining)
Inherited from AbstractMathList.insert
- Defined in ts/util/LinkedList.ts:247

isBefore

isBefore(a: MathItem<N, T, D>, b: MathItem<N, T, D>): boolean
Parameters
- a: MathItem<N, T, D>
- b: MathItem<N, T, D>
Returns boolean
Inherited from AbstractMathList.isBefore
- Defined in ts/core/MathList.ts:60

merge

merge(
list: LinkedList<MathItem<N, T, D>>,
isBefore?: SortFn<MathItem<N, T, D>>,
): LinkedList<MathItem<N, T, D>>
Merge a sorted list with another sorted list
Parameters
- list: LinkedList<MathItem<N, T, D>>
  The list to merge into this instance's list
- isBefore: SortFn<MathItem<N, T, D>> = null
  The function used to order the data
Returns LinkedList<MathItem<N, T, D>>
The LinkedList instance (for chaining)
Inherited from AbstractMathList.merge
- Defined in ts/util/LinkedList.ts:311

pop

pop(): MathItem
Pop the end item off the list and return its data

Returns MathItem
The data from the last item in the list
Inherited from AbstractMathList.pop
- Defined in ts/util/LinkedList.ts:133

push

push(...args: MathItem<N, T, D>[]): LinkedList<MathItem<N, T, D>>
Push items on the end of the list
Parameters
- ...args: MathItem<N, T, D>[]
  The list of data items to be pushed
Returns LinkedList<MathItem<N, T, D>>
The LinkedList object (for chaining)
Inherited from AbstractMathList.push
- Defined in ts/util/LinkedList.ts:117

remove

remove(...items: MathItem<N, T, D>[]): LinkedList<MathItem<N, T, D>>
Remove items from the list
Parameters
- ...items: MathItem<N, T, D>[]
  The items to remove
Returns LinkedList<MathItem<N, T, D>>
The LinkedList object (for chaining)
Inherited from AbstractMathList.remove
- Defined in ts/util/LinkedList.ts:183

reversed

reversed(): IterableIterator<MathItem<N, T, D>>
An iterator for the list in reverse order

Returns IterableIterator<MathItem<N, T, D>>
Yields
The previous item in the iteration sequence
Inherited from AbstractMathList.reversed
- Defined in ts/util/LinkedList.ts:231

shift

shift(): MathItem
Remove an item from the head of the list and return its data

Returns MathItem
The data from the first item in the list
Inherited from AbstractMathList.shift
- Defined in ts/util/LinkedList.ts:166

sort

sort(isBefore?: SortFn<MathItem<N, T, D>>): LinkedList<MathItem<N, T, D>>
Sort the list using an optional sort function
Parameters
- isBefore: SortFn<MathItem<N, T, D>> = null
  The function used to order the data
Returns LinkedList<MathItem<N, T, D>>
The LinkedList object (for chaining)
Inherited from AbstractMathList.sort
- Defined in ts/util/LinkedList.ts:271

unshift

unshift(...args: MathItem<N, T, D>[]): LinkedList<MathItem<N, T, D>>
Push items at the head of the list
Parameters
- ...args: MathItem<N, T, D>[]
  The list of data items to inserted
Returns LinkedList<MathItem<N, T, D>>
The LinkedList object (for chaining)
Inherited from AbstractMathList.unshift
- Defined in ts/util/LinkedList.ts:150

Class HTMLMathList<N, T, D>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns HTMLMathList<N, T, D>

Properties

Protectedlist

Methods

[iterator]

Returns IterableIterator<MathItem<N, T, D>>

Yields

clear

Returns LinkedList<MathItem<N, T, D>>

insert

Parameters

Returns HTMLMathList<N, T, D>

isBefore

Parameters

Returns boolean

merge

Parameters

Returns LinkedList<MathItem<N, T, D>>

pop

Returns MathItem

push

Parameters

Returns LinkedList<MathItem<N, T, D>>

remove

Parameters

Returns LinkedList<MathItem<N, T, D>>

reversed

Returns IterableIterator<MathItem<N, T, D>>

Yields

shift

Returns MathItem

sort

Parameters

Returns LinkedList<MathItem<N, T, D>>

unshift

Parameters

Returns LinkedList<MathItem<N, T, D>>

Settings

On This Page

`Protected`list