The interface for a renderer factory.

interface IRendererFactory {
    defaultRank?: number;
    mimeTypes: readonly string[];
    safe: boolean;
    createRenderer(options): IRenderMime.IRenderer;
}

Properties

defaultRank?: number

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

mimeTypes: readonly string[]

The mime types handled by this factory.

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