Class TeX<N, T, D>

Type Parameters

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

Hierarchy (View Summary)

AbstractInputJax<N, T, D>
- TeX

Index

Constructors

constructor

new TeX<N, T, D>(options?: OptionList): TeX<N, T, D>
Type Parameters
- N
- T
- D
Parameters
- options: OptionList = {}
Returns TeX<N, T, D>
Overrides AbstractInputJax.constructor
- Defined in ts/input/tex.ts:143

Properties

adaptor

adaptor: DOMAdaptor<N, T, D> = null

The DOMAdaptor for the MathDocument for this input jax

`Protected`configuration

configuration: ParserConfiguration

The configuration of the TeX jax.

`Protected`findTeX

findTeX: FindTeX<N, T, D>

The FindTeX instance used for locating TeX in strings

`Protected`latex

latex: string

The LaTeX code that is parsed.

`Protected`mathNode

mathNode: MmlNode

The Math node that results from parsing.

mmlFactory

mmlFactory: MmlFactory = null

The MathML node factory

options

options: OptionList

The actual options supplied to the input jax

postFilters

postFilters: FunctionList

Filters to run on the generated MathML after the TeX string is processed

preFilters

preFilters: FunctionList

Filters to run on the TeX string before it is processed

`Static`NAME

NAME: string = 'TeX'

Name of input jax.

`Static`OPTIONS

OPTIONS: OptionList = ...

Default options for the jax.

Accessors

name

get name(): string
Returns string
The name of this input jax class
Inherited from AbstractInputJax.name
- Defined in ts/core/InputJax.ts:173

parseOptions

get parseOptions(): default
Returns default
The parse options that configure this JaX instance.
- Defined in ts/input/tex.ts:180

processStrings

get processStrings(): boolean
Returns boolean
True means find math in string array, false means in DOM element
Inherited from AbstractInputJax.processStrings
- Defined in ts/core/InputJax.ts:204

Methods

compile

compile(math: MathItem<N, T, D>, document: MathDocument<N, T, D>): MmlNode
Parameters
- math: MathItem<N, T, D>
- document: MathDocument<N, T, D>
Returns MmlNode
Overrides AbstractInputJax.compile
- Defined in ts/input/tex.ts:194

`Protected`executeFilters

executeFilters(
    filters: FunctionList,
    math: MathItem<N, T, D>,
    document: MathDocument<N, T, D>,
    data: any,
): any
Execute a set of filters, passing them the MathItem and any needed data, and return the (possibly modified) data
Parameters
- filters: FunctionList
  The list of functions to be performed
- math: MathItem<N, T, D>
  The math item that is being processed
- document: MathDocument<N, T, D>
  The math document containg the math item
- data: any
  Whatever other data is needed
Returns any
The (possibly modified) data
Inherited from AbstractInputJax.executeFilters
- Defined in ts/core/InputJax.ts:233

findMath

findMath(strings: string[]): ProtoItem<N, T>[]
Parameters
- strings: string[]
Returns ProtoItem<N, T>[]
Overrides AbstractInputJax.findMath
- Defined in ts/input/tex.ts:241

formatError

formatError(err: default): MmlNode
Default formatter for error messages: wrap an error into a node for output.
Parameters
- err: default
  The TexError.
Returns MmlNode
The merror node.
- Defined in ts/input/tex.ts:252

initialize

initialize(): void
Returns void
Inherited from AbstractInputJax.initialize
- Defined in ts/core/InputJax.ts:194

reset

reset(tag?: number): void
Parameters
- tag: number = 0
Returns void
Overrides AbstractInputJax.reset
- Defined in ts/input/tex.ts:187

setAdaptor

setAdaptor(adaptor: DOMAdaptor<N, T, D>): void
Parameters
- adaptor: DOMAdaptor<N, T, D>
Returns void
Inherited from AbstractInputJax.setAdaptor
- Defined in ts/core/InputJax.ts:180

setMmlFactory

setMmlFactory(mmlFactory: MmlFactory): void
Parameters
- mmlFactory: MmlFactory
Returns void
Overrides AbstractInputJax.setMmlFactory
- Defined in ts/input/tex.ts:172

`Protected` `Static`configure

configure(packages: (string | [string, number])[]): ParserConfiguration
Initialises the configurations.
Parameters
- packages: (string | [string, number])[]
  Names of packages.
Returns ParserConfiguration
The configuration object.
- Defined in ts/input/tex.ts:115

`Protected` `Static`tags

tags(options: default, configuration: ParserConfiguration): void
Initialises the Tags factory. Add tagging structures from packages and set tagging to given default.
Parameters
- options: default
  The parse options.
- configuration: ParserConfiguration
  The configuration.
Returns void
- Defined in ts/input/tex.ts:130

Class TeX<N, T, D>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TeX<N, T, D>

Properties

adaptor

Protectedconfiguration

ProtectedfindTeX

Protectedlatex

ProtectedmathNode

mmlFactory

options

postFilters

preFilters

StaticNAME

StaticOPTIONS

Accessors

name

Returns string

parseOptions

Returns default

processStrings

Returns boolean

Methods

compile

Parameters

Returns MmlNode

ProtectedexecuteFilters

Parameters

Returns any

findMath

Parameters

Returns ProtoItem<N, T>[]

formatError

Parameters

Returns MmlNode

initialize

Returns void

reset

Parameters

Returns void

setAdaptor

Parameters

Returns void

setMmlFactory

Parameters

Returns void

Protected Staticconfigure

Parameters

Returns ParserConfiguration

Protected Statictags

Parameters

Returns void

Settings

On This Page

`Protected`configuration

`Protected`findTeX

`Protected`latex

`Protected`mathNode

`Static`NAME

`Static`OPTIONS

`Protected`executeFilters

`Protected` `Static`configure

`Protected` `Static`tags