@mathjax/src
    Preparing search index...

    Interface OutputJax<N, T, D>

    The OutputJax interface

    interface OutputJax<N, T, D> {
        adaptor: DOMAdaptor<N, T, D>;
        name: string;
        options: OptionList;
        postFilters: FunctionList;
        escaped(math: MathItem<N, T, D>, document?: MathDocument<N, T, D>): N;
        getMetrics(document: MathDocument<N, T, D>): void;
        initialize(): void;
        pageElements(document: MathDocument<N, T, D>): N;
        reset(...args: any[]): void;
        setAdaptor(adaptor: DOMAdaptor<N, T, D>): void;
        styleSheet(document: MathDocument<N, T, D>): N;
        typeset(math: MathItem<N, T, D>, document?: MathDocument<N, T, D>): N;
    }

    Type Parameters

    • N

      The HTMLElement node class

    • T

      The Text node class

    • D

      The Document class

    Implemented by

    Index

    Properties

    adaptor name options postFilters

    Methods

    escaped getMetrics initialize pageElements reset setAdaptor styleSheet typeset

    Properties

    adaptor: DOMAdaptor<N, T, D>

    The DOM adaptor for managing HTML elements

    name: string

    The name of this output jax class

    options: OptionList

    The options for the instance

    postFilters: FunctionList

    Lists of post-filters to call after typesetting the math

    Methods

    • Handle an escaped character (e.g., $ from the TeX input jax preventing it from being a delimiter)

      Parameters

      • math: MathItem<N, T, D>

        The MathItem to be escaped

      • Optionaldocument: MathDocument<N, T, D>

        The MathDocument in which the math occurs

      Returns N

      The DOM tree for the escaped item

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

      Returns void

    • Reset any needed features of the output jax

      Parameters

      • ...args: any[]

        The arguments needed by the reset operation

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods