@mathjax/src
    Preparing search index...

    Interface SpeechMathItem<N, T, D>

    The functions added to MathItem for enrichment

    interface SpeechMathItem<N, T, D> {
        _state: number;
        display: boolean;
        end: Location<N, T>;
        generatorPool: GeneratorPool<N, T, D>;
        inputData: OptionList;
        inputJax: InputJax<N, T, D>;
        math: string;
        metrics: Metrics;
        outputData: OptionList;
        root: MmlNode;
        semanticNodes: SemanticMap;
        start: Location<N, T>;
        toMathML: (node: MmlNode, math: MathItem<N, T, D>) => string;
        typesetRoot: N;
        get isEscaped(): boolean;
        attachSpeech(document: MathDocument<N, T, D>): void;
        clear(): void;
        compile(document: MathDocument<N, T, D>): void;
        convert(document: MathDocument<N, T, D>, end?: number): MmlNode | N;
        detachSpeech(document: MathDocument<N, T, D>): void;
        enrich(document: MathDocument<N, T, D>, force?: boolean): void;
        parseSemanticNodes(): void;
        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;
        speechFor(mml: string): Promise<[string, string]>;
        state(state?: number, restore?: boolean): number;
        toEnriched(mml: string): string;
        typeset(document: MathDocument<N, T, D>): void;
        unEnrich(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 generatorPool inputData inputJax math metrics outputData root semanticNodes start toMathML typesetRoot
    isEscaped
    attachSpeech clear compile convert detachSpeech enrich parseSemanticNodes removeFromDocument render rerender reset setMetrics speechFor state toEnriched typeset unEnrich 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

    generatorPool: GeneratorPool<N, T, D>

    The speech generators for this math item.

    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)

    semanticNodes: SemanticMap

    Maps semantic ids to extra nodes outside the DOM subtree.

    start: Location<N, T>

    Reference to the beginning of the math in the document

    toMathML: (node: MmlNode, math: MathItem<N, T, D>) => string

    The serialization visitor

    typesetRoot: N = null

    The typeset result (result of OutputJax)

    • get isEscaped(): boolean

      Returns boolean

      True when this item is an escaped delimiter

    • Parameters

      • mml: string

        The MathML whose speech is needed.

      Returns Promise<[string, string]>

      A promise for the speech and braille strings

    Settings
    Member Visibility

    On This Page
    Properties
    Accessors
    Methods