@mathjax/src
    Preparing search index...

    Interface ExplorerMathItem

    The properties added to MathItem for the Explorer

    interface ExplorerMathItem {
        _state: number;
        ariaRole: string;
        brailleNone: string;
        display: boolean;
        end: Location<HTMLElement, Text>;
        explorers: ExplorerPool;
        generatorPool: GeneratorPool<HTMLElement, Text, Document>;
        inputData: OptionList;
        inputJax: InputJax<HTMLElement, Text, Document>;
        math: string;
        metrics: Metrics;
        none: string;
        outputData: OptionList;
        refocus: string;
        roleDescription: string;
        root: MmlNode;
        semanticNodes: SemanticMap;
        start: Location<HTMLElement, Text>;
        toMathML: (
            node: MmlNode,
            math: MathItem<HTMLElement, Text, Document>,
        ) => string;
        typesetRoot: HTMLElement;
        get isEscaped(): boolean;
        attachSpeech(document: MathDocument<HTMLElement, Text, Document>): void;
        clear(): void;
        clearTemporaryFocus(focus: HTMLElement): void;
        compile(document: MathDocument<HTMLElement, Text, Document>): 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;
        explorable(document: ExplorerMathDocument, force?: boolean): void;
        getSplitNodes(node: HTMLElement): HTMLElement[];
        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;
        setTemporaryFocus(document: ExplorerMathDocument): HTMLElement;
        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;
    }
    Index
    _state ariaRole brailleNone display end explorers generatorPool inputData inputJax math metrics none outputData refocus roleDescription root semanticNodes start toMathML typesetRoot
    isEscaped
    attachSpeech clear clearTemporaryFocus compile convert detachSpeech enrich explorable getSplitNodes parseSemanticNodes removeFromDocument render rerender reset setMetrics setTemporaryFocus 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)

    ariaRole: string

    The value to use for the aria role for mjx-speech elements

    brailleNone: string

    The string to use for when there is no Braille description;

    display: boolean

    True when this math is in display mode

    end: Location<HTMLElement, Text>

    Reference to the end of the math in the document

    explorers: ExplorerPool

    The Explorer objects for this math item

    generatorPool: GeneratorPool<HTMLElement, Text, Document>

    The speech generators for this math item.

    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

    none: string

    The string to use for when there is no description;

    outputData: OptionList = {}

    Data private to the output jax

    refocus: string

    Semantic id of the rerendered element that should regain the focus.

    roleDescription: string

    The aria-roleDescription to use for the math

    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 speech is added

      Returns void

    • Parameters

      • focus: HTMLElement

        The temporary focus element, if any

      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 all nodes with the same semantic id (multiple nodes if there are line breaks).

      Parameters

      • node: HTMLElement

        The node to check if it is split

      Returns HTMLElement[]

      All the nodes for the given id

    • 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