Interface IOptions<T, U>

The options used to initialize a JupyterFrontEnd.

interface IOptions<T extends IShell = IShell, U = any> {
    commandLinker?: CommandLinker;
    contextMenuRenderer?: IRenderer;
    docRegistry?: DocumentRegistry;
    pluginRegistry?: PluginRegistry<any>;
    restored?: Promise<U>;
    serviceManager?: ServiceManager.IManager;
    shell: T;
    validatePlugin?: (plugin: IPlugin<any, any>) => boolean;
}

Type Parameters

Hierarchy

  • IOptions<T>
    • IOptions

Properties

commandLinker? contextMenuRenderer? docRegistry? pluginRegistry? restored? serviceManager? shell validatePlugin?

Properties

OptionalcommandLinker

commandLinker?: CommandLinker

The command linker used by the application.

OptionalcontextMenuRenderer

contextMenuRenderer?: IRenderer

A custom renderer for the context menu.

OptionaldocRegistry

docRegistry?: DocumentRegistry

The document registry instance used by the application.

OptionalpluginRegistry

pluginRegistry?: PluginRegistry<any>

Application plugin registry.

If defined the options related to the plugin registry will be ignored.

Optionalrestored

restored?: Promise<U>

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

OptionalserviceManager

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.

OptionalvalidatePlugin

validatePlugin?: (plugin: IPlugin<any, any>) => boolean

Validate that a plugin is allowed to be registered.

Default is () => true.

Type declaration

    • (plugin: IPlugin<any, any>): boolean

    • Parameters

      • plugin: IPlugin<any, any>

        The plugin to validate

      Returns boolean

      Whether the plugin can be registered or not.

      Notes

      We recommend you print a console message with the reason a plugin is invalid.

Settings

Member Visibility

On This Page

Properties