Type alias JupyterContextType

JupyterContextType: {
    collaborative?: boolean;
    defaultKernel?: Kernel;
    defaultKernelIsLoading: boolean;
    jupyterServerUrl: string;
    kernel?: Kernel;
    kernelIsLoading: boolean;
    kernelManager?: JupyterKernel.IManager;
    lite?: Lite;
    serverSettings?: ServerConnection.ISettings;
    serverless: boolean;
    serviceManager?: ServiceManager.IManager;
}

The type for Jupyter context.

Type declaration

  • Optional collaborative?: boolean

    Whether the component is collaborative or not.

  • Optional defaultKernel?: Kernel

    Default kernel

  • defaultKernelIsLoading: boolean

    Will be true while waiting for the default kernel.

    If true, it does not ensure a default kernel will be created successfully.

    This is useful to not mount to quickly a Lumino Widget to be unmount right away when the default kernel will be available.

  • jupyterServerUrl: string

    Jupyter Server base URL

    Useless if running an in-browser kernel.

  • Optional kernel?: Kernel

    Kernel

  • kernelIsLoading: boolean

    Kernel

  • Optional kernelManager?: JupyterKernel.IManager

    The Kernel Manager.

  • Optional lite?: Lite

    If true, it will load the Pyodide jupyterlite kernel.

    You can also set it to dynamically import any jupyterlite kernel package.

    If defined, serverUrls and defaultKernelName will be ignored and the component will run this in-browser kernel.

    Example

    `lite: true` => Load dynamically the package @jupyterlite/pyodide-kernel-extension

    `lite: import('@jupyterlite/javascript-kernel-extension')` => Load dynamically
  • Optional serverSettings?: ServerConnection.ISettings

    Jupyter Server settings.

    This is useless if running an in-browser kernel via lite.

  • serverless: boolean
  • Optional serviceManager?: ServiceManager.IManager

    Jupyter service manager.

Settings

Member Visibility

Theme