@mathjax/src
    Preparing search index...

    Interface AssistiveMmlMathItem<N, T, D>

    The functions added to MathItem for assistive MathML

    interface AssistiveMmlMathItem<N, T, D> {
        _state: number;
        display: boolean;
        end: Location<N, T>;
        inputData: OptionList;
        inputJax: InputJax<N, T, D>;
        math: string;
        metrics: Metrics;
        outputData: OptionList;
        root: MmlNode;
        start: Location<N, T>;
        typesetRoot: N;
        get isEscaped(): boolean;
        assistiveMml(document: MathDocument<N, T, D>, force?: boolean): void;
        clear(): void;
        compile(document: MathDocument<N, T, D>): void;
        convert(document: MathDocument<N, T, D>, end?: number): MmlNode | N;
        removeFromDocument(_restore?: boolean): void;
        render(document: MathDocument<N, T, D>): void;
        rerender(document: MathDocument<N, T, D>, start?: number): void;
        reset(restore?: boolean): void;
        setMetrics(em: number, ex: number, cwidth: number, scale: number): void;
        state(state?: number, restore?: boolean): number;
        typeset(document: MathDocument<N, T, D>): void;
        updateDocument(_document: MathDocument<N, T, D>): void;
    }

    Type Parameters

    • N

      The HTMLElement node class

    • T

      The Text node class

    • D

      The Document class

    Hierarchy (View Summary)

    Index
    _state display end inputData inputJax math metrics outputData root start typesetRoot
    isEscaped
    assistiveMml clear compile convert removeFromDocument render rerender reset setMetrics state typeset updateDocument

    Protected_state

    _state: number = STATE.UNPROCESSED

    The current state of the item (how far in the render actions it has been processed)

    display: boolean

    True when this math is in display mode

    end: Location<N, T>

    Reference to the end of the math in the document

    inputData: OptionList = {}

    Data private to the input jax

    inputJax: InputJax<N, T, D>

    The input jax associated with this item

    math: string

    The source text for the math (e.g., TeX string)

    metrics: Metrics = ...

    The metric information about the surrounding environment

    outputData: OptionList = {}

    Data private to the output jax

    root: MmlNode = null

    The compiled internal MathML (result of InputJax)

    start: Location<N, T>

    Reference to the beginning of the math in the document

    typesetRoot: N = null

    The typeset result (result of OutputJax)

    • get isEscaped(): boolean

      Returns boolean

      True when this item is an escaped delimiter

    • Parameters

      • document: MathDocument<N, T, D>

        The document where assistive MathML is being added

      • Optionalforce: boolean

        True to force assistive MathML even if enableAssistiveMml is false

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Accessors
    Methods