Interface IOptions

The options used to initialize a document manager.

interface IOptions {
    isConnectedCallback?: (() => boolean);
    manager: ServiceManager.IManager;
    opener: IDocumentWidgetOpener;
    recentsManager?: IRecentsManager;
    registry: DocumentRegistry;
    sessionDialogs?: IDialogs;
    setBusy?: (() => IDisposable);
    translator?: ITranslator;
    when?: Promise<void>;
}

Properties

isConnectedCallback? manager opener recentsManager? registry sessionDialogs? setBusy? translator? when?

Properties

Optional isConnectedCallback

isConnectedCallback?: (() => boolean)

Autosaving should be paused while this callback function returns false. By default, it always returns true.

Type declaration

    • (): boolean

    • Returns boolean

manager

manager: ServiceManager.IManager

A service manager instance.

opener

opener: IDocumentWidgetOpener

A widget opener for sibling widgets.

Optional recentsManager

recentsManager?: IRecentsManager

The manager for recent documents.

registry

registry: DocumentRegistry

A document registry instance.

Optional sessionDialogs

sessionDialogs?: IDialogs

The provider for session dialogs.

Optional setBusy

setBusy?: (() => IDisposable)

A function called when a kernel is busy.

Type declaration

Optional translator

translator?: ITranslator

The application language translator.

Optional when

when?: Promise<void>

A promise for when to start using the manager.

Settings

Member Visibility

Theme

On This Page

isConnectedCallbackmanageropenerrecentsManagerregistrysessionDialogssetBusytranslatorwhen