Class JupyterFrontEnd<T, U>Abstract

The base Jupyter front-end application class.

Typeparam

T - The shell type. Defaults to JupyterFrontEnd.IShell.

Typeparam

U - 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.

Type Parameters

  • T extends IShell = IShell
  • U extends string = "desktop" | "mobile"

Hierarchy (View Summary)

Constructors

constructor

Properties

commandLinker commands contextMenu docRegistry name namespace pluginRegistry restored serviceManager shell version

Accessors

deferredPlugins format formatChanged started

Methods

activateDeferredPlugins activatePlugin addEventListeners attachShell contextMenuHitTest deactivatePlugin deregisterPlugin evtContextMenu evtKeydown evtKeyup evtResize getPluginDescription handleEvent hasPlugin isPluginActivated listPlugins registerPlugin registerPlugins resolveOptionalService resolveRequiredService start

Constructors

constructor

Properties

ReadonlycommandLinker

commandLinker: CommandLinker

The command linker used by the application.

Readonlycommands

commands: CommandRegistry

The application command registry.

ReadonlycontextMenu

contextMenu: ContextMenuSvg

The application context menu.

ReadonlydocRegistry

docRegistry: DocumentRegistry

The document registry instance used by the application.

Abstract Readonlyname

name: string

The name of this Jupyter front-end application.

Abstract Readonlynamespace

namespace: string

A namespace/prefix plugins may use to denote their provenance.

ProtectedpluginRegistry

pluginRegistry: PluginRegistry<any>

Application plugin registry.

Readonlyrestored

restored: Promise<void>

Promise that resolves when state is first restored.

ReadonlyserviceManager

serviceManager: ServiceManager.IManager

The service manager used by the application.

Readonlyshell

shell: T

The application shell widget.

Notes

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.

Abstract Readonlyversion

version: string

The version of this Jupyter front-end application.

Accessors

deferredPlugins

  • get deferredPlugins(): string[]

  • The list of all the deferred plugins.

    Returns string[]

format

formatChanged

started

  • get started(): Promise<void>

  • A promise which resolves after the application has started.

    Notes

    This promise will resolve after the start() method is called, when all the bootstrapping and shell mounting work is complete.

    Returns Promise<void>

Methods

activateDeferredPlugins

  • activateDeferredPlugins(): Promise<void>

  • Activate all the deferred plugins.

    Returns Promise<void>

    A promise which will resolve when each plugin is activated or rejects with an error if one cannot be activated.

activatePlugin

  • activatePlugin(id: string): Promise<void>

  • Activate the plugin with the given ID.

    Parameters

    • id: string

      The ID of the plugin of interest.

    Returns Promise<void>

    A promise which resolves when the plugin is activated or rejects with an error if it cannot be activated.

ProtectedaddEventListeners

  • addEventListeners(): void

  • Add the application event listeners.

    Notes

    The default implementation of this method adds listeners for 'keydown' and 'resize' events.

    A subclass may reimplement this method as needed.

    Returns void

ProtectedattachShell

  • attachShell(id: string): void

  • Attach the application shell to the DOM.

    Parameters

    • id: string

      The ID of the host node for the shell, or ''.

      Notes

      If the ID is not provided, the document body will be the host.

      A subclass may reimplement this method as needed.

    Returns void

contextMenuHitTest

  • contextMenuHitTest(fn: (node: HTMLElement) => boolean): undefined | HTMLElement

  • 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.

    Parameters

    • fn: (node: HTMLElement) => boolean

      a function that takes an HTMLElement and returns a boolean for whether it is the element the requester is seeking.

    Returns undefined | HTMLElement

    an HTMLElement or undefined, if none is found.

deactivatePlugin

  • deactivatePlugin(id: string): Promise<string[]>

  • Deactivate the plugin and its downstream dependents if and only if the plugin and its dependents all support deactivate.

    Parameters

    • id: string

      The ID of the plugin of interest.

    Returns Promise<string[]>

    A list of IDs of downstream plugins deactivated with this one.

deregisterPlugin

  • deregisterPlugin(id: string, force?: boolean): void

  • Deregister a plugin with the application.

    Parameters

    • id: string

      The ID of the plugin of interest.

    • Optionalforce: boolean

      Whether to deregister the plugin even if it is active.

    Returns void

ProtectedevtContextMenu

ProtectedevtKeydown

  • evtKeydown(event: KeyboardEvent): void

  • A method invoked on a document 'keydown' event.

    Notes

    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.

    Parameters

    Returns void

ProtectedevtKeyup

  • evtKeyup(event: KeyboardEvent): void

  • A method invoked on a document 'keyup' event.

    Notes

    The default implementation of this method invokes the key up processing method of the application command registry.

    A subclass may reimplement this method as needed.

    Parameters

    Returns void

ProtectedevtResize

  • evtResize(event: Event): void

  • A method invoked on a window 'resize' event.

    Notes

    The default implementation of this method updates the shell.

    A subclass may reimplement this method as needed.

    Parameters

    Returns void

getPluginDescription

  • getPluginDescription(id: string): string

  • Get a plugin description.

    Parameters

    • id: string

      The ID of the plugin of interest.

    Returns string

    The plugin description.

handleEvent

  • handleEvent(event: Event): void

  • Handle the DOM events for the application.

    Parameters

    • event: Event

      The DOM event sent to the application.

      Notes

      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.

    Returns void

hasPlugin

  • hasPlugin(id: string): boolean

  • Test whether a plugin is registered with the application.

    Parameters

    • id: string

      The ID of the plugin of interest.

    Returns boolean

    true if the plugin is registered, false otherwise.

isPluginActivated

  • isPluginActivated(id: string): boolean

  • Test whether a plugin is activated with the application.

    Parameters

    • id: string

      The ID of the plugin of interest.

    Returns boolean

    true if the plugin is activated, false otherwise.

listPlugins

  • listPlugins(): string[]

  • List the IDs of the plugins registered with the application.

    Returns string[]

    A new array of the registered plugin IDs.

registerPlugin

  • registerPlugin(plugin: IPlugin<JupyterFrontEnd<T, U>, any>): void

  • Register a plugin with the application.

    Parameters

    • plugin: IPlugin<JupyterFrontEnd<T, U>, any>

      The plugin to register.

      Notes

      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.

    Returns void

registerPlugins

  • registerPlugins(plugins: IPlugin<JupyterFrontEnd<T, U>, any>[]): void

  • Register multiple plugins with the application.

    Parameters

    • plugins: IPlugin<JupyterFrontEnd<T, U>, any>[]

      The plugins to register.

      Notes

      This calls registerPlugin() for each of the given plugins.

    Returns void

resolveOptionalService

  • resolveOptionalService<U>(token: Token<U>): Promise<null | U>

  • Resolve an optional service of a given type.

    Type Parameters

    • U

    Parameters

    • token: Token<U>

      The token for the service type of interest.

    Returns Promise<null | U>

    A promise which resolves to an instance of the requested service, or null if it cannot be resolved.

    Notes

    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.

resolveRequiredService

  • resolveRequiredService<U>(token: Token<U>): Promise<U>

  • Resolve a required service of a given type.

    Type Parameters

    • U

    Parameters

    • token: Token<U>

      The token for the service type of interest.

    Returns Promise<U>

    A promise which resolves to an instance of the requested service, or rejects with an error if it cannot be resolved.

    Notes

    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

  • start(options?: IStartOptions): Promise<void>

  • Start the application.

    Parameters

    • Optionaloptions: IStartOptions

      The options for starting the application.

    Returns Promise<void>

    A promise which resolves when all bootstrapping work is complete and the shell is mounted to the DOM.

    Notes

    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:

    1. Activate the startup plugins
    2. Wait for those plugins to activate
    3. Attach the shell widget to the DOM
    4. Add the application event listeners

Settings

Member Visibility

On This Page

Notes
Constructors
Properties
Accessors
Methods