Interface IRenderMimeRegistry

interface IRenderMimeRegistry {
    latexTypesetter: null | IRenderMime.ILatexTypesetter;
    linkHandler: null | IRenderMime.ILinkHandler;
    markdownParser: null | IRenderMime.IMarkdownParser;
    mimeTypes: readonly string[];
    resolver: null | IRenderMime.IResolver;
    sanitizer: IRenderMime.ISanitizer;
    addFactory(factory: IRenderMime.IRendererFactory, rank?: number): void;
    clone(options?: ICloneOptions): IRenderMimeRegistry;
    createModel(options?: MimeModel.IOptions): MimeModel;
    createRenderer(mimeType: string): IRenderMime.IRenderer;
    getFactory(mimeType: string): undefined | IRenderMime.IRendererFactory;
    getRank(mimeType: string): undefined | number;
    preferredMimeType(
        bundle: ReadonlyPartialJSONObject,
        safe?: "any" | "ensure" | "prefer",
    ): undefined | string;
    removeMimeType(mimeType: string): void;
    setRank(mimeType: string, rank: number): void;
}

Implemented by

Properties

latexTypesetter linkHandler markdownParser mimeTypes resolver sanitizer

Methods

addFactory clone createModel createRenderer getFactory getRank preferredMimeType removeMimeType setRank

Properties

ReadonlylatexTypesetter

latexTypesetter: null | IRenderMime.ILatexTypesetter

The LaTeX typesetter for the rendermime.

ReadonlylinkHandler

linkHandler: null | IRenderMime.ILinkHandler

The object used to handle path opening links.

ReadonlymarkdownParser

markdownParser: null | IRenderMime.IMarkdownParser

The Markdown parser for the rendermime.

ReadonlymimeTypes

mimeTypes: readonly string[]

The ordered list of mimeTypes.

Readonlyresolver

resolver: null | IRenderMime.IResolver

The object used to resolve relative urls for the rendermime instance.

Readonlysanitizer

sanitizer: IRenderMime.ISanitizer

The sanitizer used by the rendermime instance.

Methods

addFactory

  • addFactory(factory: IRenderMime.IRendererFactory, rank?: number): void

  • Add a renderer factory to the rendermime.

    Parameters

    • factory: IRenderMime.IRendererFactory

      The renderer factory of interest.

    • Optionalrank: number

      The rank of the renderer. A lower rank indicates a higher priority for rendering. If not given, the rank will defer to the defaultRank of the factory. If no defaultRank is given, it will default to 100.

      Notes

      The renderer will replace an existing renderer for the given mimeType.

    Returns void

clone

createModel

createRenderer

getFactory

getRank

  • getRank(mimeType: string): undefined | number

  • Get the rank for a given mime type.

    Parameters

    • mimeType: string

      The mime type of interest.

    Returns undefined | number

    The rank of the mime type or undefined.

preferredMimeType

  • preferredMimeType(
        bundle: ReadonlyPartialJSONObject,
        safe?: "any" | "ensure" | "prefer",
    ): undefined | string

  • Find the preferred mime type for a mime bundle.

    Parameters

    • bundle: ReadonlyPartialJSONObject

      The bundle of mime data.

    • Optionalsafe: "any" | "ensure" | "prefer"

      How to consider safe/unsafe factories. If 'ensure', it will only consider safe factories. If 'any', any factory will be considered. If 'prefer', unsafe factories will be considered, but only after the safe options have been exhausted.

    Returns undefined | string

    The preferred mime type from the available factories, or undefined if the mime type cannot be rendered.

removeMimeType

setRank

  • setRank(mimeType: string, rank: number): void

  • Set the rank of a given mime type.

    Parameters

    • mimeType: string

      The mime type of interest.

    • rank: number

      The new rank to assign.

      Notes

      This is a no-op if the mime type is not registered.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods