Class HTMLDocument<N, T, D>

The HTMLDocument class (extends AbstractMathDocument)

Type Parameters

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

Hierarchy (View Summary)

AbstractMathDocument<N, T, D>
- HTMLDocument
  - LazyMathDocument

Constructors

constructor

new HTMLDocument<N, T, D>(
    document: any,
    adaptor: DOMAdaptor<N, T, D>,
    options: OptionList,
): HTMLDocument<N, T, D>
Type Parameters
- N
- T
- D
Parameters
- document: any
- adaptor: DOMAdaptor<N, T, D>
- options: OptionList
Returns HTMLDocument<N, T, D>
Overrides AbstractMathDocument.constructor
- Defined in ts/handlers/html/HTMLDocument.ts:101

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

domStrings

domStrings: HTMLDomStrings<N, T, D>

The DomString parser for locating the text in DOM trees

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: OptionList

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

`Protected`styles

styles: StyleJson[]

Extra styles to be included in the document's stylesheet (added by extensions)

`Static`KIND

KIND: string = 'HTML'

The kind of document

`Static`OPTIONS

OPTIONS: OptionList = ...

The default options for HTMLDocument

`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
Inherited from AbstractMathDocument.kind
- Defined in ts/core/MathDocument.ts:810

Methods

actionPromises

actionPromises(): Promise<void[]>
Returns Promise<void[]>
Inherited from AbstractMathDocument.actionPromises
- Defined in ts/core/MathDocument.ts:974

`Protected`addPageElements

addPageElements(): void
Add any elements needed for the document

Returns void
- Defined in ts/handlers/html/HTMLDocument.ts:280

addRenderAction

addRenderAction(id: string, ...action: any[]): void
Parameters
- id: string
- ...action: any[]
Returns void
Inherited from AbstractMathDocument.addRenderAction
- Defined in ts/core/MathDocument.ts:817

addStyles

addStyles(styles: StyleJson): void
Add styles to be included in the document's stylesheet
Parameters
- styles: StyleJson
  The styles to include
Returns void
- Defined in ts/handlers/html/HTMLDocument.ts:355

addStyleSheet

addStyleSheet(): void
Add the stylesheet to the document

Returns void
- Defined in ts/handlers/html/HTMLDocument.ts:291

clear

clear(): HTMLDocument<N, T, D>
Returns HTMLDocument<N, T, D>
Inherited from AbstractMathDocument.clear
- Defined in ts/core/MathDocument.ts:1210

clearMathItemsWithin

clearMathItemsWithin(containers: ContainerList<N>): MathItem<N, T, D>[]
Parameters
- containers: ContainerList<N>
Returns MathItem<N, T, D>[]
Inherited from AbstractMathDocument.clearMathItemsWithin
- Defined in ts/core/MathDocument.ts:1234

clearPromises

clearPromises(): void
Returns void
Inherited from AbstractMathDocument.clearPromises
- Defined in ts/core/MathDocument.ts:981

compile

compile(): HTMLDocument<N, T, D>
Returns HTMLDocument<N, T, D>
Inherited from AbstractMathDocument.compile
- Defined in ts/core/MathDocument.ts:1003

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
Inherited from AbstractMathDocument.compileError
- Defined in ts/core/MathDocument.ts:1051

`Protected`compileMath

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

concat

concat(list: MathList<N, T, D>): HTMLDocument<N, T, D>
Parameters
- list: MathList<N, T, D>
Returns HTMLDocument<N, T, D>
Inherited from AbstractMathDocument.concat
- Defined in ts/core/MathDocument.ts:1226

convert

convert(math: string, options?: OptionList): any
Parameters
- math: string
- options: OptionList = {}
Returns any
Inherited from AbstractMathDocument.convert
- Defined in ts/core/MathDocument.ts:884

convertPromise

convertPromise(math: string, options?: OptionList): Promise<any>
Parameters
- math: string
- options: OptionList = {}
Returns Promise<any>
Inherited from AbstractMathDocument.convertPromise
- Defined in ts/core/MathDocument.ts:923

documentPageElements

documentPageElements(): N
Returns N
- Defined in ts/handlers/html/HTMLDocument.ts:346

documentStyleSheet

documentStyleSheet(): N
Returns N
- Defined in ts/handlers/html/HTMLDocument.ts:339

done

done(): Promise<void>
Returns Promise<void>
Inherited from AbstractMathDocument.done
- Defined in ts/core/MathDocument.ts:1219

findMath

findMath(options: OptionList): HTMLDocument<N, T, D>
Find math within the document: Get the list of containers (default is document.body), and for each: For each input jax: Make a new MathList to store the located math If the input jax processes strings: If we haven't already made the string array and corresponding node list, do so Ask the jax to find the math in the string array, and for each one, push it onto the math list Otherwise (the jax processes DOM nodes): Ask the jax to find the math in the container, and for each one, make the result into a MathItem, and push it on the list Merge the new math list into the document's math list (we use merge to maintain a sorted list of MathItems)
Parameters
- options: OptionList
Returns HTMLDocument<N, T, D>
Overrides AbstractMathDocument.findMath
- Defined in ts/handlers/html/HTMLDocument.ts:187

`Protected`findMathFromDOM

findMathFromDOM(jax: InputJax<N, T, D>, containers: N[]): HTMLMathList<N, T, D>
Get the MathItems from the containers by searching DOM elements themselves
Parameters
- jax: InputJax<N, T, D>
  The jax being used
- containers: N[]
  The containers to be searched in order
Returns HTMLMathList<N, T, D>
The list of MathItems found
- Defined in ts/handlers/html/HTMLDocument.ts:243

`Protected`findMathFromStrings

findMathFromStrings(
jax: InputJax<N, T, D>,
containers: N[],
): HTMLMathList<N, T, D>
Get the MathItems from the containers by searching DOM strings
Parameters
- jax: InputJax<N, T, D>
  The jax being used
- containers: N[]
  The containers to be searched in order
Returns HTMLMathList<N, T, D>
The list of MathItems found
- Defined in ts/handlers/html/HTMLDocument.ts:218

`Protected`findPosition

findPosition(
    N: number,
    index: number,
    delim: string,
    nodes: HTMLNodeArray<N, T>,
): Location<N, T>
Creates a Location object for a delimiter at the position given by index in the N's string of the array of strings searched for math, recovering the original DOM node where the delimiter was found.
Parameters
- N: number
  The index of the string in the string array
- index: number
  The position within the N's string that needs to be found
- delim: string
  The delimiter for this position
- nodes: HTMLNodeArray<N, T>
  The list of node lists representing the string array
Returns Location<N, T>
The Location object for the position of the delimiter in the document
- Defined in ts/handlers/html/HTMLDocument.ts:125

`Protected`findSheet

findSheet(head: N, id: string): N
Parameters
- head: N
  The document
- id: string
  The id of the stylesheet to find
Returns N
The stylesheet with the given ID
- Defined in ts/handlers/html/HTMLDocument.ts:310

getMathItemsWithin

getMathItemsWithin(elements: ContainerList<N>): MathItem<N, T, D>[]
Parameters
- elements: ContainerList<N>
Returns MathItem<N, T, D>[]
Inherited from AbstractMathDocument.getMathItemsWithin
- Defined in ts/core/MathDocument.ts:1246

getMetrics

getMetrics(): HTMLDocument<N, T, D>
Returns HTMLDocument<N, T, D>
Inherited from AbstractMathDocument.getMetrics
- Defined in ts/core/MathDocument.ts:1136

getStyles

getStyles(): StyleJson[]
Returns StyleJson[]
The array of document-specific styles
- Defined in ts/handlers/html/HTMLDocument.ts:365

`Protected`mathItem

mathItem(
    item: ProtoItem<N, T>,
    jax: InputJax<N, T, D>,
    nodes: HTMLNodeArray<N, T>,
): HTMLMathItem<N, T, D>
Convert a ProtoItem to a MathItem (i.e., determine the actual Location objects for its start and end)
Parameters
- item: ProtoItem<N, T>
  The proto math item to turn into an actual MathItem
- jax: InputJax<N, T, D>
  The input jax to use for the MathItem
- nodes: HTMLNodeArray<N, T>
  The array of node lists that produced the string array
Returns HTMLMathItem<N, T, D>
The MathItem for the given proto item
- Defined in ts/handlers/html/HTMLDocument.ts:153

removeFromDocument

removeFromDocument(restore?: boolean): HTMLDocument<N, T, D>
Parameters
- restore: boolean = false
Returns HTMLDocument<N, T, D>
Overrides AbstractMathDocument.removeFromDocument
- Defined in ts/handlers/html/HTMLDocument.ts:324

removeRenderAction

removeRenderAction(id: string): void
Parameters
- id: string
Returns void
Inherited from AbstractMathDocument.removeRenderAction
- Defined in ts/core/MathDocument.ts:828

render

render(): HTMLDocument<N, T, D>
Returns HTMLDocument<N, T, D>
Inherited from AbstractMathDocument.render
- Defined in ts/core/MathDocument.ts:838

renderPromise

renderPromise(): Promise<any>
Returns Promise<any>
Inherited from AbstractMathDocument.renderPromise
- Defined in ts/core/MathDocument.ts:847

rerender

rerender(start?: number): HTMLDocument<N, T, D>
Parameters
- start: number = STATE.RERENDER
Returns HTMLDocument<N, T, D>
Inherited from AbstractMathDocument.rerender
- Defined in ts/core/MathDocument.ts:861

rerenderPromise

rerenderPromise(start?: number): Promise<any>
Parameters
- start: number = STATE.RERENDER
Returns Promise<any>
Inherited from AbstractMathDocument.rerenderPromise
- Defined in ts/core/MathDocument.ts:870

reset

reset(options?: ResetList): HTMLDocument<N, T, D>
Parameters
- options: ResetList = ...
Returns HTMLDocument<N, T, D>
Inherited from AbstractMathDocument.reset
- Defined in ts/core/MathDocument.ts:1190

savePromise

savePromise(promise: Promise<any>): void
Parameters
- promise: Promise<any>
Returns void
Inherited from AbstractMathDocument.savePromise
- Defined in ts/core/MathDocument.ts:988

state

state(state: number, restore?: boolean): HTMLDocument<N, T, D>
Parameters
- state: number
- restore: boolean = false
Returns HTMLDocument<N, T, D>
Inherited from AbstractMathDocument.state
- Defined in ts/core/MathDocument.ts:1167

typeset

typeset(): HTMLDocument<N, T, D>
Returns HTMLDocument<N, T, D>
Inherited from AbstractMathDocument.typeset
- Defined in ts/core/MathDocument.ts:1074

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
Inherited from AbstractMathDocument.typesetError
- Defined in ts/core/MathDocument.ts:1098

updateDocument

updateDocument(): HTMLDocument<N, T, D>
Returns HTMLDocument<N, T, D>
Overrides AbstractMathDocument.updateDocument
- Defined in ts/handlers/html/HTMLDocument.ts:267

whenReady

whenReady(action: () => any): Promise<any>
Parameters
- action: () => any
Returns Promise<any>
Inherited from AbstractMathDocument.whenReady
- Defined in ts/core/MathDocument.ts:937

Class HTMLDocument<N, T, D>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns HTMLDocument<N, T, D>

Properties

Protected_actionPromises

Protected_readyPromise

adaptor

document

domStrings

inputJax

math

mmlFactory

options

outputJax

processed

renderActions

Protectedstyles

StaticKIND

StaticOPTIONS

StaticProcessBits

Accessors

kind

Returns string

Methods

actionPromises

Returns Promise<void[]>

ProtectedaddPageElements

Returns void

addRenderAction

Parameters

Returns void

addStyles

Parameters

Returns void

addStyleSheet

Returns void

clear

Returns HTMLDocument<N, T, D>

clearMathItemsWithin

Parameters

Returns MathItem<N, T, D>[]

clearPromises

Returns void

compile

Returns HTMLDocument<N, T, D>

compileError

Parameters

Returns void

ProtectedcompileMath

Parameters

Returns void

concat

Parameters

Returns HTMLDocument<N, T, D>

convert

Parameters

Returns any

convertPromise

Parameters

Returns Promise<any>

documentPageElements

Returns N

documentStyleSheet

Returns N

done

Returns Promise<void>

findMath

Parameters

Returns HTMLDocument<N, T, D>

ProtectedfindMathFromDOM

`Protected`_actionPromises

`Protected`_readyPromise

`Protected`styles

`Static`KIND

`Static`OPTIONS

`Static`ProcessBits

`Protected`addPageElements

`Protected`compileMath

`Protected`findMathFromDOM

`Protected`findMathFromStrings

`Protected`findPosition

`Protected`findSheet

`Protected`mathItem