@mathjax/src
    Preparing search index...

    Interface ExplorerMathDocument

    The functions added to MathDocument for the Explorer

    interface ExplorerMathDocument {
        _actionPromises: Promise<void>[];
        _readyPromise: Promise<any>;
        activeItem: ExplorerMathItem;
        adaptor: DOMAdaptor<HTMLElement, Text, Document>;
        document: Document;
        explorerRegions: RegionPool;
        infoIcon: HTMLElement;
        inputJax: InputJax<HTMLElement, Text, Document>[];
        math: MathList<HTMLElement, Text, Document>;
        mmlFactory: MmlFactory;
        options: OptionList;
        outputJax: OutputJax<HTMLElement, Text, Document>;
        processed: BitField;
        renderActions: RenderList<HTMLElement, Text, Document>;
        tmpFocus: HTMLElement;
        webworker: WorkerHandler<HTMLElement, Text, Document>;
        get kind(): string;
        actionPromises(): Promise<void[]>;
        addRenderAction(id: string, ...action: any[]): void;
        attachSpeech(): SpeechMathDocument<HTMLElement, Text, Document>;
        clear(): ExplorerMathDocument;
        clearMathItemsWithin(
            containers: ContainerList<HTMLElement>,
        ): MathItem<HTMLElement, Text, Document>[];
        clearPromises(): void;
        compile(): ExplorerMathDocument;
        compileError(math: MathItem<HTMLElement, Text, Document>, err: Error): void;
        compileMath(math: MathItem<HTMLElement, Text, Document>): void;
        concat(list: MathList<HTMLElement, Text, Document>): ExplorerMathDocument;
        convert(math: string, options?: OptionList): any;
        convertPromise(math: string, options?: OptionList): Promise<any>;
        done(): Promise<void>;
        enrich(): EnrichedMathDocument<HTMLElement, Text, Document>;
        enrichError(
            doc: EnrichedMathDocument<HTMLElement, Text, Document>,
            math: EnrichedMathItem<HTMLElement, Text, Document>,
            err: Error,
        ): void;
        explorable(): HTMLDOCUMENT;
        findMath(_options?: OptionList): ExplorerMathDocument;
        getMathItemsWithin(
            elements: ContainerList<HTMLElement>,
        ): MathItem<HTMLElement, Text, Document>[];
        getMetrics(): ExplorerMathDocument;
        getWebworker(): void;
        removeFromDocument(_restore?: boolean): ExplorerMathDocument;
        removeRenderAction(id: string): void;
        render(): ExplorerMathDocument;
        renderPromise(): Promise<any>;
        rerender(start?: number): ExplorerMathDocument;
        rerenderPromise(start?: number): Promise<any>;
        reset(options?: ResetList): ExplorerMathDocument;
        savePromise(promise: Promise<any>): void;
        speechError(
            doc: SpeechMathDocument<HTMLElement, Text, Document>,
            math: SpeechMathItem<HTMLElement, Text, Document>,
            err: Error,
        ): void;
        state(state: number, restore?: boolean): ExplorerMathDocument;
        typeset(): ExplorerMathDocument;
        typesetError(math: MathItem<HTMLElement, Text, Document>, err: Error): void;
        updateDocument(): ExplorerMathDocument;
        whenReady(action: () => any): Promise<any>;
    }
    Index

    Properties

    _actionPromises _readyPromise activeItem adaptor document explorerRegions infoIcon inputJax math mmlFactory options outputJax processed renderActions tmpFocus webworker

    Accessors

    kind

    Methods

    actionPromises addRenderAction attachSpeech clear clearMathItemsWithin clearPromises compile compileError compileMath concat convert convertPromise done enrich enrichError explorable findMath getMathItemsWithin getMetrics getWebworker removeFromDocument removeRenderAction render renderPromise rerender rerenderPromise reset savePromise speechError state typeset typesetError updateDocument whenReady

    Properties

    Protected_actionPromises

    _actionPromises: Promise<void>[]

    The render action promise list

    Protected_readyPromise

    _readyPromise: Promise<any>

    Promise for the current typeset or conversion action (used to chain the promise-based calls so they don't overlap).

    activeItem: ExplorerMathItem

    The MathItem with the active KeyExplorer, if any

    adaptor: DOMAdaptor<HTMLElement, Text, Document>

    The DOM adaptor for the document

    document: Document

    The document managed by this MathDocument

    explorerRegions: RegionPool

    The objects needed for the explorer

    infoIcon: HTMLElement

    The info icon for the selected expression

    inputJax: InputJax<HTMLElement, Text, Document>[]

    The list of input jax for the document

    math: MathList<HTMLElement, Text, Document>

    The list of MathItems for this document

    mmlFactory: MmlFactory

    The MathML node factory for the internal MathML representation

    options: OptionList

    The actual options for this document (with user-supplied ones merged in)

    outputJax: OutputJax<HTMLElement, Text, Document>

    The output jax for the document

    processed: BitField

    The bit-field used to tell what steps have been taken on the document (for retries)

    renderActions: RenderList<HTMLElement, Text, Document>

    The list of render actions

    tmpFocus: HTMLElement

    An element ot use for temporary focus during rerendering

    webworker: WorkerHandler<HTMLElement, Text, Document>

    The webworker handler for the document

    Accessors

    Methods

    • Returns Promise<void[]>

    • Parameters

      • id: string
      • ...action: any[]

      Returns void

    • Produce an error using MmlNodes

      Parameters

      • math: MathItem<HTMLElement, Text, Document>

        The MathItem producing the error

      • err: Error

        The Error object for the error

      Returns void

    • Parameters

      • math: MathItem<HTMLElement, Text, Document>

        The item to compile

      Returns void

    • Add the Explorer to the MathItems in the MathDocument

      Returns HTMLDOCUMENT

      The MathDocument (so calls can be chained)

    • Set up the worker handler for this document

      Returns void

    • Parameters

      • id: string

      Returns void

    • Parameters

      • start: number = STATE.RERENDER

      Returns Promise<any>

    • Parameters

      • promise: Promise<any>

      Returns void

    • Parameters

      • doc: SpeechMathDocument<HTMLElement, Text, Document>

        The MathDocument for the error

      • math: SpeechMathItem<HTMLElement, Text, Document>

        The MathItem causing the error

      • err: Error

        The error being processed

      Returns void

    • Produce an error using HTML

      Parameters

      • math: MathItem<HTMLElement, Text, Document>

        The MathItem producing the error

      • err: Error

        The Error object for the error

      Returns void

    • Parameters

      • action: () => any

      Returns Promise<any>

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods