Interface IOptions<T>

The options used to initialize a context.

interface IOptions<T> {
    factory: DocumentRegistry.IModelFactory<T, ISharedDocument>;
    kernelPreference?: IKernelPreference;
    lastModifiedCheckMargin?: number;
    manager: ServiceManager.IManager;
    opener?: ((widget) => void);
    path: string;
    sessionDialogs?: IDialogs;
    setBusy?: (() => IDisposable);
    translator?: ITranslator;
}

Type Parameters

Properties

factory kernelPreference? lastModifiedCheckMargin? manager opener? path sessionDialogs? setBusy? translator?

Properties

factory

factory: DocumentRegistry.IModelFactory<T, ISharedDocument>

The model factory used to create the model.

Optional kernelPreference

kernelPreference?: IKernelPreference

The kernel preference associated with the context.

Optional lastModifiedCheckMargin

lastModifiedCheckMargin?: number

Max acceptable difference, in milliseconds, between last modified timestamps on disk and client

manager

manager: ServiceManager.IManager

A service manager instance.

Optional opener

opener?: ((widget) => void)

An optional callback for opening sibling widgets.

Type declaration

    • (widget): void

    • Parameters

      Returns void

path

path: string

The initial path of the file.

Optional sessionDialogs

sessionDialogs?: IDialogs

The dialogs used for the session context.

Optional setBusy

setBusy?: (() => IDisposable)

A function to call when the kernel is busy.

Type declaration

Optional translator

translator?: ITranslator

The application language translator.

Settings

Member Visibility

Theme

On This Page

factorykernelPreferencelastModifiedCheckMarginmanageropenerpathsessionDialogssetBusytranslator