Interface IOptions

The options used to initialize a rendermime instance.

interface IOptions {
    initialFactories?: readonly IRenderMime.IRendererFactory[];
    latexTypesetter?: IRenderMime.ILatexTypesetter;
    linkHandler?: IRenderMime.ILinkHandler;
    markdownParser?: IRenderMime.IMarkdownParser;
    resolver?: IRenderMime.IResolver;
    sanitizer?: IRenderMime.ISanitizer;
    translator?: ITranslator;
}

Index

Properties

initialFactories? latexTypesetter? linkHandler? markdownParser? resolver? sanitizer? translator?

Properties

`Optional`initialFactories

initialFactories?: readonly IRenderMime.IRendererFactory[]

Initial factories to add to the rendermime instance.

`Optional`latexTypesetter

latexTypesetter?: IRenderMime.ILatexTypesetter

An optional LaTeX typesetter.

`Optional`linkHandler

linkHandler?: IRenderMime.ILinkHandler

An optional path handler.

`Optional`markdownParser

markdownParser?: IRenderMime.IMarkdownParser

An optional Markdown parser.

`Optional`resolver

resolver?: IRenderMime.IResolver

The initial resolver object.

The default is null.

`Optional`sanitizer

sanitizer?: IRenderMime.ISanitizer

The sanitizer used to sanitize untrusted html inputs.

If not given, a default sanitizer will be used.

`Optional`translator

translator?: ITranslator

The application language translator.