Type alias JupyterPropsType

JupyterPropsType: {
    collaborative?: boolean;
    defaultKernelName?: string;
    initCode?: string;
    jupyterServerToken?: string;
    jupyterServerUrl?: string;
    lite?: Lite;
    serverless?: boolean;
    serviceManager?: ServiceManager.IManager;
    skeleton?: JSX.Element;
    startDefaultKernel?: boolean;
    terminals?: boolean;
    useRunningKernelId?: string;
    useRunningKernelIndex?: number;
}

The type for Jupyter props.

Type declaration

  • Optional collaborative?: boolean

    Whether the component is collaborative or not.

  • Optional defaultKernelName?: string

    Default kernel name

  • Optional initCode?: string

    Code to be executed silently at kernel startup

    This is ignored if there is no default kernel.

  • Optional jupyterServerToken?: string
  • Optional jupyterServerUrl?: string
  • Optional lite?: Lite

    URL to fetch a JupyterLite kernel (i.e. in-browser kernel).

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

    Example

    https://cdn.jsdelivr.net/npm/@jupyterlite/pyodide-kernel-extension
  • Optional serverless?: boolean
  • Optional serviceManager?: ServiceManager.IManager

    Jupyter Service Manager.

  • Optional skeleton?: JSX.Element

    A loader to display while the kernel is being setup.

  • Optional startDefaultKernel?: boolean

    Whether to start the default kernel or not.

  • Optional terminals?: boolean
  • Optional useRunningKernelId?: string

    The Kernel Id to use, as defined in the Kernel API

  • Optional useRunningKernelIndex?: number

    The index (aka position) of the Kernel to use in the list of kernels.

Settings

Member Visibility

Theme