Class RenderMimeRegistry

constructor

• new RenderMimeRegistry(
      options?: RenderMimeRegistry.IOptions,
  ): RenderMimeRegistry

• Construct a new rendermime.

  Parameters

  • options: RenderMimeRegistry.IOptions = {}

    The options for initializing the instance.

  Returns RenderMimeRegistry

ReadonlylatexTypesetter

ReadonlylinkHandler

ReadonlymarkdownParser

Readonlyresolver

Readonlysanitizer

Readonlytranslator

mimeTypes

• get mimeTypes(): readonly string[]

• The ordered list of mimeTypes.

  Returns readonly string[]

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

• clone(options?: ICloneOptions): RenderMimeRegistry

• Create a clone of this rendermime instance.

  Parameters

  • options: ICloneOptions = {}

    The options for configuring the clone.

  Returns RenderMimeRegistry

  A new independent clone of the rendermime.

createModel

• createModel(options?: MimeModel.IOptions): MimeModel

• Create a new mime model. This is a convenience method.

  Parameters

  • options: MimeModel.IOptions = {}

  Returns MimeModel

  A new mime model.

  Options

  • The options used to create the model.

createRenderer

• createRenderer(mimeType: string): IRenderMime.IRenderer

• Create a renderer for a mime type.

  Parameters

  • mimeType: string

    The mime type of interest.

  Returns IRenderMime.IRenderer

  A new renderer for the given mime type.

  Throws

  An error if no factory exists for the mime type.

getFactory

• getFactory(mimeType: string): undefined | IRenderMime.IRendererFactory

• Get the renderer factory registered for a mime type.

  Parameters

  • mimeType: string

    The mime type of interest.

  Returns undefined | IRenderMime.IRendererFactory

  The factory for the mime type, or undefined.

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.
  • safe: "any" | "ensure" | "prefer" = 'ensure'

    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

• removeMimeType(mimeType: string): void

• Remove a mime type.

  Parameters

  • mimeType: string

    The mime type of interest.

  Returns void

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