@mathjax/src
    Preparing search index...

    Interface InputJax<N, T, D>

    The InputJax interface

    interface InputJax<N, T, D> {
        adaptor: DOMAdaptor<N, T, D>;
        mmlFactory: MmlFactory;
        name: string;
        options: OptionList;
        preFilters: FunctionList;
        processStrings: boolean;
        compile(math: MathItem<N, T, D>, document: MathDocument<N, T, D>): MmlNode;
        findMath(which: string[] | N, options?: OptionList): ProtoItem<N, T>[];
        initialize(): void;
        reset(...args: any[]): void;
        setAdaptor(adaptor: DOMAdaptor<N, T, D>): void;
        setMmlFactory(mmlFactory: MmlFactory): void;
    }

    Type Parameters

    • N

      The HTMLElement node class

    • T

      The Text node class

    • D

      The Document class

    Implemented by

    Index

    Properties

    adaptor mmlFactory name options preFilters processStrings

    Methods

    compile findMath initialize reset setAdaptor setMmlFactory

    Properties

    adaptor: DOMAdaptor<N, T, D>

    The DOM adaptor for managing HTML elements

    mmlFactory: MmlFactory

    The MmlFactory for this input jax

    name: string

    The name of the input jax subclass (e.g,. 'TeX')

    options: OptionList

    The options for this input jax instance

    preFilters: FunctionList

    Lists of pre- and post-filters to call before and after processing the input

    processStrings: boolean

    Whether this input jax processes string arrays or DOM nodes (TeX and AsciiMath process strings, MathML processes DOM nodes)

    Methods

    • Finds the math within the DOM or the list of strings

      Parameters

      • which: string[] | N

        The element or array of strings to be searched for math

      • Optionaloptions: OptionList

        The options for the search, if any

      Returns ProtoItem<N, T>[]

      Array of proto math items found (further processed by the handler to produce actual MathItem objects)

    • Do any initialization that depends on the document being set up

      Returns void

    • Reset any needed features of the input jax

      Parameters

      • ...args: any[]

        The arguments needed by the reset operation

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods