Interface ILatexTypesetter

The interface for a LaTeX typesetter.

interface ILatexTypesetter {
    mathParseOptions?: IRenderMime.ILatexTypesetter.IMathParseOptions;
    typeset(element: HTMLElement): void | Promise<void>;
}

Hierarchy (View Summary)

Properties

mathParseOptions?

Methods

typeset

Properties

Optional ReadonlymathParseOptions

mathParseOptions?: IRenderMime.ILatexTypesetter.IMathParseOptions

Options describing how math is recognized in the source text.

These options are shared with the Markdown pre-processing step (removeMath) so that hiding math from the Markdown parser and typesetting it stay consistent. When omitted, the default options are assumed, including a single $ delimiter for inline math.

Methods

typeset

  • typeset(element: HTMLElement): void | Promise<void>

  • Typeset a DOM element.

    Parameters

    • element: HTMLElement

      the DOM element to typeset. The typesetting may happen synchronously or asynchronously.

    Returns void | Promise<void>

Settings

Member Visibility

On This Page

Properties
Methods