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

Implements the MathItem class

Type Parameters

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

Hierarchy (View Summary)

AbstractMathItem
- HTMLMathItem

Implements

MathItem<N, T, D>

Index

Constructors

constructor

new AbstractMathItem<N, T, D>(
    math: string,
    jax: InputJax<N, T, D>,
    display?: boolean,
    start?: Location<N, T>,
    end?: Location<N, T>,
): AbstractMathItem<N, T, D>
Type Parameters
- N
- T
- D
Parameters
- math: string
  The math expression for this item
- jax: InputJax<N, T, D>
  The input jax to use for this item
- display: boolean = true
  True if display mode, false if inline
- start: Location<N, T> = ...
  The starting position of the math in the document
- end: Location<N, T> = ...
  The ending position of the math in the document
Returns AbstractMathItem<N, T, D>
- Defined in ts/core/MathItem.ts:346

Properties

`Protected`_state

_state: number = STATE.UNPROCESSED

The current state of the item (how far in the render actions it has been processed)

display

display: boolean

True when this math is in display mode

end

end: Location<N, T>

Reference to the end of the math in the document

inputData

inputData: OptionList = {}

Data private to the input jax

inputJax

inputJax: InputJax<N, T, D>

The input jax associated with this item

math

math: string

The source text for the math (e.g., TeX string)

metrics

metrics: Metrics = ...

The metric information about the surrounding environment

outputData

outputData: OptionList = {}

Data private to the output jax

root

root: MmlNode = null

The compiled internal MathML (result of InputJax)

start

start: Location<N, T>

Reference to the beginning of the math in the document

typesetRoot

typesetRoot: N = null

The typeset result (result of OutputJax)

Accessors

isEscaped

get isEscaped(): boolean
Returns boolean
True when this item is an escaped delimiter
Implementation of MathItem.isEscaped
- Defined in ts/core/MathItem.ts:334

Methods

clear

clear(): void
Returns void
Implementation of MathItem.clear
- Defined in ts/core/MathItem.ts:467

compile

compile(document: MathDocument<N, T, D>): void
Parameters
- document: MathDocument<N, T, D>
Returns void
Implementation of MathItem.compile
- Defined in ts/core/MathItem.ts:395

convert

convert(document: MathDocument<N, T, D>, end?: number): void
Parameters
- document: MathDocument<N, T, D>
- end: number = STATE.LAST
Returns void
Implementation of MathItem.convert
- Defined in ts/core/MathItem.ts:388

removeFromDocument

removeFromDocument(_restore?: boolean): void
Parameters
- _restore: boolean = false
Returns void
Implementation of MathItem.removeFromDocument
- Defined in ts/core/MathItem.ts:422

render

render(document: MathDocument<N, T, D>): void
Parameters
- document: MathDocument<N, T, D>
Returns void
Implementation of MathItem.render
- Defined in ts/core/MathItem.ts:368

rerender

rerender(document: MathDocument<N, T, D>, start?: number): void
Parameters
- document: MathDocument<N, T, D>
- start: number = STATE.RERENDER
Returns void
Implementation of MathItem.rerender
- Defined in ts/core/MathItem.ts:375

reset

reset(restore?: boolean): void
Parameters
- restore: boolean = false
Returns void
Implementation of MathItem.reset
- Defined in ts/core/MathItem.ts:460

setMetrics

setMetrics(em: number, ex: number, cwidth: number, scale: number): void
Parameters
- em: number
- ex: number
- cwidth: number
- scale: number
Returns void
Implementation of MathItem.setMetrics
- Defined in ts/core/MathItem.ts:429

state

state(state?: number, restore?: boolean): number
Parameters
- state: number = null
- restore: boolean = false
Returns number
Implementation of MathItem.state
- Defined in ts/core/MathItem.ts:441

typeset

typeset(document: MathDocument<N, T, D>): void
Parameters
- document: MathDocument<N, T, D>
Returns void
Implementation of MathItem.typeset
- Defined in ts/core/MathItem.ts:405

updateDocument

updateDocument(_document: MathDocument<N, T, D>): void
Parameters
- _document: MathDocument<N, T, D>
Returns void
Implementation of MathItem.updateDocument
- Defined in ts/core/MathItem.ts:417

Class AbstractMathItem<N, T, D>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AbstractMathItem<N, T, D>

Properties

Protected_state

display

end

inputData

inputJax

math

metrics

outputData

root

start

typesetRoot

Accessors

isEscaped

Returns boolean

Methods

clear

Returns void

compile

Parameters

Returns void

convert

Parameters

Returns void

removeFromDocument

Parameters

Returns void

render

Parameters

Returns void

rerender

Parameters

Returns void

reset

Parameters

Returns void

setMetrics

Parameters

Returns void

state

Parameters

Returns number

typeset

Parameters

Returns void

updateDocument

Parameters

Returns void

Settings

On This Page

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

`Protected`_state