Construct a new JupyterLab object.
Private _allPrivate _infoPrivate _pathsReadonly commandThe command linker used by the application.
Readonly commandsThe application command registry.
Readonly contextThe application context menu.
Readonly docThe document registry instance used by the application.
Readonly nameThe name of the JupyterLab application.
Readonly namespaceA namespace/prefix plugins may use to denote their provenance.
Readonly registerA list of all errors encountered when registering plugins.
Readonly restoredPromise that resolves when state is first restored, returning layout description.
Readonly serviceThe service manager used by the application.
Readonly shellThe application shell widget.
The shell widget is the root "container" widget for the entire application. It will typically expose an API which allows the application plugins to insert content in a variety of places.
Readonly statusThe application busy and dirty status signals and flags.
Readonly versionThe version of the JupyterLab application.
The list of all the deferred plugins.
The JupyterLab application information dictionary.
The JupyterLab application paths dictionary.
Protected addAdd the application event listeners.
The default implementation of this method adds listeners for
'keydown' and 'resize' events.
A subclass may reimplement this method as needed.
Protected attachAttach the application shell to the DOM.
The ID of the host node for the shell, or ''.
If the ID is not provided, the document body will be the host.
A subclass may reimplement this method as needed.
Walks up the DOM hierarchy of the target of the active contextmenu
event, testing each HTMLElement ancestor for a user-supplied function. This can
be used to find an HTMLElement on which to operate, given a context menu click.
a function that takes an HTMLElement and returns a
boolean for whether it is the element the requester is seeking.
an HTMLElement or undefined, if none is found.
Deactivate the plugin and its downstream dependents if and only if the
plugin and its dependents all support deactivate.
The ID of the plugin of interest.
A list of IDs of downstream plugins deactivated with this one.
Protected evtA method invoked on a document 'contextmenu' event.
Protected evtOverride keydown handling to prevent command shortcuts from preventing user input.
This introduces a slight delay to the command invocation, but no delay to user input.
Protected evtRegister a plugin with the application.
The plugin to register.
An error will be thrown if a plugin with the same ID is already registered, or if the plugin has a circular dependency.
If the plugin provides a service which has already been provided by another plugin, the new service will override the old service.
Register plugins from a plugin module.
The plugin module to register.
Register the plugins from multiple plugin modules.
The plugin modules to register.
Register multiple plugins with the application.
Resolve an optional service of a given type.
A promise which resolves to an instance of the requested
service, or null if it cannot be resolved.
Services are singletons. The same instance will be returned each time a given service token is resolved.
If the plugin which provides the service has not been activated, resolving the service will automatically activate the plugin.
User code will not typically call this method directly. Instead, the optional services for the user's plugins will be resolved automatically when the plugin is activated.
Resolve a required service of a given type.
A promise which resolves to an instance of the requested service, or rejects with an error if it cannot be resolved.
Services are singletons. The same instance will be returned each time a given service token is resolved.
If the plugin which provides the service has not been activated, resolving the service will automatically activate the plugin.
User code will not typically call this method directly. Instead, the required services for the user's plugins will be resolved automatically when the plugin is activated.
Start the application.
Optional options: IStartOptionsThe options for starting the application.
A promise which resolves when all bootstrapping work is complete and the shell is mounted to the DOM.
This should be called once by the application creator after all initial plugins have been registered.
If a plugin fails to the load, the error will be logged and the other valid plugins will continue to be loaded.
Bootstrapping the application consists of the following steps:
JupyterLab is the main application class. It is instantiated once and shared.