Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptions

The options used to initialize a document manager.

Hierarchy

  • IOptions

Index

Properties

Properties

Optional collaborative

collaborative: boolean

Whether the context should be collaborative.

deprecated

It will be removed in 4.0.0. The collaborative feature is provided by the DocumentRegistry.IModel (can be customized by the DocumentRegistry.IModelFactory)

Optional docProviderFactory

docProviderFactory: IDocumentProviderFactory<ISharedDocument>

A factory method for the document provider.

manager

manager: IManager

A service manager instance.

opener

opener: IWidgetOpener

A widget opener for sibling widgets.

registry

registry: DocumentRegistry

A document registry instance.

Optional sessionDialogs

sessionDialogs: IDialogs

The provider for session dialogs.

Optional setBusy

setBusy: () => IDisposable

Type declaration

    • (): IDisposable

    • A function called when a kernel is busy.

      Returns IDisposable

Optional translator

translator: ITranslator

The application language translator.

Optional when

when: Promise<void>

A promise for when to start using the manager.

Generated using TypeDoc