@jupyterlab/application
Version:
JupyterLab - Application
257 lines (256 loc) • 8.46 kB
TypeScript
import { IRenderMime } from '@jupyterlab/rendermime-interfaces';
import { IConnectionStatus } from '@jupyterlab/services';
import { Token } from '@lumino/coreutils';
import { JupyterFrontEnd, JupyterFrontEndPlugin } from './frontend';
import { ILabShell } from './shell';
import { LabStatus } from './status';
/**
* JupyterLab is the main application class. It is instantiated once and shared.
*/
export declare class JupyterLab extends JupyterFrontEnd<ILabShell> {
/**
* Construct a new JupyterLab object.
*/
constructor(options?: JupyterLab.IOptions);
/**
* The name of the JupyterLab application.
*/
readonly name: string;
/**
* A namespace/prefix plugins may use to denote their provenance.
*/
readonly namespace: string;
/**
* A list of all errors encountered when registering plugins.
*
* @deprecated This is unused and may be removed in a future version.
*/
readonly registerPluginErrors: Array<Error>;
/**
* Promise that resolves when state is first restored, returning layout
* description.
*/
readonly restored: Promise<void>;
/**
* The application busy and dirty status signals and flags.
*/
readonly status: LabStatus;
/**
* The version of the JupyterLab application.
*/
readonly version: string;
/**
* The JupyterLab application information dictionary.
*/
get info(): JupyterLab.IInfo;
/**
* The JupyterLab application paths dictionary.
*/
get paths(): JupyterFrontEnd.IPaths;
/**
* Promise that resolves when all the plugins are activated, including the deferred.
*/
get allPluginsActivated(): Promise<void>;
/**
* Register plugins from a plugin module.
*
* @param mod - The plugin module to register.
*
* @deprecated This is unused and may be removed in a future version.
*/
registerPluginModule(mod: JupyterLab.IPluginModule): void;
/**
* Register the plugins from multiple plugin modules.
*
* @param mods - The plugin modules to register.
*
* @deprecated This is unused and may be removed in a future version.
*/
registerPluginModules(mods: JupyterLab.IPluginModule[]): void;
/**
* Override 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 evtKeydown(keyDownEvent: KeyboardEvent): void;
private _info;
private _paths;
private _allPluginsActivated;
}
/**
* The namespace for `JupyterLab` class statics.
*/
export declare namespace JupyterLab {
/**
* The options used to initialize a JupyterLab object.
*/
export interface IOptions extends Partial<JupyterFrontEnd.IOptions<ILabShell>>, Partial<IInfo> {
/**
* URL and directory paths used by a Jupyter front-end.
*/
paths?: Partial<JupyterFrontEnd.IPaths>;
/**
* Application connection status.
*/
connectionStatus?: IConnectionStatus;
}
/**
* The application info token.
*/
export const IInfo: Token<IInfo>;
/**
* The information about a JupyterLab application.
*/
export interface IInfo {
/**
* Whether the application is in dev mode.
*/
readonly devMode: boolean;
/**
* The collection of deferred extension patterns and matched extensions.
*/
readonly deferred: {
patterns: string[];
matches: string[];
};
/**
* The collection of disabled extension patterns and matched extensions.
*/
readonly disabled: {
patterns: string[];
matches: string[];
};
/**
* The mime renderer extensions.
*/
readonly mimeExtensions: IRenderMime.IExtensionModule[];
/**
* The information about available plugins.
*/
readonly availablePlugins: IPluginInfo[];
/**
* Whether files are cached on the server.
*/
readonly filesCached: boolean;
/**
* Every periodic network polling should be paused while this is set
* to `false`. Extensions should use this value to decide whether to proceed
* with the polling.
* The extensions may also set this value to `false` if there is no need to
* fetch anything from the server backend basing on some conditions
* (e.g. when an error message dialog is displayed).
* At the same time, the extensions are responsible for setting this value
* back to `true`.
*/
isConnected: boolean;
}
/**
* The information about a JupyterLab application.
*/
export class Info implements IInfo {
constructor({ connectionStatus, ...options }?: Partial<IInfo> & {
connectionStatus?: IConnectionStatus;
});
/**
* The information about available plugins.
*/
get availablePlugins(): IPluginInfo[];
/**
* Whether the application is in dev mode.
*/
get devMode(): boolean;
/**
* The collection of deferred extension patterns and matched extensions.
*/
get deferred(): {
patterns: string[];
matches: string[];
};
/**
* The collection of disabled extension patterns and matched extensions.
*/
get disabled(): {
patterns: string[];
matches: string[];
};
/**
* Whether files are cached on the server.
*/
get filesCached(): boolean;
/**
* Every periodic network polling should be paused while this is set
* to `false`. Extensions should use this value to decide whether to proceed
* with the polling.
* The extensions may also set this value to `false` if there is no need to
* fetch anything from the server backend basing on some conditions
* (e.g. when an error message dialog is displayed).
* At the same time, the extensions are responsible for setting this value
* back to `true`.
*/
get isConnected(): boolean;
set isConnected(v: boolean);
/**
* The mime renderer extensions.
*/
get mimeExtensions(): IRenderMime.IExtensionModule[];
private _devMode;
private _deferred;
private _disabled;
private _mimeExtensions;
private _availablePlugins;
private _filesCached;
private _connectionStatus;
}
export interface IToken extends Readonly<Pick<Token<any>, 'name' | 'description'>> {
}
/**
* A readonly subset of lumino plugin bundle (excluding activation function,
* service, and state information, and runtime token details).
*/
interface ILuminoPluginData extends Readonly<Pick<JupyterFrontEndPlugin<void>, 'id' | 'description' | 'autoStart'>> {
/**
* The types of required services for the plugin, or `[]`.
*/
readonly requires: IToken[];
/**
* The types of optional services for the the plugin, or `[]`.
*/
readonly optional: IToken[];
/**
* The type of service provided by the plugin, or `null`.
*/
readonly provides: IToken | null;
}
/**
* A subset of plugin bundle enriched with JupyterLab extension metadata.
*/
export interface IPluginInfo extends ILuminoPluginData {
/**
* The name of the extension which provides the plugin.
*/
extension: string;
/**
* Whether the plugin is enabled.
*/
enabled: boolean;
}
/**
* The default JupyterLab application info.
*/
export const defaultInfo: IInfo;
/**
* The default JupyterLab application paths.
*/
export const defaultPaths: JupyterFrontEnd.IPaths;
/**
* The interface for a module that exports a plugin or plugins as
* the default value.
*/
export interface IPluginModule {
/**
* The default export.
*/
default: JupyterFrontEndPlugin<any, any, any> | JupyterFrontEndPlugin<any, any, any>[];
}
export {};
}