Interface IOptions

An options object for initializing a notebook model.

interface IOptions {
    collaborationEnabled?: boolean;
    defaultCell?: "raw" | "code" | "markdown";
    disableDocumentWideUndoRedo?: boolean;
    languagePreference?: string;
    sharedModel?: ISharedNotebook;
    translator?: ITranslator;
}

Hierarchy (View Summary)

DocumentRegistry.IModelOptions<ISharedNotebook>
- IOptions

Index

Properties

collaborationEnabled? defaultCell? disableDocumentWideUndoRedo? languagePreference? sharedModel? translator?

Properties

`Optional`collaborationEnabled

collaborationEnabled?: boolean

Whether the model is collaborative or not.

`Optional`defaultCell

defaultCell?: "raw" | "code" | "markdown"

Default cell type.

`Optional` `Experimental` `Alpha`disableDocumentWideUndoRedo

disableDocumentWideUndoRedo?: boolean

Defines if the document can be undo/redo.

Default: true

`Optional`languagePreference

languagePreference?: string

The preferred language.

`Optional`sharedModel

sharedModel?: ISharedNotebook

The shared model.

`Optional`translator

translator?: ITranslator

Language translator.