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;
    urlResolverFactory?: IUrlResolverFactory;
    when?: Promise<void>;
}

Properties

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

Properties

OptionalisConnectedCallback

isConnectedCallback?: () => boolean

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

manager

manager: ServiceManager.IManager

A service manager instance.

opener

opener: IDocumentWidgetOpener

A widget opener for sibling widgets.

OptionalrecentsManager

recentsManager?: IRecentsManager

The manager for recent documents.

registry

registry: DocumentRegistry

A document registry instance.

OptionalsessionDialogs

sessionDialogs?: IDialogs

The provider for session dialogs.

OptionalsetBusy

setBusy?: () => IDisposable

A function called when a kernel is busy.

Optionaltranslator

translator?: ITranslator

The application language translator.

OptionalurlResolverFactory

urlResolverFactory?: IUrlResolverFactory

A factory for the URL resolver.

Optionalwhen

when?: Promise<void>

A promise for when to start using the manager.

Settings

Member Visibility

On This Page

Properties