Options
All
  • Public
  • Public/Protected
  • All
Menu

Module rendermime

Index

Variables

Const ILatexTypesetter

ILatexTypesetter: Token<ILatexTypesetter>

The latex typesetter token.

Const IRenderMimeRegistry

IRenderMimeRegistry: Token<IRenderMimeRegistry>

The rendermime token.

Const htmlRendererFactory

htmlRendererFactory: IRendererFactory

A mime renderer factory for raw html.

Const imageRendererFactory

imageRendererFactory: IRendererFactory

A mime renderer factory for images.

Const javaScriptRendererFactory

javaScriptRendererFactory: IRendererFactory

A placeholder factory for rendered JavaScript.

Const latexRendererFactory

latexRendererFactory: IRendererFactory

A mime renderer factory for LaTeX.

Const markdownRendererFactory

markdownRendererFactory: IRendererFactory

A mime renderer factory for Markdown.

Const standardRendererFactories

standardRendererFactories: ReadonlyArray<IRendererFactory>

The standard factories provided by the rendermime package.

Const svgRendererFactory

svgRendererFactory: IRendererFactory

A mime renderer factory for svg.

Const textRendererFactory

textRendererFactory: IRendererFactory

A mime renderer factory for plain and jupyter console text data.

Functions

removeMath

  • removeMath(text: string): { math: string[]; text: string }
  • Break up the text into its component parts and search through them for math delimiters, braces, linebreaks, etc. Math delimiters must match and braces must balance. Don't allow math to pass through a double linebreak (which will be a paragraph).

    Parameters

    • text: string

    Returns { math: string[]; text: string }

    • math: string[]
    • text: string

renderHTML

  • renderHTML(options: IOptions): Promise<void>
  • Render HTML into a host node.

    params

    options - The options for rendering.

    Parameters

    Returns Promise<void>

    A promise which resolves when rendering is complete.

renderImage

  • Render an image into a host node.

    params

    options - The options for rendering.

    Parameters

    Returns Promise<void>

    A promise which resolves when rendering is complete.

renderLatex

  • Render LaTeX into a host node.

    params

    options - The options for rendering.

    Parameters

    Returns Promise<void>

    A promise which resolves when rendering is complete.

renderMarkdown

  • Render Markdown into a host node.

    params

    options - The options for rendering.

    Parameters

    Returns Promise<void>

    A promise which resolves when rendering is complete.

renderSVG

  • Render SVG into a host node.

    params

    options - The options for rendering.

    Parameters

    Returns Promise<void>

    A promise which resolves when rendering is complete.

renderText

  • Render text into a host node.

    params

    options - The options for rendering.

    Parameters

    Returns Promise<void>

    A promise which resolves when rendering is complete.

replaceMath

  • replaceMath(text: string, math: string[]): string
  • Put back the math strings that were saved, and clear the math array (no need to keep it around).

    Parameters

    • text: string
    • math: string[]

    Returns string

Generated using TypeDoc