@mathjax/src
    Preparing search index...

    Interface MenuMathItem

    The new function for MathItem that adds the context menu

    interface MenuMathItem {
        _state: number;
        display: boolean;
        end: Location<HTMLElement, Text>;
        generatorPool: GeneratorPool<HTMLElement, Text, Document>;
        initialID: number;
        inputData: OptionList;
        inputJax: InputJax<HTMLElement, Text, Document>;
        math: string;
        metrics: Metrics;
        outputData: OptionList;
        root: MmlNode;
        semanticNodes: SemanticMap;
        start: Location<HTMLElement, Text>;
        toMathML: (
            node: MmlNode,
            math: MathItem<HTMLElement, Text, Document>,
        ) => string;
        typesetRoot: HTMLElement;
        get isEscaped(): boolean;
        addMenu(document: MenuMathDocument, force?: boolean): void;
        assistiveMml(
            document: MathDocument<HTMLElement, Text, Document>,
            force?: boolean,
        ): void;
        attachSpeech(document: MathDocument<HTMLElement, Text, Document>): void;
        checkLoading(document: MenuMathDocument): void;
        clear(): void;
        compile(document: MathDocument<HTMLElement, Text, Document>): void;
        complexity(
            document: ComplexityMathDocument<HTMLElement, Text, Document>,
            force?: boolean,
        ): void;
        convert(
            document: MathDocument<HTMLElement, Text, Document>,
            end?: number,
        ): HTMLElement | MmlNode;
        detachSpeech(document: MathDocument<HTMLElement, Text, Document>): void;
        enrich(
            document: MathDocument<HTMLElement, Text, Document>,
            force?: boolean,
        ): void;
        getMenus(document: MenuMathDocument): void;
        parseSemanticNodes(): void;
        removeFromDocument(_restore?: boolean): void;
        render(document: MathDocument<HTMLElement, Text, Document>): void;
        rerender(
            document: MathDocument<HTMLElement, Text, Document>,
            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<HTMLElement, Text, Document>): void;
        unEnrich(document: MathDocument<HTMLElement, Text, Document>): void;
        updateDocument(_document: MathDocument<HTMLElement, Text, Document>): void;
    }

    Hierarchy (View Summary)

    Index
    _state display end generatorPool initialID inputData inputJax math metrics outputData root semanticNodes start toMathML typesetRoot
    isEscaped
    addMenu assistiveMml attachSpeech checkLoading clear compile complexity convert detachSpeech enrich getMenus 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<HTMLElement, Text>

    Reference to the end of the math in the document

    generatorPool: GeneratorPool<HTMLElement, Text, Document>

    The speech generators for this math item.

    initialID: number

    The starting collapse ID for this expression

    inputData: OptionList = {}

    Data private to the input jax

    inputJax: InputJax<HTMLElement, Text, Document>

    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<HTMLElement, Text>

    Reference to the beginning of the math in the document

    toMathML: (node: MmlNode, math: MathItem<HTMLElement, Text, Document>) => string

    The serialization visitor

    typesetRoot: HTMLElement = null

    The typeset result (result of OutputJax)

    • get isEscaped(): boolean

      Returns boolean

      True when this item is an escaped delimiter

    • Parameters

      • document: MathDocument<HTMLElement, Text, Document>

        The document where assistive MathML is being added

      • Optionalforce: boolean

        True to force assistive MathML even if enableAssistiveMml is false

      Returns void

    • Parameters

      • document: MathDocument<HTMLElement, Text, Document>

        The document where speech is added

      Returns void

    • Parameters

      • document: ComplexityMathDocument<HTMLElement, Text, Document>

        The MathDocument for the MathItem

      • Optionalforce: boolean

        True to force the computation even if enableComplexity is false

      Returns void

    • Parameters

      • document: MathDocument<HTMLElement, Text, Document>

        The MathDocument for the MathItem

      Returns void

    • Parameters

      • document: MathDocument<HTMLElement, Text, Document>

        The document where enrichment is occurring

      • Optionalforce: boolean

        True to force the enrichment even if not enabled

      Returns void

    • Get any extra nodes outside the DOM tree from the semantic structure

      Returns void

    • Parameters

      • _restore: boolean = false

      Returns void

    • Parameters

      • document: MathDocument<HTMLElement, Text, Document>
      • start: number = STATE.RERENDER

      Returns void

    • Parameters

      • restore: boolean = false

      Returns void

    • Parameters

      • em: number
      • ex: number
      • cwidth: number
      • scale: number

      Returns void

    • Parameters

      • mml: string

        The MathML whose speech is needed.

      Returns Promise<[string, string]>

      A promise for the speech and braille strings

    • Parameters

      • state: number = null
      • restore: boolean = false

      Returns number

    • Parameters

      • mml: string

        The MathML string to enrich

      Returns string

      The enriched MathML

    Settings
    Member Visibility

    On This Page
    Properties
    Accessors
    Methods