Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JupyterFrontEnd<T, U>

The base Jupyter front-end application class. The namespace for JupyterFrontEnd class statics.

typeparam

The shell type. Defaults to JupyterFrontEnd.IShell.

typeparam

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

Hierarchy

Index

Constructors

constructor

Properties

Private _contextMenuEvent

_contextMenuEvent: MouseEvent

Private _format

_format: U

Private _formatChanged

_formatChanged: Signal<this, U> = new Signal<this, U>(this)

commandLinker

commandLinker: CommandLinker

The command linker used by the application.

commands

commands: CommandRegistry

The application command registry.

contextMenu

contextMenu: ContextMenuSvg

The application context menu.

docRegistry

docRegistry: DocumentRegistry

The document registry instance used by the application.

Abstract name

name: string

The name of this Jupyter front-end application.

Abstract namespace

namespace: string

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

restored

restored: Promise<void>

Promise that resolves when state is first restored.

serviceManager

serviceManager: ServiceManager

The service manager used by the application.

shell

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.

started

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.

Abstract version

version: string

The version of this Jupyter front-end application.

Static IPaths

IPaths: Token<IPaths> = new Token<IPaths>('@jupyterlab/application:IPaths')

The application paths dictionary token.

Static ITreeResolver

ITreeResolver: Token<ITreeResolver> = new Token<ITreeResolver>('@jupyterlab/application:ITreeResolver')

The application tree resolver token.

Notes

Not all Jupyter front-end applications will have a tree resolver implemented on the client-side. This token should not be required as a dependency if it is possible to make it an optional dependency.

Accessors

format

  • get format(): U
  • set format(format: U): void

formatChanged

  • get formatChanged(): ISignal<this, U>

Methods

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.

Protected addEventListeners

  • 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

Protected attachShell

  • 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): HTMLElement | undefined
  • Walks up the DOM hierarchy of the target of the active contextmenu event, testing each HTMLElement ancestor for a user-supplied funcion. 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.

        • (node: HTMLElement): boolean
        • Parameters

          • node: HTMLElement

          Returns boolean

    Returns HTMLElement | undefined

    an HTMLElement or undefined, if none is found.

Protected evtContextMenu

  • evtContextMenu(event: MouseEvent): void

Protected evtKeydown

  • 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

    • event: KeyboardEvent

    Returns void

Protected evtResize

  • 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

    • event: Event

    Returns void

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.

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<this, any>): void
  • Register a plugin with the application.

    Parameters

    • plugin: IPlugin<this, 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<this, any>[]): void
  • Register multiple plugins with the application.

    Parameters

    • plugins: IPlugin<this, any>[]

      The plugins to register.

      Notes

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

    Returns void

resolveOptionalService

  • resolveOptionalService<U>(token: Token<U>): Promise<U | null>
  • 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<U | null>

    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?: Application.IStartOptions): Promise<void>
  • Start the application.

    Parameters

    • Optional options: Application.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

Generated using TypeDoc