@mathjax/src
    Preparing search index...

    Interface SpeechMathDocument<N, T, D>

    The functions added to MathDocument for enrichment

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

    Type Parameters

    • N

      The HTMLElement node class

    • T

      The Text node class

    • D

      The Document class

    Hierarchy (View Summary)

    Index

    Properties

    _actionPromises _readyPromise adaptor document inputJax math mmlFactory options outputJax processed renderActions webworker

    Accessors

    kind

    Methods

    actionPromises addRenderAction attachSpeech clear clearMathItemsWithin clearPromises compile compileError compileMath concat convert convertPromise done enrich enrichError 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).

    adaptor: DOMAdaptor<N, T, D>

    The DOM adaptor for the document

    document: D

    The document managed by this MathDocument

    inputJax: InputJax<N, T, D>[]

    The list of input jax for the document

    math: MathList<N, T, D>

    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<N, T, D>

    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<N, T, D>

    The list of render actions

    webworker: WorkerHandler<N, T, D>

    The webworker handler for the document

    Accessors

    Methods

    • Set up the worker handler for this document

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods