Options
All
  • Public
  • Public/Protected
  • All
Menu

An interface for using a RenderMime.IRenderer for output and read-only documents.

Hierarchy

  • IExtension

Index

Properties

Optional dataType

dataType: "string" | "json"

Preferred data type from the model. Defaults to string.

Optional documentWidgetFactoryOptions

documentWidgetFactoryOptions: IDocumentWidgetFactoryOptions | ReadonlyArray<IDocumentWidgetFactoryOptions>

The options used to open a document with the renderer factory.

Optional fileTypes

fileTypes: ReadonlyArray<IFileType>

The optional file type associated with the extension.

id

id: string

The ID of the extension.

Notes

The convention for extension IDs in JupyterLab is the full NPM package name followed by a colon and a unique string token, e.g. '@jupyterlab/apputils-extension:settings' or 'foo-extension:bar'.

Optional rank

rank: number

The rank passed to RenderMime.addFactory.

Optional renderTimeout

renderTimeout: number

The timeout after user activity to re-render the data.

rendererFactory

rendererFactory: IRendererFactory

A renderer factory to be registered to render the MIME type.

Generated using TypeDoc