Interface IOptions<T>

The options used to initialize a context.

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

Type Parameters

Properties

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

Properties

Optional ExperimentalcontentProviderId

contentProviderId?: string

Identifier of the content provider used for file operations.

factory

factory: DocumentRegistry.IModelFactory<T, ISharedDocument>

The model factory used to create the model.

OptionalkernelPreference

kernelPreference?: IKernelPreference

The kernel preference associated with the context.

OptionallastModifiedCheckMargin

lastModifiedCheckMargin?: number

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

manager

manager: ServiceManager.IManager

A service manager instance.

Optionalopener

opener?: (widget: Widget) => void

An optional callback for opening sibling widgets.

path

path: string

The initial path of the file.

OptionalsessionDialogs

sessionDialogs?: IDialogs

The dialogs used for the session context.

OptionalsetBusy

setBusy?: () => IDisposable

A function to call when the kernel is busy.

Optionaltranslator

translator?: ITranslator

The application language translator.

OptionalurlResolverFactory

urlResolverFactory?: IUrlResolverFactory

A factory for the URL resolver.

Settings

Member Visibility

On This Page

Properties