Interface IOptions<T, U>

The options used to initialize a JupyterFrontEnd.

interface IOptions<T, U> {
    commandLinker?: CommandLinker;
    contextMenuRenderer?: IRenderer;
    docRegistry?: DocumentRegistry;
    restored?: Promise<U>;
    serviceManager?: ServiceManager.IManager;
    shell: T;
}

Type Parameters

Hierarchy

  • IOptions<T>
    • IOptions

Properties

commandLinker? contextMenuRenderer? docRegistry? restored? serviceManager? shell

Properties

Optional commandLinker

commandLinker?: CommandLinker

The command linker used by the application.

Optional contextMenuRenderer

contextMenuRenderer?: IRenderer

A custom renderer for the context menu.

Optional docRegistry

docRegistry?: DocumentRegistry

The document registry instance used by the application.

Optional restored

restored?: Promise<U>

Promise that resolves when state is first restored, returning layout description.

Optional serviceManager

serviceManager?: ServiceManager.IManager

The service manager used by the application.

shell

shell: T

The shell widget to use for the application.

This should be a newly created and initialized widget.

The application will attach the widget to the DOM.

Settings

Member Visibility

Theme

On This Page

commandLinkercontextMenuRendererdocRegistryrestoredserviceManagershell