@mathjax/src
    Preparing search index...

    Interface ExplorerMathItem

    The properties added to MathItem for the Explorer

    interface ExplorerMathItem {
        ariaRole: string;
        display: boolean;
        explorers: ExplorerPool;
        generatorPool: GeneratorPool<HTMLElement, Text, Document>;
        inputData: OptionList;
        inputJax: InputJax<HTMLElement, Text, Document>;
        isEscaped: boolean;
        math: string;
        metrics: Metrics;
        none: string;
        refocus: string;
        roleDescription: string;
        root: MmlNode;
        start: Location<HTMLElement, Text>;
        toMathML: (
            node: MmlNode,
            math: MathItem<HTMLElement, Text, Document>,
        ) => string;
        typesetRoot: HTMLElement;
        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,
        ): void;
        detachSpeech(document: MathDocument<HTMLElement, Text, Document>): void;
        enrich(
            document: MathDocument<HTMLElement, Text, Document>,
            force?: boolean,
        ): void;
        explorable(document: HTMLDOCUMENT, force?: boolean): 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;
        state(state?: number, restore?: boolean): number;
        typeset(document: MathDocument<HTMLElement, Text, Document>): void;
        unEnrich(document: MathDocument<HTMLElement, Text, Document>): void;
        updateDocument(document: MathDocument<HTMLElement, Text, Document>): void;
    }
    Index

    Properties

    ariaRole display explorers generatorPool inputData inputJax isEscaped math metrics none refocus roleDescription root start toMathML typesetRoot

    Methods

    attachSpeech clear clearTemporaryFocus compile convert detachSpeech enrich explorable removeFromDocument render rerender reset setMetrics setTemporaryFocus state typeset unEnrich updateDocument

    Properties

    ariaRole: string

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

    display: boolean

    Whether the math is in display mode or inline mode

    explorers: ExplorerPool

    The Explorer objects for this math item

    generatorPool: GeneratorPool<HTMLElement, Text, Document>

    The speech generators for this math item.

    inputData: OptionList

    Extra data needed by the input or output jax, as needed

    inputJax: InputJax<HTMLElement, Text, Document>

    The input jax used to process the math

    isEscaped: boolean

    Whether this item is an escaped character or not

    math: string

    The string representing the expression to be processed

    metrics: Metrics

    The metric information at the location of the math (the em-size, scaling factor, etc.)

    none: string

    The string to use for when there is no description;

    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

    The internal format for this expression (once compiled)

    start: Location<HTMLElement, Text>

    The start and ending locations in the document of this expression

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

    The serialization visitor

    typesetRoot: HTMLElement

    The typeset version of the expression (once typeset)

    Methods

    • Parameters

      • document: MathDocument<HTMLElement, Text, Document>

        The document where speech is added

      Returns void

    • Clear any data (the MathItem's container is being removed)

      Returns void

    • Parameters

      • focus: HTMLElement

        The temporary focus element, if any

      Returns void

    • Converts the expression into the internal format by calling the input jax

      Parameters

      • document: MathDocument<HTMLElement, Text, Document>

        The MathDocument in which the math resides

      Returns void

    • Converts the expression by calling the render actions until the state matches the end state

      Parameters

      • document: MathDocument<HTMLElement, Text, Document>

        The MathDocument in which the math resides

      • Optionalend: number

        The state to end rerendering at (default = LAST)

      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

    • Parameters

      • document: HTMLDOCUMENT

        The document where the Explorer is being added

      • Optionalforce: boolean

        True to force the explorer even if enableExplorer is false

      Returns void

    • Removes the typeset version from the document, optionally replacing the original form of the expression and its delimiters.

      Parameters

      • restore: boolean

        True if the original version is to be restored

      Returns void

    • Perform the renderActions on the document

      Parameters

      • document: MathDocument<HTMLElement, Text, Document>

        The MathDocument in which the math resides

      Returns void

    • Rerenders an already rendered item and inserts it into the document

      Parameters

      • document: MathDocument<HTMLElement, Text, Document>

        The MathDocument in which the math resides

      • Optionalstart: number

        The state to start rerendering at (default = RERENDER)

      Returns void

    • Reset the item to its unprocessed state

      Parameters

      • Optionalrestore: boolean

        True if the original form should be restored to the document when rolling back a typeset version

      Returns void

    • Sets the metric information for this expression

      Parameters

      • em: number

        The size of 1 em in pixels

      • ex: number

        The size of 1 ex in pixels

      • cwidth: number

        The container width in pixels

      • scale: number

        The scaling factor (unitless)

      Returns void

    • Set or return the current processing state of this expression, optionally restoring the document if rolling back an expression that has been added to the document.

      Parameters

      • Optionalstate: number

        The state to set for the expression

      • Optionalrestore: boolean

        True if the original form should be restored to the document when rolling back a typeset version

      Returns number

      The current state

    • Converts the internal format to the typeset version by calling the output jax

      Parameters

      • document: MathDocument<HTMLElement, Text, Document>

        The MathDocument in which the math resides

      Returns void

    • Inserts the typeset version in place of the original form in the document

      Parameters

      • document: MathDocument<HTMLElement, Text, Document>

        The MathDocument in which the math resides

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods