Class CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>`Abstract`

The CommonOutputJax class on which the CHTML and SVG jax are built

Template: JX

The OutputJax type

Type Parameters

N
The DOM node type
T
The DOM text node type
D
The DOM document type
WW extends CommonWrapper<
    N,
    T,
    D,
    CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>,
    WW,
    WF,
    WC,
    CC,
    VV,
    DD,
    FD,
    FC,
>
The Wrapper type
WF extends CommonWrapperFactory<
    N,
    T,
    D,
    CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>,
    WW,
    WF,
    WC,
    CC,
    VV,
    DD,
    FD,
    FC,
>
The WrapperFactory type
WC extends CommonWrapperClass<
    N,
    T,
    D,
    CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>,
    WW,
    WF,
    WC,
    CC,
    VV,
    DD,
    FD,
    FC,
>
The WrapperClass type
CC extends CharOptions
The CharOptions type
VV extends VariantData<CC>
The VariantData type
DD extends DelimiterData
The DelimiterData type
FD extends FontData<CC, VV, DD>
The FontData type
FC extends FontDataClass<CC, VV, DD>
The FontDataClass type

Hierarchy (View Summary)

AbstractOutputJax<N, T, D>
- CommonOutputJax
  - CHTML
  - SVG

Constructors

constructor

new CommonOutputJax<
    N,
    T,
    D,
    WW extends
        CommonWrapper<
            N,
            T,
            D,
            CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>,
            WW,
            WF,
            WC,
            CC,
            VV,
            DD,
            FD,
            FC,
        >,
    WF extends
        CommonWrapperFactory<
            N,
            T,
            D,
            CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>,
            WW,
            WF,
            WC,
            CC,
            VV,
            DD,
            FD,
            FC,
        >,
    WC extends
        CommonWrapperClass<
            N,
            T,
            D,
            CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>,
            WW,
            WF,
            WC,
            CC,
            VV,
            DD,
            FD,
            FC,
        >,
    CC extends CharOptions,
    VV extends VariantData<CC>,
    DD extends DelimiterData,
    FD extends FontData<CC, VV, DD>,
    FC extends FontDataClass<CC, VV, DD>,
>(
    options?: OptionList,
    defaultFactory?: typeof CommonWrapperFactory,
    defaultFont?: FC,
): CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>
Get the WrapperFactory and connect it to this output jax Get the cssStyle and font objects
Type Parameters
- N
- T
- D
- WW extends CommonWrapper<
      N,
      T,
      D,
      CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>,
      WW,
      WF,
      WC,
      CC,
      VV,
      DD,
      FD,
      FC,
  >
- WF extends CommonWrapperFactory<
      N,
      T,
      D,
      CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>,
      WW,
      WF,
      WC,
      CC,
      VV,
      DD,
      FD,
      FC,
  >
- WC extends CommonWrapperClass<
      N,
      T,
      D,
      CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>,
      WW,
      WF,
      WC,
      CC,
      VV,
      DD,
      FD,
      FC,
  >
- CC extends CharOptions
- VV extends VariantData<CC>
- DD extends DelimiterData
- FD extends FontData<CC, VV, DD>
- FC extends FontDataClass<CC, VV, DD>
Parameters
- options: OptionList = {}
  The configuration options
- defaultFactory: typeof CommonWrapperFactory = null
  The default wrapper factory class
- defaultFont: FC = null
  The default FontData constructor
Returns CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>
Overrides AbstractOutputJax.constructor
- Defined in ts/output/common.ts:282

Properties

adaptor

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

The MathDocument's DOMAdaptor

container

container: N

The container element for the math

containerWidth

containerWidth: number

The container width for linebreaking;

document

document: MathDocument<N, T, D>

The MathDocument for the math we find

factory

factory: WF

The wrapper factory for the MathML nodes

font

font: FD

The data for the font in use

linebreaks

linebreaks: Linebreaks<
    N,
    T,
    D,
    CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>,
    WW,
    WF,
    WC,
    CC,
    VV,
    DD,
    FD,
    FC,
>

The linebreak visitor to use for automatic linebreaks

math

math: MathItem<N, T, D>

the MathItem currently being processed

nodeMap

nodeMap: Map<MmlNode, WW>

A map from the nodes in the expression currently being processed to the wrapper nodes for them (used by functions like core() to locate the wrappers from the core nodes)

options

options: OptionList

The actual options supplied to the output jax

postFilters

postFilters: FunctionList

Filters to run after the output is processed

pxPerEm

pxPerEm: number

The pixels per em for the math item being processed

styleJson

styleJson: StyleJsonSheet

Used for collecting styles needed for the output jax

table

table: WW

The top-level table, if any

testDisplay

testDisplay: N

Node used to test for display metric data

testInline

testInline: N

Node used to test for in-line metric data

`Protected`unknownCache

unknownCache: UnknownVariantMap

Cache of unknonw character bounding boxes for this element

`Static`commonStyles

commonStyles: StyleJson = ...

The default styles for the output jax

`Static`NAME

NAME: string = 'Common'

The name of this output jax

`Static`OPTIONS

OPTIONS: OptionList = ...

Accessors

forceInlineBreaks

get forceInlineBreaks(): boolean
Returns boolean
True when in-line breaks need to be forced (e.g., for SVG output)
- Defined in ts/output/common.ts:240

name

get name(): string
Returns string
The name for this output jax class
Inherited from AbstractOutputJax.name
- Defined in ts/core/OutputJax.ts:162

Methods

`Protected`addClassStyles

addClassStyles(CLASS: typeof CommonWrapper, styles: StyleJsonSheet): void
Parameters
- CLASS: typeof CommonWrapper
  The Wrapper class whose styles are to be added
- styles: StyleJsonSheet
  The style object to add to.
Returns void
- Defined in ts/output/common.ts:865

addExtension

addExtension(font: FontExtensionData<CC, DD>, prefix?: string): string[]
Add a registered font extension to the output jax's font.
Parameters
- font: FontExtensionData<CC, DD>
  The name of the extension to add to this output jax's font
- prefix: string = ''
  The prefix for dynamically loaded files for this extension
Returns string[]
New CSS rules needed for the font
- Defined in ts/output/common.ts:334

`Protected`addFontStyles

addFontStyles(styles: StyleJsonSheet): void
Parameters
- styles: StyleJsonSheet
  The style object to add to
Returns void
- Defined in ts/output/common.ts:848

`Protected`addWrapperStyles

addWrapperStyles(styles: StyleJsonSheet): void
Parameters
- styles: StyleJsonSheet
  The style object to add to
Returns void
- Defined in ts/output/common.ts:855

`Protected`createNode

createNode(): N
Returns N
The container DOM node for the typeset math
- Defined in ts/output/common.ts:361

cssFontStyles

cssFontStyles(font: CssFontData, styles?: StyleList): StyleList
Parameters
- font: CssFontData
  The family, style, and weight for the given font
- styles: StyleList = {}
  The style object to add the font data to
Returns StyleList
The modified (or initialized) style object
- Defined in ts/output/common.ts:1013

`Abstract`escaped

escaped(math: MathItem<N, T, D>, document?: MathDocument<N, T, D>): N
Parameters
- math: MathItem<N, T, D>
- Optionaldocument: MathDocument<N, T, D>
Returns N
Inherited from AbstractOutputJax.escaped
- Defined in ts/core/OutputJax.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 contaiing the math item
- data: any
  Whatever other data is needed
Returns any
The (possibly modified) data
Inherited from AbstractOutputJax.executeFilters
- Defined in ts/core/OutputJax.ts:228

fixed

fixed(m: number, n?: number): string
Parameters
- m: number
  A number to be shown with a fixed number of digits
- n: number = 3
  The number of digits to use
Returns string
The formatted number
- Defined in ts/output/common.ts:924

getBBox

getBBox(math: MathItem<N, T, D>, html: MathDocument<N, T, D>): BBox
Parameters
- math: MathItem<N, T, D>
  The MathItem to get the bounding box for
- html: MathDocument<N, T, D>
  The MathDocument for the math
Returns BBox
The bounding box
- Defined in ts/output/common.ts:457

getFontData

getFontData(styles: Styles): CssFontData
Parameters
- styles: Styles
  The style object to query
Returns CssFontData
The family, italic, and boolean values
- Defined in ts/output/common.ts:1025

`Protected`getInitialScale

getInitialScale(): number
Returns number
The initial scaling value for the math node
- Defined in ts/output/common.ts:390

getLinebreakWidth

getLinebreakWidth(): void
Determine the linebreak width

Returns void
- Defined in ts/output/common.ts:472

`Protected`getMetricMaps

getMetricMaps(html: MathDocument<N, T, D>): MetricMap<N>[]
Get a MetricMap for the math list
Parameters
- html: MathDocument<N, T, D>
  The math document whose math list is to be processed.
Returns MetricMap<N>[]
The node-to-metrics maps for all the containers that have math
- Defined in ts/output/common.ts:669

getMetrics

getMetrics(html: MathDocument<N, T, D>): void
Parameters
- html: MathDocument<N, T, D>
Returns void
Overrides AbstractOutputJax.getMetrics
- Defined in ts/output/common.ts:628

getMetricsFor

getMetricsFor(node: N, display: boolean): ExtendedMetrics
Parameters
- node: N
  The container node whose metrics are to be measured
- display: boolean
  True if the metrics are for displayed math
Returns ExtendedMetrics
Object containing em, ex, containerWidth, etc.
- Defined in ts/output/common.ts:654

`Protected`getTestElement

getTestElement(node: N, display: boolean): N
Parameters
- node: N
  The math element to be measured
- display: boolean
  Is the element in display math?
Returns N
The test elements that were added
- Defined in ts/output/common.ts:718

html

html(type: string, def?: OptionList, content?: (N | T)[], ns?: string): N
Parameters
- type: string
  The type of HTML node to create
- def: OptionList = {}
  The properties to set on the HTML node
- content: (N | T)[] = []
  Array of child nodes to set for the HTML node
- Optionalns: string
  The namespace for the element
Returns N
The newly created DOM tree
- Defined in ts/output/common.ts:901

initialize

initialize(): void
Returns void
Inherited from AbstractOutputJax.initialize
- Defined in ts/core/OutputJax.ts:176

insertStyles

insertStyles(_styles: StyleJson): void
Insert styles into an existing stylesheet
Parameters
- _styles: StyleJson
  The styles to insert
Returns void
- Defined in ts/output/common.ts:880

`Protected`markInlineBreak

markInlineBreak(
    marked: boolean,
    forcebreak: boolean,
    linebreak: string,
    node: MmlNode,
    child: MmlNode,
    mo?: MmlNode,
): boolean
Parameters
- marked: boolean
  Whether the node has already been marked
- forcebreak: boolean
  Whether the break is to be forced
- linebreak: string
  The break type
- node: MmlNode
  The parent node to mark
- child: MmlNode
  The child node to mark
- mo: MmlNode = null
  The core mo to mark
Returns boolean
The modified marked variable
- Defined in ts/output/common.ts:580

markInlineBreaks

markInlineBreaks(node: MmlNode): void
Parameters
- node: MmlNode
  The node to check for potential inline breakpoints
Returns void
- Defined in ts/output/common.ts:483

`Protected`measureMetrics

measureMetrics(node: N, getFamily: boolean): ExtendedMetrics
Parameters
- node: N
  The test node to measure
- getFamily: boolean
  True if font family of surroundings is to be determined
Returns ExtendedMetrics
The metric data for the given node
- Defined in ts/output/common.ts:789

measureText

measureText(text: string, variant: string, font?: CssFontData): UnknownBBox
Measure text from a specific font, or that isn't in the MathJax font
Parameters
- text: string
  The text to measure
- variant: string
  The variant for the text
- font: CssFontData = ...
  The family, italic, and bold data for explicit fonts
Returns UnknownBBox
The width, height, and depth of the text (in ems)
- Defined in ts/output/common.ts:954

`Abstract`measureTextNode

measureTextNode(text: N): UnknownBBox
Measure the width of a text element by placing it in the page and looking up its size (fake the height and depth, since we can't measure that)
Parameters
- text: N
  The text element to measure
Returns UnknownBBox
The width, height and depth for the text (in ems)
- Defined in ts/output/common.ts:1006

measureTextNodeWithCache

measureTextNodeWithCache(
    text: N,
    chars: string,
    variant: string,
    font?: CssFontData,
): UnknownBBox
Get the size of a text node, caching the result, and using a cached result, if there is one.
Parameters
- text: N
  The text element to measure
- chars: string
  The string contained in the text node
- variant: string
  The variant for the text
- font: CssFontData = ...
  The family, italic, and bold data for explicit fonts
Returns UnknownBBox
The width, height and depth for the text
- Defined in ts/output/common.ts:977

pageElements

pageElements(_document: MathDocument<N, T, D>): N
Parameters
- _document: MathDocument<N, T, D>
Returns N
Inherited from AbstractOutputJax.pageElements
- Defined in ts/core/OutputJax.ts:214

`Abstract`processMath

processMath(wrapper: WW, node: N): void
This is the actual typesetting function supplied by the subclass
Parameters
- wrapper: WW
  The wrapped intenral MathML node of the root math element to process
- node: N
  The container node where the math is to be typeset
Returns void
- Defined in ts/output/common.ts:448

reset

reset(..._args: any[]): void
Parameters
- ..._args: any[]
Returns void
Inherited from AbstractOutputJax.reset
- Defined in ts/core/OutputJax.ts:181

setAdaptor

setAdaptor(adaptor: DOMAdaptor<N, T, D>): void
Parameters
- adaptor: DOMAdaptor<N, T, D>
Returns void
Overrides AbstractOutputJax.setAdaptor
- Defined in ts/output/common.ts:317

`Protected`setDocument

setDocument(html: MathDocument<N, T, D>): void
Parameters
- html: MathDocument<N, T, D>
  The document to be used
Returns void
- Defined in ts/output/common.ts:887

`Protected`setScale

setScale(node: N, wrapper: WW): void
Parameters
- node: N
  The container whose scale is to be set
- wrapper: WW
  The wrapper for the math element being scaled
Returns void
- Defined in ts/output/common.ts:370

styleSheet

styleSheet(html: MathDocument<N, T, D>): N
Parameters
- html: MathDocument<N, T, D>
Returns N
Overrides AbstractOutputJax.styleSheet
- Defined in ts/output/common.ts:814

text

text(text: string): T
Parameters
- text: string
  The text string for which to make a text node
Returns T
A text node with the given text
- Defined in ts/output/common.ts:915

toDOM

toDOM(math: MathItem<N, T, D>, node: N, html?: MathDocument<N, T, D>): void
Set the document where HTML nodes will be created via the adaptor Set up global values Recursively set the TeX classes for the nodes Set the scaling for the DOM node Create the nodeMap (maps MathML nodes to corresponding wrappers) Create the HTML output for the root MathML node in the container Clear the nodeMape Execute the post-filters
Parameters
- math: MathItem<N, T, D>
  The math item to convert
- node: N
  The contaier to place the result into
- html: MathDocument<N, T, D> = null
  The document containing the math
Returns void
- Defined in ts/output/common.ts:408

typeset

typeset(math: MathItem<N, T, D>, html: MathDocument<N, T, D>): N
Save the math document Create the mjx-container node Create the DOM output for the root MathML math node in the container Return the container node
Parameters
- math: MathItem<N, T, D>
- html: MathDocument<N, T, D>
Returns N
Overrides AbstractOutputJax.typeset
- Defined in ts/output/common.ts:351

`Abstract`unknownText

unknownText(text: string, variant: string): N
Create a DOM node for text from a specific CSS font, or that is not in the current MathJax font
Parameters
- text: string
  The text to be displayed
- variant: string
  The name of the variant for the text
Returns N
The text element containing the text
- Defined in ts/output/common.ts:944

unmarkInlineBreaks

unmarkInlineBreaks(node: MmlNode): void
Parameters
- node: MmlNode
  The node where inline breaks are to be removed
Returns void
- Defined in ts/output/common.ts:613

Class CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>Abstract

Template: JX

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>

Properties

adaptor

container

containerWidth

document

factory

font

linebreaks

math

nodeMap

options

postFilters

pxPerEm

styleJson

table

testDisplay

testInline

ProtectedunknownCache

StaticcommonStyles

StaticNAME

StaticOPTIONS

Accessors

forceInlineBreaks

Returns boolean

name

Returns string

Methods

ProtectedaddClassStyles

Parameters

Returns void

addExtension

Parameters

Returns string[]

ProtectedaddFontStyles

Parameters

Returns void

ProtectedaddWrapperStyles

Parameters

Returns void

ProtectedcreateNode

Returns N

cssFontStyles

Parameters

Returns StyleList

Abstractescaped

Parameters

Returns N

ProtectedexecuteFilters

Parameters

Returns any

fixed

Parameters

Returns string

getBBox

Parameters

Returns BBox

getFontData

Parameters

Returns CssFontData

ProtectedgetInitialScale

Returns number

getLinebreakWidth

Returns void

ProtectedgetMetricMaps

Parameters

Returns MetricMap<N>[]

Class CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>`Abstract`

`Protected`unknownCache

`Static`commonStyles

`Static`NAME

`Static`OPTIONS

`Protected`addClassStyles

`Protected`addFontStyles

`Protected`addWrapperStyles

`Protected`createNode

`Abstract`escaped

`Protected`executeFilters

`Protected`getInitialScale

`Protected`getMetricMaps

`Protected`getTestElement

`Protected`markInlineBreak

`Protected`measureMetrics

`Abstract`measureTextNode

`Abstract`processMath

`Protected`setDocument

`Protected`setScale

`Abstract`unknownText