Interface INotebookConfig

A config object for the notebook widget

interface INotebookConfig {
    accessKernelHistory?: boolean;
    autoRenderMarkdownCells: boolean;
    defaultCell: string;
    disableDocumentWideUndoRedo: boolean;
    enableKernelInitNotification: boolean;
    inputHistoryScope: "session" | "global";
    maxNumberOutputs: number;
    overscanCount: number;
    recordTiming: boolean;
    renderingLayout: RenderingLayout;
    scrollPastEnd: boolean;
    showEditorForReadOnlyMarkdown?: boolean;
    showHiddenCellsButton: boolean;
    showInputPlaceholder: boolean;
    sideBySideLeftMarginOverride: string;
    sideBySideOutputRatio: number;
    sideBySideRightMarginOverride: string;
    windowingMode: "none" | "full" | "defer";
}

Properties

accessKernelHistory? autoRenderMarkdownCells defaultCell disableDocumentWideUndoRedo enableKernelInitNotification inputHistoryScope maxNumberOutputs overscanCount recordTiming renderingLayout scrollPastEnd showEditorForReadOnlyMarkdown? showHiddenCellsButton showInputPlaceholder sideBySideLeftMarginOverride sideBySideOutputRatio sideBySideRightMarginOverride windowingMode

Properties

OptionalaccessKernelHistory

accessKernelHistory?: boolean

autoRenderMarkdownCells

autoRenderMarkdownCells: boolean

Automatically render markdown when the cursor leaves a markdown cell

defaultCell

defaultCell: string

The default type for new notebook cells.

disableDocumentWideUndoRedo

disableDocumentWideUndoRedo: boolean

Defines if the document can be undo/redo.

enableKernelInitNotification

enableKernelInitNotification: boolean

Whether to display notification if code cell is run while kernel is still initializing.

inputHistoryScope

inputHistoryScope: "session" | "global"

Whether to split stdin line history by kernel session or keep globally accessible.

maxNumberOutputs

maxNumberOutputs: number

Defines the maximum number of outputs per cell.

overscanCount

overscanCount: number

Number of cells to render in addition to those visible in the viewport.

Notes

In 'full' windowing mode, this is the number of cells above and below the viewport. In 'defer' windowing mode, this is the number of cells to render initially in addition to the one of the viewport.

recordTiming

recordTiming: boolean

Should timing be recorded in metadata

renderingLayout

renderingLayout: RenderingLayout

Defines the rendering layout to use.

scrollPastEnd

scrollPastEnd: boolean

Enable scrolling past the last cell

OptionalshowEditorForReadOnlyMarkdown

showEditorForReadOnlyMarkdown?: boolean

Should an editor be shown for read-only markdown

showHiddenCellsButton

showHiddenCellsButton: boolean

Show hidden cells button if collapsed

showInputPlaceholder

showInputPlaceholder: boolean

Show placeholder text for standard input

sideBySideLeftMarginOverride

sideBySideLeftMarginOverride: string

Override the side-by-side left margin.

sideBySideOutputRatio

sideBySideOutputRatio: number

Side-by-side output ratio.

sideBySideRightMarginOverride

sideBySideRightMarginOverride: string

Override the side-by-side right margin.

windowingMode

windowingMode: "none" | "full" | "defer"

Windowing mode

  • 'defer': Wait for idle CPU cycles to attach out of viewport cells
  • 'full': Attach to the DOM only cells in viewport
  • 'none': Attach all cells to the viewport

Settings

Member Visibility

On This Page

Properties