Class AbstractMathDocument<N, T, D>`Abstract`

Implements the abstract MathDocument class

Type Parameters

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

Hierarchy (View Summary)

AbstractMathDocument

Implements

MathDocument<N, T, D>

Constructors

constructor

new AbstractMathDocument<N, T, D>(
    document: D,
    adaptor: DOMAdaptor<N, T, D>,
    options: OptionList,
): AbstractMathDocument<N, T, D>
Type Parameters
- N
  The HTMLElement node class
- T
  The Text node class
- D
  The Document class
Parameters
- document: D
  The document (HTML string, parsed DOM, etc.) to be processed
- adaptor: DOMAdaptor<N, T, D>
  The DOM adaptor for this document
- options: OptionList
  The options for this document
Returns AbstractMathDocument<N, T, D>
- Defined in ts/core/MathDocument.ts:822

Properties

`Protected`_actionPromises

_actionPromises: Promise<void>[]

The render action promise list

`Protected`_readyPromise

_readyPromise: Promise<any>

Promise for the current typeset or conversion action (used to chain the promise-based calls so they don't overlap).

adaptor

adaptor: DOMAdaptor<N, T, D>

The DOM adaptor for the document

document

document: D

The document managed by this MathDocument

inputJax

inputJax: InputJax<N, T, D>[]

The list of input jax for the document

math

math: MathList<N, T, D>

The list of MathItems for this document

mmlFactory

mmlFactory: MmlFactory

The MathML node factory for the internal MathML representation

options

options: DOCUMENT_OPTIONS<DOM<N, T, D>>

The actual options for this document (with user-supplied ones merged in)

outputJax

outputJax: OutputJax<N, T, D>

The output jax for the document

processed

processed: BitField

The bit-field used to tell what steps have been taken on the document (for retries)

renderActions

renderActions: RenderList<N, T, D>

The list of render actions

`Static`KIND

KIND: string = 'MathDocument'

The type of MathDocument

`Static`OPTIONS

OPTIONS: DOCUMENT_OPTIONS<DOM> = options

The default options for the document

`Static`ProcessBits

ProcessBits: typeof BitField = ...

A bit-field for the actions that have been processed

Accessors

kind

get kind(): string
Returns string
The kind of document
Implementation of MathDocument.kind
- Defined in ts/core/MathDocument.ts:861

Methods

actionPromises

actionPromises(): Promise<void[]>
Returns Promise<void[]>
Implementation of MathDocument.actionPromises
- Defined in ts/core/MathDocument.ts:1033

addRenderAction

addRenderAction(id: string, ...action: any[]): void
Parameters
- id: string
- ...action: any[]
Returns void
Implementation of MathDocument.addRenderAction
- Defined in ts/core/MathDocument.ts:868

clear

clear(): this
Returns this
Implementation of MathDocument.clear
- Defined in ts/core/MathDocument.ts:1332

clearMathItemsWithin

clearMathItemsWithin(containers: ContainerList<N>): MathItem<N, T, D>[]
Parameters
- containers: ContainerList<N>
Returns MathItem<N, T, D>[]
Implementation of MathDocument.clearMathItemsWithin
- Defined in ts/core/MathDocument.ts:1356

clearPromises

clearPromises(): void
Returns void
Implementation of MathDocument.clearPromises
- Defined in ts/core/MathDocument.ts:1040

compile

compile(): Promise<void> | AbstractMathDocument<N, T, D>
Returns Promise<void> | AbstractMathDocument<N, T, D>
Implementation of MathDocument.compile
- Defined in ts/core/MathDocument.ts:1062

`Protected`compileAction

compileAction(
    action?: boolean,
    item?: MathListItem<N, T, D>,
    recompile?: MathItem<N, T, D>[],
): Promise<void> | AbstractMathDocument<N, T, D>
Compile action that handles retryAfter() calls.
Parameters
- action: boolean = true
  True when called as a renderAction
- item: MathListItem<N, T, D> = ...
  The MathListItem to begin with
- recompile: MathItem<N, T, D>[] = []
  Array of MathItems to be rerendered (e.g., with forward references)
Returns Promise<void> | AbstractMathDocument<N, T, D>
A promise for restarting, otherwise void
- Defined in ts/core/MathDocument.ts:1074

compileError

compileError(math: MathItem<N, T, D>, err: Error): void
Produce an error using MmlNodes
Parameters
- math: MathItem<N, T, D>
  The MathItem producing the error
- err: Error
  The Error object for the error
Returns void
- Defined in ts/core/MathDocument.ts:1155

`Protected`compileMath

compileMath(math: MathItem<N, T, D>): void
Parameters
- math: MathItem<N, T, D>
  The item to compile
Returns void
- Defined in ts/core/MathDocument.ts:1137

concat

concat(list: MathList<N, T, D>): this
Parameters
- list: MathList<N, T, D>
Returns this
Implementation of MathDocument.concat
- Defined in ts/core/MathDocument.ts:1348

convert

convert(math: string, options?: OptionList): MmlNode | N
Parameters
- math: string
- options: OptionList = {}
Returns MmlNode | N
Implementation of MathDocument.convert
- Defined in ts/core/MathDocument.ts:935

convertPromise

convertPromise(math: string, options?: OptionList): Promise<MmlNode | N>
Parameters
- math: string
- options: OptionList = {}
Returns Promise<MmlNode | N>
Implementation of MathDocument.convertPromise
- Defined in ts/core/MathDocument.ts:977

done

done(): Promise<void>
Returns Promise<void>
Implementation of MathDocument.done
- Defined in ts/core/MathDocument.ts:1341

findMath

findMath(_options?: OptionList): this
Parameters
- _options: OptionList = null
Returns this
Implementation of MathDocument.findMath
- Defined in ts/core/MathDocument.ts:1054

getMathItemsWithin

getMathItemsWithin(elements: ContainerList<N>): MathItem<N, T, D>[]
Parameters
- elements: ContainerList<N>
Returns MathItem<N, T, D>[]
Implementation of MathDocument.getMathItemsWithin
- Defined in ts/core/MathDocument.ts:1370

getMetrics

getMetrics(): this
Returns this
Implementation of MathDocument.getMetrics
- Defined in ts/core/MathDocument.ts:1258

`Protected`recompileAction

recompileAction(
    action: boolean,
    recompile: MathItem<N, T, D>[],
    i?: number,
): void | Promise<void>
If any were added to the recompile list, compile them again
Parameters
- action: boolean
  True when called as a renderAction
- recompile: MathItem<N, T, D>[]
  Array of MathItems to be rerendered (e.g., with forward references)
- i: number = 0
  The entry in the recompile list to start at
Returns void | Promise<void>
A promise for restarting, otherwise void
- Defined in ts/core/MathDocument.ts:1111

removeFromDocument

removeFromDocument(_restore?: boolean): this
Parameters
- _restore: boolean = false
Returns this
Implementation of MathDocument.removeFromDocument
- Defined in ts/core/MathDocument.ts:1282

removeRenderAction

removeRenderAction(id: string): void
Parameters
- id: string
Returns void
Implementation of MathDocument.removeRenderAction
- Defined in ts/core/MathDocument.ts:879

render

render(): AbstractMathDocument<N, T, D>
Returns AbstractMathDocument<N, T, D>
Implementation of MathDocument.render
- Defined in ts/core/MathDocument.ts:889

renderPromise

renderPromise(): Promise<AbstractMathDocument<N, T, D>>
Returns Promise<AbstractMathDocument<N, T, D>>
Implementation of MathDocument.renderPromise
- Defined in ts/core/MathDocument.ts:898

rerender

rerender(start?: number): this
Parameters
- start: number = STATE.RERENDER
Returns this
Implementation of MathDocument.rerender
- Defined in ts/core/MathDocument.ts:912

rerenderPromise

rerenderPromise(start?: number): Promise<AbstractMathDocument<N, T, D>>
Parameters
- start: number = STATE.RERENDER
Returns Promise<AbstractMathDocument<N, T, D>>
Implementation of MathDocument.rerenderPromise
- Defined in ts/core/MathDocument.ts:921

reset

reset(options?: ResetList): this
Parameters
- options: ResetList = ...
Returns this
Implementation of MathDocument.reset
- Defined in ts/core/MathDocument.ts:1312

savePromise

savePromise(promise: Promise<any>): void
Parameters
- promise: Promise<any>
Returns void
Implementation of MathDocument.savePromise
- Defined in ts/core/MathDocument.ts:1047

state

state(state: number, restore?: boolean): this
Parameters
- state: number
- restore: boolean = false
Returns this
Implementation of MathDocument.state
- Defined in ts/core/MathDocument.ts:1289

typeset

typeset(): Promise<void> | AbstractMathDocument<N, T, D>
Returns Promise<void> | AbstractMathDocument<N, T, D>
Implementation of MathDocument.typeset
- Defined in ts/core/MathDocument.ts:1178

`Protected`typesetAction

typesetAction(
action?: boolean,
item?: MathListItem<N, T, D>,
): Promise<void> | AbstractMathDocument<N, T, D>
Typeset action that handles retryAfter() calls.
Parameters
- action: boolean = true
  True when called as a renderAction
- item: MathListItem<N, T, D> = ...
  The MathList item to start with
Returns Promise<void> | AbstractMathDocument<N, T, D>
The current MathDocument (for chaining)
- Defined in ts/core/MathDocument.ts:1189

typesetError

typesetError(math: MathItem<N, T, D>, err: Error): void
Produce an error using HTML
Parameters
- math: MathItem<N, T, D>
  The MathItem producing the error
- err: Error
  The Error object for the error
Returns void
- Defined in ts/core/MathDocument.ts:1220

updateDocument

updateDocument(): this
Returns this
Implementation of MathDocument.updateDocument
- Defined in ts/core/MathDocument.ts:1269

whenReady

whenReady(action: () => any): Promise<any>
Parameters
- action: () => any
Returns Promise<any>
Implementation of MathDocument.whenReady
- Defined in ts/core/MathDocument.ts:994

Class AbstractMathDocument<N, T, D>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AbstractMathDocument<N, T, D>

Properties

Protected_actionPromises

Protected_readyPromise

adaptor

document

inputJax

math

mmlFactory

options

outputJax

processed

renderActions

StaticKIND

StaticOPTIONS

StaticProcessBits

Accessors

kind

Returns string

Methods

actionPromises

Returns Promise<void[]>

addRenderAction

Parameters

Returns void

clear

Returns this

clearMathItemsWithin

Parameters

Returns MathItem<N, T, D>[]

clearPromises

Returns void

compile

Returns Promise<void> | AbstractMathDocument<N, T, D>

ProtectedcompileAction

Parameters

Returns Promise<void> | AbstractMathDocument<N, T, D>

compileError

Parameters

Returns void

ProtectedcompileMath

Parameters

Returns void

concat

Parameters

Returns this

convert

Parameters

Returns MmlNode | N

convertPromise

Parameters

Returns Promise<MmlNode | N>

done

Returns Promise<void>

findMath

Parameters

Returns this

getMathItemsWithin

Parameters

Returns MathItem<N, T, D>[]

getMetrics

Returns this

ProtectedrecompileAction

Parameters

Returns void | Promise<void>

removeFromDocument

Parameters

Class AbstractMathDocument<N, T, D>`Abstract`

`Protected`_actionPromises

`Protected`_readyPromise

`Static`KIND

`Static`OPTIONS

`Static`ProcessBits

`Protected`compileAction

`Protected`compileMath

`Protected`recompileAction

`Protected`typesetAction