Class CommonWrapper<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>

The base CommonWrapper class

Type Parameters

N
The DOM node type
T
The DOM text node type
D
The DOM document type
JX extends CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>
The OutputJax type
WW extends CommonWrapper<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
The Wrapper type
WF extends CommonWrapperFactory<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
The WrapperFactory type
WC extends CommonWrapperClass<N, T, D, JX, 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

Index

Constructors

constructor

Accessors

adaptor breakCount containerWidth fixesPWidth jax kind linebreakOptions linebreaks metrics

Constructors

constructor

new CommonWrapper<
    N,
    T,
    D,
    JX extends CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>,
    WW extends CommonWrapper<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>,
    WF extends
        CommonWrapperFactory<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>,
    WC extends CommonWrapperClass<N, T, D, JX, 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>,
>(
    factory: WF,
    node: MmlNode,
    parent?: WW,
): CommonWrapper<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
Type Parameters
- N
- T
- D
- JX extends CommonOutputJax<N, T, D, WW, WF, WC, CC, VV, DD, FD, FC>
- WW extends CommonWrapper<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
- WF extends CommonWrapperFactory<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
- WC extends CommonWrapperClass<N, T, D, JX, 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
- factory: WF
- node: MmlNode
- parent: WW = null
Returns CommonWrapper<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
Overrides AbstractWrapper.constructor
- Defined in ts/output/common/Wrapper.ts:537

Properties

`Protected`_breakCount

_breakCount: number = -1

The cached number of linebreaks

bbox

bbox: BBox

The bounding box for this node

`Protected`bboxComputed

bboxComputed: boolean = false

Whether the bounding box has been computed yet

childNodes

childNodes: WW[]

The children of this node

dom

dom: N[] = null

The DOM tree generated for this wrapper

factory

factory: WF

The factory used to create more wrappers

font

font: FD = null

Easy access to the font parameters

lineBBox

lineBBox: LineBBox[] = []

Sizes of lines into which the element is broken

node

node: MmlNode

parent

parent: WW = null

The parent of this node

removedStyles

removedStyles: StringMap = null

Styles that must be handled directly by the wrappers (mostly having to do with fonts)

stretch

stretch: DD = ...

Delimiter data for stretching this node (NOSTRETCH means not yet determined)

styleData

styleData: StyleData = null

The padding and border information from the style attribute

styles

styles: Styles = null

The explicit styles set by the node

variant

variant: string = ''

The mathvariant for this node

`Static`BOLDVARIANTS

BOLDVARIANTS: { [name: string]: StringMap } = ...

The translation of mathvariant to bold styles, or to remove bold from a mathvariant.

`Static`ITALICVARIANTS

ITALICVARIANTS: { [name: string]: StringMap } = ...

The translation of mathvariant to italic styles, or to remove italic from a mathvariant.

`Static`kind

kind: string = 'unknown'

The wrapper kind

`Static`removeStyles

removeStyles: string[] = ...

Styles that should not be passed on from style attribute

`Static`skipAttributes

skipAttributes: { [name: string]: boolean } = ...

Non-MathML attributes on MathML elements NOT to be copied to the corresponding DOM elements. If set to false, then the attribute WILL be copied. Most of these (like the font attributes) are handled in other ways.

`Static`styles

styles: StyleJson = {}

Any styles needed for the class

Accessors

adaptor

get adaptor(): DOMAdaptor<N, T, D>
Easy access to the DOMAdaptor object

Returns DOMAdaptor<N, T, D>
The DOMAdaptor object
- Defined in ts/output/common/Wrapper.ts:441

breakCount

get breakCount(): number
Returns number
The number of breakpoints in the node
- Defined in ts/output/common/Wrapper.ts:504

containerWidth

get containerWidth(): number
Easy access to the container width

Returns number
The container width
- Defined in ts/output/common/Wrapper.ts:459

fixesPWidth

get fixesPWidth(): boolean
Returns boolean
True if children with percentage widths should be resolved by this container
- Defined in ts/output/common/Wrapper.ts:497

jax

get jax(): JX
Easy access to the output jax for this node

Returns JX
The output jax for this node
- Defined in ts/output/common/Wrapper.ts:432

kind

get kind(): string
Returns string
Inherited from AbstractWrapper.kind
- Defined in ts/core/Tree/Wrapper.ts:131

linebreakOptions

get linebreakOptions(): {
    inline: boolean;
    LinebreakVisitor: null;
    lineleading: number;
    width: string;
}
Easy access to the linebreak options

Returns { inline: boolean; LinebreakVisitor: null; lineleading: number; width: string }
The linebreak options
- Defined in ts/output/common/Wrapper.ts:484

linebreaks

get 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,
>
Easy access to the linebreak visitor

Returns 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
- Defined in ts/output/common/Wrapper.ts:469

metrics

get metrics(): Metrics
Easy access to the metric data for this node

Returns Metrics
The metric data for this node
- Defined in ts/output/common/Wrapper.ts:450

Methods

`Protected`addLeftBorders

addLeftBorders(bbox: BBox): void
Parameters
- bbox: BBox
  The bounding box where left borders are to be added
Returns void
- Defined in ts/output/common/Wrapper.ts:746

`Protected`addMiddleBorders

addMiddleBorders(bbox: BBox): void
Parameters
- bbox: BBox
  The bounding box where top and bottom borders are to be added
Returns void
- Defined in ts/output/common/Wrapper.ts:756

`Protected`addRightBorders

addRightBorders(bbox: BBox): void
Parameters
- bbox: BBox
  The bounding box where right borders are to be added
Returns void
- Defined in ts/output/common/Wrapper.ts:767

breakTop

breakTop(mrow: WW, _child: WW): WW
Parameters
- mrow: WW
  The first mrow below this node
- _child: WW
  The child containing the mrow
Returns WW
The linebreak container for the child
- Defined in ts/output/common/Wrapper.ts:526

breakToWidth

breakToWidth(_W: number): void
Parameters
- _W: number
  The width to use for linebreaking
Returns void
- Defined in ts/output/common/Wrapper.ts:811

canStretch

canStretch(direction: string): boolean
Parameters
- direction: string
  The direction to stretch this node
Returns boolean
Whether the node can stretch in that direction
- Defined in ts/output/common/Wrapper.ts:1187

`Protected`computeBBox

computeBBox(bbox: BBox, recompute?: boolean): void
Parameters
- bbox: BBox
  The bounding box to modify (either this.bbox, or an empty one)
- recompute: boolean = false
  True if we are recomputing due to changes in children that have percentage widths
Returns void
- Defined in ts/output/common/Wrapper.ts:631

`Protected`computeLineBBox

computeLineBBox(i: number): LineBBox
Compute the bounding box for the i-th line (for when it is not in the cache).
Parameters
- i: number
  The number of the line whose sizes are to be obtained
Returns LineBBox
The bounding box of the specified segment
- Defined in ts/output/common/Wrapper.ts:694

`Protected`copySkewIC

copySkewIC(bbox: BBox): void
Copy child skew and italic correction
Parameters
- bbox: BBox
  The bounding box to modify
Returns void
- Defined in ts/output/common/Wrapper.ts:836

core

core(): WW
Returns WW
The wrapper for this node's core node
- Defined in ts/output/common/Wrapper.ts:1128

coreMO

coreMO(): CommonMo<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
Returns CommonMo<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
The wrapper for this node's core node
- Defined in ts/output/common/Wrapper.ts:1135

coreRScale

coreRScale(): number
Returns number
The cumulative relative scaling for an embellised mo's core mo
- Defined in ts/output/common/Wrapper.ts:1145

`Protected`createMo

createMo(text: string): CommonMo<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
Create an mo wrapper with the given text, link it in, and give it the right defaults.
Parameters
- text: string
  The text for the wrapped element
Returns CommonMo<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>
The wrapped MmlMo node
- Defined in ts/output/common/Wrapper.ts:1433

`Protected`em

em(m: number): string
Parameters
- m: number
  A number to be shown in ems
Returns string
The number with units of ems
- Defined in ts/output/common/Wrapper.ts:1327

`Protected`embellishedBBox

embellishedBBox(i: number): LineBBox
Get the bounding box for the i-th line of an embellished mo
Parameters
- i: number
  The line number
Returns LineBBox
The bounding box for that line
- Defined in ts/output/common/Wrapper.ts:682

`Protected`explicitVariant

explicitVariant(
    fontFamily: string,
    fontWeight: string,
    fontStyle: string,
): string
Set the CSS for a token element having an explicit font (rather than regular mathvariant).
Parameters
- fontFamily: string
  The font family to use
- fontWeight: string
  The font weight to use
- fontStyle: string
  The font style to use
Returns string
The explicit font marker
- Defined in ts/output/common/Wrapper.ts:962

`Protected`getAlignShift

getAlignShift(): [string, number]
Returns [string, number]
The alignment and indentation shift for the expression
- Defined in ts/output/common/Wrapper.ts:1203

`Protected`getAlignX

getAlignX(W: number, bbox: BBox, align: string): number
Parameters
- W: number
  The total width
- bbox: BBox
  The bbox to be aligned
- align: string
  How to align (left, center, right)
Returns number
The x position of the aligned width
- Defined in ts/output/common/Wrapper.ts:1262

`Protected`getAlignY

getAlignY(H: number, D: number, h: number, d: number, align: string): number
Parameters
- H: number
  The total height
- D: number
  The total depth
- h: number
  The height to be aligned
- d: number
  The depth to be aligned
- align: string
  How to align (top, bottom, center, axis, baseline)
Returns number
The y position of the aligned baseline
- Defined in ts/output/common/Wrapper.ts:1278

getBBox

getBBox(save?: boolean): BBox
Return the wrapped node's bounding box, either the cached one, if it exists, or computed directly if not.
Parameters
- save: boolean = true
  Whether to cache the bbox or not (used for stretchy elements)
Returns BBox
The computed bounding box
- Defined in ts/output/common/Wrapper.ts:578

getBreakNode

getBreakNode(bbox: LineBBox): [WW, WW]
Find the (embellished) mo or mspace where a break occurs
Parameters
- bbox: LineBBox
  The LineBBox for the line whose initial breakpoint is needed
Returns [WW, WW]
The embellished mo node and its core mo
- Defined in ts/output/common/Wrapper.ts:704

getChildAlign

getChildAlign(_i: number): string
Parameters
- _i: number
  The index of the child element whose alignment is needed
Returns string
The alignment child element
- Defined in ts/output/common/Wrapper.ts:1306

`Protected`getChildLineBBox

getChildLineBBox(child: WW, i: number): LineBBox
Parameters
- child: WW
  The child node whose i-th line bbox is to be obtained
- i: number
  The number of the line whose bbox is to be obtained
Returns LineBBox
The bounding box of the specified line
- Defined in ts/output/common/Wrapper.ts:726

getLineBBox

getLineBBox(i: number): LineBBox
Get the bounding box for the i-th line (first and last may be part of a surrounding line). Get the bbox from the lineBBox cache, or compute it, as needed.
Parameters
- i: number
  The number of the segment whose sizes are to be obtained
Returns LineBBox
The bounding box of the specified segment
- Defined in ts/output/common/Wrapper.ts:649

`Protected`getMathMLSpacing

getMathMLSpacing(): void
Get the spacing using MathML rules based on the core MO

Returns void
- Defined in ts/output/common/Wrapper.ts:1052

getOuterBBox

getOuterBBox(save?: boolean): BBox
Return the wrapped node's bounding box that includes borders and padding
Parameters
- save: boolean = true
  Whether to cache the bbox or not (used for stretchy elements)
Returns BBox
The computed bounding box
- Defined in ts/output/common/Wrapper.ts:594

getRScale

getRScale(): number
Returns number
The cumulative relative scale from the root to the current node
- Defined in ts/output/common/Wrapper.ts:1158

`Protected`getScale

getScale(): void
Determine the scaling factor to use for this wrapped node, and set the styles for it.

Returns void
- Defined in ts/output/common/Wrapper.ts:978

`Protected`getSpace

getSpace(): void
Sets the spacing based on TeX or MathML algorithm

Returns void
- Defined in ts/output/common/Wrapper.ts:1037

`Protected`getStyleData

getStyleData(): void
Gather the data about borders and padding from the styles attribute

Returns void
- Defined in ts/output/common/Wrapper.ts:874

`Protected`getStyles

getStyles(): void
Add the style attribute, but remove any font-related styles (since these are handled separately by the variant)

Returns void
- Defined in ts/output/common/Wrapper.ts:857

`Protected`getTeXSpacing

getTeXSpacing(isTop: boolean, hasSpacing: boolean): void
Get the spacing using the TeX rules
Parameters
- isTop: boolean
  True when this is a top-level embellished operator
- hasSpacing: boolean
  True when there is an explicit or inherited 'form' attribute
Returns void
- Defined in ts/output/common/Wrapper.ts:1094

getText

getText(): string
Returns string
For a token node, the combined text content of the node's children
- Defined in ts/output/common/Wrapper.ts:1171

getUnbrokenHD

getUnbrokenHD(): [number, number]
The height and depth without linebreaks

Returns [number, number]
The height and depth
- Defined in ts/output/common/Wrapper.ts:611

`Protected`getVariant

getVariant(): void
Get the mathvariant (or construct one, if needed).

Returns void
- Defined in ts/output/common/Wrapper.ts:909

`Protected`getVariantChar

getVariantChar(variant: string, n: number): CharDataArray<CC>
Parameters
- variant: string
  The variant in which to look for the character
- n: number
  The number of the character to look up
Returns CharDataArray<CC>
The full CharData object, with CharOptions guaranteed to be defined
- Defined in ts/output/common/Wrapper.ts:1451

getWrapWidth

getWrapWidth(i: number): number
Parameters
- i: number
  The index of the child element whose container is needed
Returns number
The inner width as a container (for percentage widths)
- Defined in ts/output/common/Wrapper.ts:1298

html

html(type: string, def?: OptionList, content?: (N | T)[]): N
Parameters
- type: string
  The tag name of the HTML node to be created
- def: OptionList = {}
  The properties to set for the created node
- content: (N | T)[] = []
  The child nodes for the created HTML node
Returns N
The generated HTML tree
- Defined in ts/output/common/Wrapper.ts:1470

invalidateBBox

invalidateBBox(bubble?: boolean): void
Mark BBox to be computed again (e.g., when an mo has stretched)
Parameters
- bubble: boolean = true
  True to invalidate parent BBoxes
Returns void
- Defined in ts/output/common/Wrapper.ts:820

`Protected`isTopEmbellished

isTopEmbellished(): boolean
Returns boolean
True if this is the top-most container of an embellished operator that is itself an embellished operator (the maximal embellished operator for its core)
- Defined in ts/output/common/Wrapper.ts:1116

`Protected`length2em

length2em(length: Property, size?: number, scale?: number): number
Parameters
- length: Property
  A dimension (giving number and units) or number to be converted to ems
- size: number = 1
  The default size of the dimension (for percentage values)
- scale: number = null
  The current scaling factor (to handle absolute units)
Returns number
The dimension converted to ems
- Defined in ts/output/common/Wrapper.ts:1346

mmlNode

mmlNode(kind: string, properties?: PropertyList, children?: MmlNode[]): MmlNode
Parameters
- kind: string
  The kind of MmlNode to create
- properties: PropertyList = {}
  The properties to set initially
- children: MmlNode[] = []
  The child nodes to add to the created node
Returns MmlNode
The newly created MmlNode
- Defined in ts/output/common/Wrapper.ts:1414

mmlText

mmlText(text: string): TextNode
Parameters
- text: string
  The text from which to create a TextNode object
Returns TextNode
The TextNode with the given text
- Defined in ts/output/common/Wrapper.ts:1402

`Protected`percent

percent(m: number): string
Parameters
- m: number
  A number to be shown as a percent
Returns string
The number m as a percent
- Defined in ts/output/common/Wrapper.ts:1319

processIndent

processIndent(
    indentalign: string,
    indentshift: string,
    align?: string,
    shift?: string,
    width?: number,
): [string, number]
Parameters
- indentalign: string
  The indentalign to process
- indentshift: string
  The indentshift to process
- align: string = ''
  The default alignment for 'auto'
- shift: string = ''
  The default indentshift for 'auto'
- width: number = ...
  The container width for relative shifts
Returns [string, number]
The alignment and indentation shift (normal and last) for the Mo
- Defined in ts/output/common/Wrapper.ts:1223

`Protected`px

px(m: number, M?: number): string
Parameters
- m: number
  A number of em's to be shown as pixels
- M: number = -LENGTHS.BIGDIMEN
  The minimum number of pixels to allow
Returns string
The number with units of px
- Defined in ts/output/common/Wrapper.ts:1336

remapChars

remapChars(chars: number[]): number[]
Parameters
- chars: number[]
  The array of unicode character numbers to remap
Returns number[]
The converted array
- Defined in ts/output/common/Wrapper.ts:1394

setChildPWidths

setChildPWidths(recompute: boolean, w?: number, clear?: boolean): boolean
Recursively resolve any percentage widths in the child nodes using the given container width (or the child width, if none was passed). Overriden for mtables in order to compute the width.
Parameters
- recompute: boolean
  True if we are recomputing due to changes in children
- w: number = null
  The width of the container (from which percentages are computed)
- clear: boolean = true
  True if pwidth marker is to be cleared
Returns boolean
True if a percentage width was found
- Defined in ts/output/common/Wrapper.ts:784

`Protected`unicodeChars

unicodeChars(text: string, name?: string): number[]
Parameters
- text: string
  The text to turn into unicode locations
- name: string = ...
  The name of the variant for the characters
Returns number[]
Array of numbers represeting the string's unicode character positions
- Defined in ts/output/common/Wrapper.ts:1370

walkTree

walkTree(func: (node: WW, data?: any) => void, data?: any): any
Parameters
- func: (node: WW, data?: any) => void
- Optionaldata: any
Returns any
Inherited from AbstractWrapper.walkTree
- Defined in ts/core/Tree/Wrapper.ts:160

wrap

wrap<TT = WW>(node: MmlNode, parent?: WW): TT
Type Parameters
- TT = WW
Parameters
- node: MmlNode
  The node to the wrapped
- parent: WW = null
  The wrapped parent node
Returns TT
The newly wrapped node
Overrides AbstractWrapper.wrap
- Defined in ts/output/common/Wrapper.ts:561

`Static`addStyles

addStyles<JX>(styles: StyleJsonSheet, _jax: JX): void
Type Parameters
- JX
Parameters
- styles: StyleJsonSheet
- _jax: JX
Returns void
- Defined in ts/output/common/Wrapper.ts:354

Class CommonWrapper<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

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

Properties

Protected_breakCount

bbox

ProtectedbboxComputed

childNodes

dom

factory

font

lineBBox

node

parent

removedStyles

stretch

styleData

styles

variant

StaticBOLDVARIANTS

StaticITALICVARIANTS

Statickind

StaticremoveStyles

StaticskipAttributes

Staticstyles

Accessors

adaptor

Returns DOMAdaptor<N, T, D>

breakCount

Returns number

containerWidth

Returns number

fixesPWidth

Returns boolean

jax

Returns JX

kind

Returns string

linebreakOptions

Returns { inline: boolean; LinebreakVisitor: null; lineleading: number; width: string }

linebreaks

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

metrics

Returns Metrics

Methods

ProtectedaddLeftBorders

Parameters

Returns void

ProtectedaddMiddleBorders

Parameters

Returns void

ProtectedaddRightBorders

Parameters

Returns void

breakTop

Parameters

Returns WW

breakToWidth

Parameters

Returns void

canStretch

Parameters

Returns boolean

ProtectedcomputeBBox

Parameters

Returns void

ProtectedcomputeLineBBox

Parameters

Returns LineBBox

ProtectedcopySkewIC

`Protected`_breakCount

`Protected`bboxComputed

`Static`BOLDVARIANTS

`Static`ITALICVARIANTS

`Static`kind

`Static`removeStyles

`Static`skipAttributes

`Static`styles

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

`Protected`addLeftBorders

`Protected`addMiddleBorders

`Protected`addRightBorders

`Protected`computeBBox

`Protected`computeLineBBox

`Protected`copySkewIC

`Protected`createMo

`Protected`em

`Protected`embellishedBBox

`Protected`explicitVariant

`Protected`getAlignShift

`Protected`getAlignX

`Protected`getAlignY

`Protected`getChildLineBBox

`Protected`getMathMLSpacing

`Protected`getScale

`Protected`getSpace

`Protected`getStyleData

`Protected`getStyles

`Protected`getTeXSpacing

`Protected`getVariant

`Protected`getVariantChar