Class SVG<N, T, D>

Implements the SVG class (extends AbstractOutputJax)

Type Parameters

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

Hierarchy (View Summary)

CommonOutputJax<
    N,
    T,
    D,
    SvgWrapper<N, T, D>,
    SvgWrapperFactory<N, T, D>,
    SvgWrapperClass<N, T, D>,
    SvgCharOptions,
    SvgVariantData,
    SvgDelimiterData,
    SvgFontData,
    SvgFontDataClass,
>
- SVG

Index

Constructors

constructor

Accessors

forceInlineBreaks name

Constructors

constructor

new SVG<N, T, D>(options?: OptionList): SVG<N, T, D>
Type Parameters
- N
- T
- D
Parameters
- options: OptionList = {}
Returns SVG<N, T, D>
Overrides CommonOutputJax.constructor
- Defined in ts/output/svg.ts:159

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

The wrapper factory for the MathML nodes

font

font: SvgFontData

The data for the font in use

fontCache

fontCache: FontCache<N, T, D>

Stores the information about the cached character glyphs

linebreaks

linebreaks: Linebreaks<
    N,
    T,
    D,
    CommonOutputJax<
        N,
        T,
        D,
        SvgWrapper<N, T, D>,
        SvgWrapperFactory<N, T, D>,
        SvgWrapperClass<N, T, D>,
        SvgCharOptions,
        SvgVariantData,
        SvgDelimiterData,
        SvgFontData,
        typeof SvgFontData,
    >,
    SvgWrapper<N, T, D>,
    SvgWrapperFactory<N, T, D>,
    SvgWrapperClass<N, T, D>,
    SvgCharOptions,
    SvgVariantData,
    SvgDelimiterData,
    SvgFontData,
    typeof SvgFontData,
>

The linebreak visitor to use for automatic linebreaks

math

math: MathItem<N, T, D>

the MathItem currently being processed

minwidth

minwidth: number = 0

Minimum width for tables with labels,

nodeMap

nodeMap: Map<MmlNode, SvgWrapper<N, T, D>>

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

shift

shift: number = 0

The shift for the main equation

styleJson

styleJson: StyleJsonSheet

Used for collecting styles needed for the output jax

svgStyles

svgStyles: N = null

The SVG stylesheet, once it is constructed

table

table: SvgWrapper

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 SVG

`Static`FONTCACHEID

FONTCACHEID: string = 'MJX-SVG-global-cache'

The ID for the SVG element that stores the cached font paths

`Static`NAME

NAME: string = 'SVG'

The name of the output jax

`Static`OPTIONS

OPTIONS: OptionList = ...

`Static`STYLESHEETID

STYLESHEETID: string = 'MJX-SVG-styles'

The ID for the stylesheet element for the styles for the SVG output

Accessors

forceInlineBreaks

get forceInlineBreaks(): boolean
Returns boolean
Overrides CommonOutputJax.forceInlineBreaks
- Defined in ts/output/svg.ts:132

name

get name(): string
Returns string
The name for this output jax class
Inherited from CommonOutputJax.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
Inherited from CommonOutputJax.addClassStyles
- Defined in ts/output/common.ts:865

addExtension

addExtension(
font: FontExtensionData<SvgCharOptions, SvgDelimiterData>,
prefix?: string,
): string[]
Add a registered font extension to the output jax's font.
Parameters
- font: FontExtensionData<SvgCharOptions, SvgDelimiterData>
  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
Inherited from CommonOutputJax.addExtension
- Defined in ts/output/common.ts:334

`Protected`addFontStyles

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

`Protected`addInlineBreak

addInlineBreak(nsvg: N, dimen: number, forced: boolean): void
Parameters
- nsvg: N
  The svg where the break is to be added
- dimen: number
  The size of the break
- forced: boolean
  Whether the break is forced or not
Returns void
- Defined in ts/output/svg.ts:489

`Protected`addWrapperStyles

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

clearFontCache

clearFontCache(): void
Clear the font cache (use for resetting the global font cache)

Returns void
- Defined in ts/output/svg.ts:177

`Protected`createNode

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

`Protected`createRoot

createRoot(wrapper: SvgWrapper<N, T, D>): [N, N]
Parameters
- wrapper: SvgWrapper<N, T, D>
  The wrapped math to process
Returns [N, N]
The svg and g nodes for the math
- Defined in ts/output/svg.ts:292

`Protected`createSVG

createSVG(h: number, d: number, w: number): [N, N]
Parameters
- h: number
  The height of the SVG to create
- d: number
  The depth of the SVG to create
- w: number
  The width of the SVG to create
Returns [N, N]
The svg element and its initial g child
- Defined in ts/output/svg.ts:322

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
Inherited from CommonOutputJax.cssFontStyles
- Defined in ts/output/common.ts:1013

escaped

escaped(math: MathItem<N, T, D>, html: MathDocument<N, T, D>): N
Parameters
- math: MathItem<N, T, D>
- html: MathDocument<N, T, D>
Returns N
Overrides CommonOutputJax.escaped
- Defined in ts/output/svg.ts:191

ex

ex(m: number): string
Parameters
- m: number
  A number to be shown in ex
Returns string
The number with units of ex
- Defined in ts/output/svg.ts:516

`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 CommonOutputJax.executeFilters
- Defined in ts/core/OutputJax.ts:228

`Protected`findCache

findCache(html: MathDocument<N, T, D>): boolean
Checks if there is already a font-cache element in the page
Parameters
- html: MathDocument<N, T, D>
  The document to search
Returns boolean
True if a font cache already exists in the page
- Defined in ts/output/svg.ts:244

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
Inherited from CommonOutputJax.fixed
- 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
Inherited from CommonOutputJax.getBBox
- 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
Inherited from CommonOutputJax.getFontData
- Defined in ts/output/common.ts:1025

`Protected`getInitialScale

getInitialScale(): number
Returns number
Overrides CommonOutputJax.getInitialScale
- Defined in ts/output/svg.ts:258

getLinebreakWidth

getLinebreakWidth(): void
Determine the linebreak width

Returns void
Inherited from CommonOutputJax.getLinebreakWidth
- 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
Inherited from CommonOutputJax.getMetricMaps
- Defined in ts/output/common.ts:669

getMetrics

getMetrics(html: MathDocument<N, T, D>): void
Parameters
- html: MathDocument<N, T, D>
Returns void
Inherited from CommonOutputJax.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.
Inherited from CommonOutputJax.getMetricsFor
- 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
Inherited from CommonOutputJax.getTestElement
- Defined in ts/output/common.ts:718

`Protected`handleInlineBreaks

handleInlineBreaks(wrapper: SvgWrapper<N, T, D>, svg: N, g: N): void
Parameters
- wrapper: SvgWrapper<N, T, D>
  The MML node wrapper whose SVG gets inline breaks
- svg: N
  The SVG node that is breaking
- g: N
  The group in which the math is typeset
Returns void
- Defined in ts/output/svg.ts:422

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
Inherited from CommonOutputJax.html
- Defined in ts/output/common.ts:901

initialize

initialize(): void
Returns void
Overrides CommonOutputJax.initialize
- Defined in ts/output/svg.ts:168

insertStyles

insertStyles(styles: StyleJson): void
Parameters
- styles: StyleJson
Returns void
Overrides CommonOutputJax.insertStyles
- Defined in ts/output/svg.ts:211

`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
Inherited from CommonOutputJax.markInlineBreak
- 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
Inherited from CommonOutputJax.markInlineBreaks
- 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
Inherited from CommonOutputJax.measureMetrics
- 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)
Inherited from CommonOutputJax.measureText
- Defined in ts/output/common.ts:954

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
Overrides CommonOutputJax.measureTextNode
- Defined in ts/output/svg.ts:578

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
Inherited from CommonOutputJax.measureTextNodeWithCache
- Defined in ts/output/common.ts:977

pageElements

pageElements(html: MathDocument<N, T, D>): N
Parameters
- html: MathDocument<N, T, D>
Returns N
Overrides CommonOutputJax.pageElements
- Defined in ts/output/svg.ts:223

processMath

processMath(wrapper: SvgWrapper<N, T, D>, parent: N): void
Parameters
- wrapper: SvgWrapper<N, T, D>
  The MML node wrapper whose SVG is to be produced
- parent: N
  The HTML node to contain the SVG
Returns void
Overrides CommonOutputJax.processMath
- Defined in ts/output/svg.ts:266

reset

reset(): void
Returns void
Overrides CommonOutputJax.reset
- Defined in ts/output/svg.ts:184

setAdaptor

setAdaptor(adaptor: DOMAdaptor<N, T, D>): void
Parameters
- adaptor: DOMAdaptor<N, T, D>
Returns void
Inherited from CommonOutputJax.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
Inherited from CommonOutputJax.setDocument
- Defined in ts/output/common.ts:887

`Protected`setIndent

setIndent(svg: N, align: string, shift: number): void
Parameters
- svg: N
  The svg node whose indentation is to be adjusted
- align: string
  The alignment for the node
- shift: number
  The indent (positive or negative) for the node
Returns void
- Defined in ts/output/svg.ts:408

`Protected`setScale

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

styleSheet

styleSheet(html: MathDocument<N, T, D>): N
Parameters
- html: MathDocument<N, T, D>
Returns N
Overrides CommonOutputJax.styleSheet
- Defined in ts/output/svg.ts:199

svg

svg(kind: string, properties?: OptionList, children?: (N | T)[]): N
Parameters
- kind: string
  The kind of node to create
- properties: OptionList = {}
  The properties to set for the element
- children: (N | T)[] = []
  The child nodes for this node
Returns N
The newly created node in the SVG namespace
- Defined in ts/output/svg.ts:529

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
Inherited from CommonOutputJax.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
Inherited from CommonOutputJax.toDOM
- 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
Inherited from CommonOutputJax.typeset
- Defined in ts/output/common.ts:351

`Protected`typesetSvg

typesetSvg(wrapper: SvgWrapper<N, T, D>, svg: N, g: N): void
Typeset the math and add minwidth (from mtables), or set the alignment and indentation of the finalized expression.
Parameters
- wrapper: SvgWrapper<N, T, D>
  The wrapped math to typeset
- svg: N
  The main svg element for the typeet math
- g: N
  The group in which the math is typeset
Returns void
- Defined in ts/output/svg.ts:380

unknownText

unknownText(text: string, variant: string): N
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
Overrides CommonOutputJax.unknownText
- Defined in ts/output/svg.ts:542

unmarkInlineBreaks

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

Class SVG<N, T, D>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SVG<N, T, D>

Properties

adaptor

container

containerWidth

document

factory

font

fontCache

linebreaks

math

minwidth

nodeMap

options

postFilters

pxPerEm

shift

styleJson

svgStyles

table

testDisplay

testInline

ProtectedunknownCache

StaticcommonStyles

StaticFONTCACHEID

StaticNAME

StaticOPTIONS

StaticSTYLESHEETID

Accessors

forceInlineBreaks

Returns boolean

name

Returns string

Methods

ProtectedaddClassStyles

Parameters

Returns void

addExtension

Parameters

Returns string[]

ProtectedaddFontStyles

Parameters

Returns void

ProtectedaddInlineBreak

Parameters

Returns void

ProtectedaddWrapperStyles

Parameters

Returns void

clearFontCache

Returns void

ProtectedcreateNode

Returns N

ProtectedcreateRoot

Parameters

Returns [N, N]

ProtectedcreateSVG

Parameters

Returns [N, N]

cssFontStyles

Parameters

Returns StyleList

escaped

Parameters

Returns N

ex

Parameters

Returns string

`Protected`unknownCache

`Static`commonStyles

`Static`FONTCACHEID

`Static`NAME

`Static`OPTIONS

`Static`STYLESHEETID

`Protected`addClassStyles

`Protected`addFontStyles

`Protected`addInlineBreak

`Protected`addWrapperStyles

`Protected`createNode

`Protected`createRoot

`Protected`createSVG

`Protected`executeFilters

`Protected`findCache

`Protected`getInitialScale

`Protected`getMetricMaps

`Protected`getTestElement

`Protected`handleInlineBreaks

`Protected`markInlineBreak

`Protected`measureMetrics