Interface IRunCellOptions

Execution options for notebook cell executor.

interface IRunCellOptions {
    cell: Cell<ICellModel>;
    notebook: INotebookModel;
    notebookConfig: INotebookConfig;
    onCellExecuted: ((args) => void);
    onCellExecutionScheduled: ((args) => void);
    sessionContext?: ISessionContext;
    sessionDialogs?: ISessionContextDialogs;
    translator?: ITranslator;
}

Index

Properties

cell notebook notebookConfig onCellExecuted onCellExecutionScheduled sessionContext? sessionDialogs? translator?

Properties

cell

cell: Cell<ICellModel>

Cell to execute

notebook

notebook: INotebookModel

Notebook to which the cell belongs

notebookConfig

notebookConfig: INotebookConfig

Notebook widget configuration

onCellExecuted

onCellExecuted: ((args) => void)

A callback to notify a cell completed execution.

Type declaration

- (args): void
- Parameters
  - args: {
        cell: Cell<ICellModel>;
        error?: null | KernelError;
        success: boolean;
    }
    - cell: Cell<ICellModel>
    - Optional error?: null | KernelError
    - success: boolean
  Returns void

onCellExecutionScheduled

onCellExecutionScheduled: ((args) => void)

A callback to notify that a cell execution is scheduled.

Type declaration

- (args): void
- Parameters
  - args: {
    cell: Cell<ICellModel>;
    }
    - cell: Cell<ICellModel>
  Returns void

`Optional` sessionContext

sessionContext?: ISessionContext

Document session context

`Optional` sessionDialogs

sessionDialogs?: ISessionContextDialogs

Session dialogs

`Optional` translator

translator?: ITranslator

Application translator