Construct a new JupyterFrontEnd object.
The command linker used by the application.
The application command registry.
The application context menu.
The document registry instance used by the application.
The name of this Jupyter front-end application.
A namespace/prefix plugins may use to denote their provenance.
Promise that resolves when state is first restored.
The service manager used by the application.
The 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.
A promise which resolves after the application has started.
This promise will resolve after the start() method is called,
when all the bootstrapping and shell mounting work is complete.
The version of this Jupyter front-end application.
The application form factor, e.g., desktop or mobile.
The application form factor, e.g., desktop or mobile.
A signal that emits when the application form factor changes.
Activate the plugin with the given id.
The ID of the plugin of interest.
A promise which resolves when the plugin is activated or rejects with an error if it cannot be activated.
Add 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.
Attach 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.
A method invoked on a document 'contextmenu' event.
A method invoked on a document 'keydown' event.
The default implementation of this method invokes the key down processing method of the application command registry.
A subclass may reimplement this method as needed.
A method invoked on a window 'resize' event.
The default implementation of this method updates the shell.
A subclass may reimplement this method as needed.
Handle the DOM events for the application.
The DOM event sent to the application.
This method implements the DOM EventListener interface and is
called in response to events registered for the application. It
should not be called directly by user code.
Test whether a plugin is registered with the application.
The id of the plugin of interest.
true if the plugin is registered, false otherwise.
List the IDs of the plugins registered with the application.
A new array of the registered plugin IDs.
Register 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 multiple plugins with the application.
Resolve an optional service of a given type.
The token for the service type of interest.
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.
The token for the service type of interest.
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.
The 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:
Generated using TypeDoc
The base Jupyter front-end application class.
The
shelltype. Defaults toJupyterFrontEnd.IShell.The type for supported format names. Defaults to
string.Notes
This type is useful as a generic application against which front-end plugins can be authored. It inherits from the Lumino
Application.