Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRendererFactory

The interface for a renderer factory.

Hierarchy

  • IRendererFactory

Index

Properties

Optional Readonly defaultRank

defaultRank: number

The default rank of the factory. If not given, defaults to 100.

Readonly mimeTypes

mimeTypes: ReadonlyArray<string>

The mime types handled by this factory.

Readonly safe

safe: boolean

Whether the factory is a "safe" factory.

Notes

A "safe" factory produces renderer widgets which can render untrusted model data in a usable way. All renderers must handle untrusted data safely, but some may simply failover with a "Run cell to view output" message. A "safe" renderer is an indication that its sanitized output will be useful.

Methods

createRenderer

  • Create a renderer which displays the mime data.

    Parameters

    Returns IRenderer

Generated using TypeDoc