@mathjax/src
    Preparing search index...

    Interface CommonMo<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>

    The CommonMo interface

    interface CommonMo<
        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>,
    > {
        _breakCount: number;
        bbox: BBox;
        bboxComputed: boolean;
        breakStyle: string;
        childNodes: WW[];
        dom: N[];
        embellishedBreakCount: number;
        embellishedBreakStyle: string;
        factory: WF;
        font: FD;
        isAccent: boolean;
        lineBBox: LineBBox[];
        multChar: CommonMo<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>;
        node: MmlNode;
        parent: WW;
        removedStyles: StringMap;
        size: number;
        stretch: DD;
        styleData: StyleData;
        styles: Styles;
        variant: string;
        get adaptor(): DOMAdaptor<N, T, D>;
        get breakCount(): number;
        get containerWidth(): number;
        get fixesPWidth(): boolean;
        get jax(): JX;
        get kind(): string;
        get linebreakOptions(): {
            inline: boolean;
            LinebreakVisitor: null;
            lineleading: number;
            width: string;
        };
        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,
        >;
        get metrics(): Metrics;
        addLeftBorders(bbox: BBox): void;
        addMiddleBorders(bbox: BBox): void;
        addRightBorders(bbox: BBox): void;
        breakTop(mrow: WW, _child: WW): WW;
        breakToWidth(_W: number): void;
        canStretch(direction: string): boolean;
        checkExtendedHeight(D: number, C: DelimiterData): number;
        computeBBox(bbox: BBox, recompute?: boolean): void;
        computeLineBBox(i: number): LineBBox;
        copySkewIC(bbox: BBox): void;
        core(): WW;
        coreMO(): CommonMo<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>;
        coreRScale(): number;
        createMo(
            text: string,
        ): CommonMo<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>;
        em(m: number): string;
        embellishedBBox(i: number): LineBBox;
        explicitVariant(
            fontFamily: string,
            fontWeight: string,
            fontStyle: string,
        ): string;
        getAccentOffset(): number;
        getAlignShift(): [string, number];
        getAlignX(W: number, bbox: BBox, align: string): number;
        getAlignY(
            H: number,
            D: number,
            h: number,
            d: number,
            align: string,
        ): number;
        getBaseline(WHD: number[], HD: number, C: DelimiterData): number[];
        getBBox(save?: boolean): BBox;
        getBreakNode(bbox: LineBBox): [WW, WW];
        getBreakStyle(linebreak?: string): string;
        getCenterOffset(bbox?: BBox): number;
        getChildAlign(_i: number): string;
        getChildLineBBox(child: WW, i: number): LineBBox;
        getLineBBox(i: number): LineBBox;
        getMathMLSpacing(): void;
        getMultChar(): void;
        getOuterBBox(save?: boolean): BBox;
        getRScale(): number;
        getScale(): void;
        getSize(name: string, value: number): number;
        getSpace(): void;
        getStretchBBox(WHD: number[], D: number, C: DelimiterData): void;
        getStretchedVariant(WH: number[], exact?: boolean): void;
        getStyleData(): void;
        getStyles(): void;
        getTeXSpacing(isTop: boolean, hasSpacing: boolean): void;
        getText(): string;
        getUnbrokenHD(): [number, number];
        getVariant(): void;
        getVariantChar(variant: string, n: number): CharDataArray<CC>;
        getWH(WH: number[]): number;
        getWrapWidth(i: number): number;
        html(type: string, def?: OptionList, content?: (N | T)[]): N;
        invalidateBBox(bubble?: boolean): void;
        isTopEmbellished(): boolean;
        length2em(length: Property, size?: number, scale?: number): number;
        mmlNode(
            kind: string,
            properties?: PropertyList,
            children?: MmlNode[],
        ): MmlNode;
        mmlText(text: string): TextNode;
        moLineBBox(i: number, style: string, obox?: BBox): LineBBox;
        percent(m: number): string;
        processIndent(
            indentalign: string,
            indentshift: string,
            align?: string,
            shift?: string,
            width?: number,
        ): [string, number];
        protoBBox(bbox: BBox): void;
        px(m: number, M?: number): string;
        remapChars(chars: number[]): number[];
        setBreakStyle(linebreak?: string): void;
        setChildPWidths(recompute: boolean, w?: number, clear?: boolean): boolean;
        unicodeChars(text: string, name?: string): number[];
        walkTree(func: (node: WW, data?: any) => void, data?: any): any;
        wrap<TT = WW>(node: MmlNode, parent?: WW): TT;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    _breakCount bbox bboxComputed breakStyle childNodes dom embellishedBreakCount embellishedBreakStyle factory font isAccent lineBBox multChar node parent removedStyles size stretch styleData styles variant

    Accessors

    adaptor breakCount containerWidth fixesPWidth jax kind linebreakOptions linebreaks metrics

    Methods

    addLeftBorders addMiddleBorders addRightBorders breakTop breakToWidth canStretch checkExtendedHeight computeBBox computeLineBBox copySkewIC core coreMO coreRScale createMo em embellishedBBox explicitVariant getAccentOffset getAlignShift getAlignX getAlignY getBaseline getBBox getBreakNode getBreakStyle getCenterOffset getChildAlign getChildLineBBox getLineBBox getMathMLSpacing getMultChar getOuterBBox getRScale getScale getSize getSpace getStretchBBox getStretchedVariant getStyleData getStyles getTeXSpacing getText getUnbrokenHD getVariant getVariantChar getWH getWrapWidth html invalidateBBox isTopEmbellished length2em mmlNode mmlText moLineBBox percent processIndent protoBBox px remapChars setBreakStyle setChildPWidths unicodeChars walkTree wrap

    Properties

    Protected_breakCount

    _breakCount: number = -1

    The cached number of linebreaks

    bbox: BBox

    The bounding box for this node

    bboxComputed: boolean = false

    Whether the bounding box has been computed yet

    breakStyle: string

    The linebreak style

    childNodes: WW[]

    The children of this node

    dom: N[] = null

    The DOM tree generated for this wrapper

    embellishedBreakCount: number

    Value is 1 if this embellished mo is a breakpoint, 0 otherwise

    embellishedBreakStyle: string

    The break style string for this embellished operator

    factory: WF

    The factory used to create more wrappers

    font: FD = null

    Easy access to the font parameters

    isAccent: boolean

    True if used as an accent in an munderover construct

    lineBBox: LineBBox[] = []

    Sizes of lines into which the element is broken

    multChar: CommonMo<N, T, D, JX, WW, WF, WC, CC, VV, DD, FD, FC>

    The linebreakmultchar used for breaking an invisible times

    node: MmlNode
    parent: WW = null

    The parent of this node

    removedStyles: StringMap = null

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

    size: number

    The font size that a stretched operator uses. If -1, then stretch arbitrarily, and bbox gives the actual height, depth, width

    stretch: DD = ...

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

    styleData: StyleData = null

    The padding and border information from the style attribute

    styles: Styles = null

    The explicit styles set by the node

    variant: string = ''

    The mathvariant for this node

    Accessors

    • get breakCount(): number

      Returns number

      The number of breakpoints in the node

    • get containerWidth(): number

      Easy access to the container width

      Returns number

      The container width

    • get fixesPWidth(): boolean

      Returns boolean

      True if children with percentage widths should be resolved by this container

    • 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

    Methods

    • Determine the size of the delimiter based on whether full extenders should be used or not.

      Parameters

      • D: number

        The requested size of the delimiter

      • C: DelimiterData

        The data for the delimiter

      Returns number

      The final size of the assembly

    • 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

    • 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

    • 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

    • Parameters

      • WHD: number[]

        The [H, D] being requested from the parent mrow

      • HD: number

        The full height (including symmetry, etc)

      • C: DelimiterData

        The delimiter data for the stretchy character

      Returns number[]

      The height and depth for the vertically stretched delimiter

    • 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

    • Get the breakstyle of the mo

      Parameters

      • Optionallinebreak: string

        Force style to be the given one

      Returns string

      The linebreak style of the node

    • 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

    • 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

    • Parameters

      • name: string

        The name of the attribute to get

      • value: number

        The default value to use

      Returns number

      The size in em's of the attribute (or the default value)

    • Parameters

      • WHD: number[]

        The [W] or [H, D] being requested from the parent mrow

      • D: number

        The full dimension (including symmetry, etc)

      • C: DelimiterData

        The delimiter data for the stretchy character

      Returns void

    • Determint variant for vertically/horizontally stretched character

      Parameters

      • WH: number[]

        Size to stretch to, either [W] or [H, D]

      • Optionalexact: boolean

        True if not allowed to use delimiter factor and shortfall

      Returns 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

    • Parameters

      • WH: number[]

        Either [W] for width, [H, D] for height and depth, or [] for min/max size

      Returns number

      Either the width or the total height of the character

    • 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

    • 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

    • 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

    • Set a breakpoint to the given type

      Parameters

      • Optionallinebreak: string

        The type of linebreak to set

      Returns void

    • 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

    • 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

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods