Class Notebook

A notebook widget that supports interactivity.

Hierarchy (View Summary)

Constructors

constructor

Properties

_viewModel cellsArray contentFactory jumped kernelHistory node renderer rendermime translator DEFAULT_WIDGET_SIZE

Accessors

activeCell activeCellChanged activeCellIndex cellCollapsed cellInViewportChanged cellsPasted codeMimetype dataset disposed editorConfig hiddenMode id isAttached isDisposed isHidden isParentHidden isVisible lastClipboardInteraction layout mode model modelChanged modelContentChanged notebookConfig outerNode parent renderingLayout renderingLayoutChanged scrollbar selectedCells selectionChanged stateChanged title viewModel viewportNode widgets

Methods

_onCellsChanged activate addClass addFooter addHeader children clearFlag close contains deselect deselectAll dispose extendContiguousSelectionTo fit getContiguousSelection handleEvent hasClass hasNavigableModifiedCellBack hasNavigableModifiedCellForward hide isSelected isSelectedOrActive moveCell notifyLayout onActivateRequest onAfterAttach onAfterDetach onAfterHide onAfterShow onBeforeAttach onBeforeDetach onBeforeHide onBeforeShow onCellInserted onCellRemoved onChildAdded onChildRemoved onCloseRequest onFitRequest onMetadataChanged onModelChanged onModelContentChanged onResize onScroll onStateChanged onUpdateRequest popLastModifiedCell popNextModifiedCell processMessage recordCellClipboardInteraction removeClass removeHeader renderCellOutputs scrollTo scrollToCell scrollToItem select setFlag setFragment setHidden setMode show testFlag toggleClass update

Constructors

constructor

Properties

Protected_viewModel

_viewModel: NotebookViewModel

ProtectedcellsArray

cellsArray: Cell<ICellModel>[]

ReadonlycontentFactory

contentFactory: StaticNotebook.IContentFactory

The cell factory used by the widget.

Protectedjumped

jumped: Signal<Notebook, number>

A signal that emits the index when the virtual scrollbar jumps to an item.

ReadonlykernelHistory

kernelHistory: undefined | INotebookHistory

Readonlynode

node: HTMLElement

Get the DOM node owned by the widget.

Protectedrenderer

renderer: WindowedList.IRenderer<any>

The renderer for this windowed list. Set at instantiation.

Readonlyrendermime

rendermime: IRenderMimeRegistry

The Rendermime instance used by the widget.

Readonlytranslator

translator: ITranslator

Translator to be used by cell renderers

Static ReadonlyDEFAULT_WIDGET_SIZE

DEFAULT_WIDGET_SIZE: 50

Default widget size

Accessors

activeCell

activeCellChanged

activeCellIndex

cellCollapsed

cellInViewportChanged

cellsPasted

codeMimetype

dataset

  • get dataset(): DOMStringMap

  • The dataset for the widget's DOM node.

    Returns DOMStringMap

disposed

  • get disposed(): ISignal<this, void>

  • A signal emitted when the widget is disposed.

    Returns ISignal<this, void>

editorConfig

hiddenMode

  • get hiddenMode(): HiddenMode

  • Get the method for hiding the widget.

    Returns HiddenMode

  • set hiddenMode(value: HiddenMode): void

  • Set the method for hiding the widget.

    Parameters

    • value: HiddenMode

    Returns void

id

  • get id(): string

  • Get the id of the widget's DOM node.

    Returns string

  • set id(value: string): void

  • Set the id of the widget's DOM node.

    Parameters

    • value: string

    Returns void

isAttached

  • get isAttached(): boolean

  • Test whether the widget's node is attached to the DOM.

    Returns boolean

isDisposed

  • get isDisposed(): boolean

  • Test whether the widget has been disposed.

    Returns boolean

isHidden

  • get isHidden(): boolean

  • Test whether the widget is explicitly hidden.

    Notes

    You should prefer !{@link isVisible} over {@link isHidden} if you want to know if the widget is hidden as this does not test if the widget is hidden because one of its ancestors is hidden.

    Returns boolean

isParentHidden

  • get isParentHidden(): boolean

  • Whether the parent is hidden or not.

    This should be set externally if a container is hidden to stop updating the widget size when hidden.

    Returns boolean

  • set isParentHidden(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isVisible

  • get isVisible(): boolean

  • Test whether the widget is visible.

    Notes

    A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

    Since 2.7.0, this does not rely on the Widget.Flag.IsVisible flag. It recursively checks the visibility of all parent widgets.

    Returns boolean

lastClipboardInteraction

layout

  • get layout(): WindowedLayout

  • Widget layout

    Returns WindowedLayout

mode

model

modelChanged

modelContentChanged

  • get modelContentChanged(): ISignal<this, void>

  • A signal emitted when the model content changes.

    Notes

    This is a convenience signal that follows the current model.

    Returns ISignal<this, void>

notebookConfig

outerNode

  • get outerNode(): HTMLElement

  • The outer container of the windowed list.

    Returns HTMLElement

parent

  • get parent(): null | Widget

  • Get the parent of the widget.

    Returns null | Widget

  • set parent(value: null | Widget): void

  • Set the parent of the widget.

    Notes

    Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.

    The widget will be automatically removed from its old parent.

    This is a no-op if there is no effective parent change.

    Parameters

    Returns void

renderingLayout

  • get renderingLayout(): undefined | RenderingLayout

  • Returns undefined | RenderingLayout

  • set renderingLayout(value: undefined | RenderingLayout): void

  • Parameters

    • value: undefined | RenderingLayout

    Returns void

renderingLayoutChanged

  • get renderingLayoutChanged(): ISignal<this, RenderingLayout>

  • A signal emitted when the rendering layout of the notebook changes.

    Returns ISignal<this, RenderingLayout>

scrollbar

  • get scrollbar(): boolean

  • Flag to enable virtual scrollbar.

    Returns boolean

  • set scrollbar(enabled: boolean): void

  • Parameters

    • enabled: boolean

    Returns void

selectedCells

selectionChanged

stateChanged

title

  • get title(): Title<Widget>

  • The title object for the widget.

    Notes

    The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.

    Since not all widgets will use the title, it is created on demand.

    The owner property of the title is set to this widget.

    Returns Title<Widget>

ProtectedviewModel

  • get viewModel(): T

  • Windowed list view model

    Returns T

viewportNode

  • get viewportNode(): HTMLElement

  • Viewport

    Returns HTMLElement

widgets

Methods

Protected_onCellsChanged

activate

  • activate(): void

  • Post an 'activate-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

addClass

  • addClass(name: string): void

  • Add a class name to the widget's DOM node.

    Parameters

    • name: string

      The class name to add to the node.

      Notes

      If the class name is already added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

ProtectedaddFooter

ProtectedaddHeader

children

  • children(): IterableIterator<Widget, any, any>

  • Create an iterator over the widget's children.

    Returns IterableIterator<Widget, any, any>

    A new iterator over the children of the widget.

    Notes

    The widget must have a populated layout in order to have children.

    If a layout is not installed, the returned iterator will be empty.

clearFlag

  • clearFlag(flag: Flag): void

  • Clear the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.

    Parameters

    • flag: Flag

    Returns void

close

  • close(): void

  • Send a 'close-request' message to the widget.

    Notes

    This is a simple convenience method for sending the message.

    Returns void

contains

  • contains(widget: Widget): boolean

  • Test whether a widget is a descendant of this widget.

    Parameters

    • widget: Widget

      The descendant widget of interest.

    Returns boolean

    true if the widget is a descendant, false otherwise.

deselect

deselectAll

dispose

extendContiguousSelectionTo

  • extendContiguousSelectionTo(index: number): void

  • Move the head of an existing contiguous selection to extend the selection.

    Parameters

    • index: number

      The new head of the existing selection.

      Notes

      If there is no existing selection, the active cell is considered an existing one-cell selection.

      If the new selection is a single cell, that cell becomes the active cell and all cells are deselected.

      There is no change if there are no cells (i.e., activeCellIndex is -1).

    Returns void

fit

  • fit(): void

  • Post a 'fit-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

getContiguousSelection

  • getContiguousSelection(): | { anchor: number; head: number }
    | { anchor: null; head: null }

  • Get the head and anchor of a contiguous cell selection.

    The head of a contiguous selection is always the active cell.

    If there are no cells selected, {head: null, anchor: null} is returned.

    Throws an error if the currently selected cells do not form a contiguous selection.

    Returns { anchor: number; head: number } | { anchor: null; head: null }

handleEvent

  • handleEvent(event: Event): void

  • Handle the DOM events for the widget.

    Parameters

    • event: Event

      The DOM event sent to the widget.

      Notes

      This method implements the DOM EventListener interface and is called in response to events on the notebook panel's node. It should not be called directly by user code.

    Returns void

hasClass

  • hasClass(name: string): boolean

  • Test whether the widget's DOM node has the given class name.

    Parameters

    • name: string

      The class name of interest.

    Returns boolean

    true if the node has the class, false otherwise.

hasNavigableModifiedCellBack

hasNavigableModifiedCellForward

hide

  • hide(): void

  • Hide the widget and make it hidden to its parent widget.

    Notes

    This causes the isHidden property to be true.

    If the widget is explicitly hidden, this is a no-op.

    Returns void

isSelected

isSelectedOrActive

moveCell

  • moveCell(from: number, to: number, n?: number): void

  • Move cells preserving widget view state.

    Notes

    This is required because at the model level a move is a deletion followed by an insertion. Hence the view state is not preserved.

    Parameters

    • from: number

      The index of the cell to move

    • to: number

      The new index of the cell

    • n: number = 1

      Number of cells to move

    Returns void

ProtectednotifyLayout

  • notifyLayout(msg: Message): void

  • Invoke the message processing routine of the widget's layout.

    Parameters

    • msg: Message

      The message to dispatch to the layout.

      Notes

      This is a no-op if the widget does not have a layout.

      This will not typically be called directly by user code.

    Returns void

ProtectedonActivateRequest

ProtectedonAfterAttach

ProtectedonAfterDetach

  • onAfterDetach(msg: Message): void

  • A message handler invoked on an 'after-detach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

ProtectedonAfterHide

  • onAfterHide(msg: Message): void

  • A message handler invoked on an 'after-hide' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

ProtectedonAfterShow

ProtectedonBeforeAttach

  • onBeforeAttach(msg: Message): void

  • A message handler invoked on a 'before-attach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

ProtectedonBeforeDetach

ProtectedonBeforeHide

ProtectedonBeforeShow

  • onBeforeShow(msg: Message): void

  • A message handler invoked on a 'before-show' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

ProtectedonCellInserted

ProtectedonCellRemoved

ProtectedonChildAdded

  • onChildAdded(msg: ChildMessage): void

  • A message handler invoked on a 'child-added' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ChildMessage

    Returns void

ProtectedonChildRemoved

  • onChildRemoved(msg: ChildMessage): void

  • A message handler invoked on a 'child-removed' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ChildMessage

    Returns void

ProtectedonCloseRequest

  • onCloseRequest(msg: Message): void

  • A message handler invoked on a 'close-request' message.

    Notes

    The default implementation unparents or detaches the widget.

    Parameters

    • msg: Message

    Returns void

ProtectedonFitRequest

  • onFitRequest(msg: Message): void

  • A message handler invoked on a 'fit-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

ProtectedonMetadataChanged

ProtectedonModelChanged

ProtectedonModelContentChanged

ProtectedonResize

ProtectedonScroll

  • onScroll(event: Event): void

  • Callback on scroll event

    Parameters

    • event: Event

      Scroll event

    Returns void

ProtectedonStateChanged

ProtectedonUpdateRequest

popLastModifiedCell

popNextModifiedCell

processMessage

  • processMessage(msg: Message): void

  • Process a message sent to the widget.

    Parameters

    • msg: Message

      The message sent to the widget.

      Notes

      Subclasses may reimplement this method as needed.

    Returns void

recordCellClipboardInteraction

  • recordCellClipboardInteraction(
        interaction: null | "copy" | "cut" | "paste",
        cells: IBaseCell[],
    ): void

  • This function should be called when a clipboard interaction involve notebook cells.

    Parameters

    • interaction: null | "copy" | "cut" | "paste"

      the clipboard interaction (copy, cut or paste).

    • cells: IBaseCell[]

      the cells copied, cut or pasted.

    Returns void

removeClass

  • removeClass(name: string): void

  • Remove a class name from the widget's DOM node.

    Parameters

    • name: string

      The class name to remove from the node.

      Notes

      If the class name is not yet added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

ProtectedremoveHeader

renderCellOutputs

  • renderCellOutputs(index: number): void

  • Force rendering the cell outputs of a given cell if it is still a placeholder.

    Notes

    The goal of this method is to allow search on cell outputs (that is based on DOM tree introspection).

    Parameters

    • index: number

      The cell index

    Returns void

scrollTo

  • scrollTo(scrollOffset: number): void

  • Scroll to the specified offset scrollTop.

    Parameters

    • scrollOffset: number

      Offset to scroll

    Returns void

    Deprecated

    since v4 This is an internal helper. Prefer calling scrollToItem.

scrollToCell

scrollToItem

  • scrollToItem(
        index: number,
        align?: ScrollToAlign,
        margin?: number,
        alignPreference?: BaseScrollToAlignment,
    ): Promise<void>

  • Scroll to the specified item.

    By default, the list will scroll as little as possible to ensure the item is fully visible (auto). You can control the alignment of the item though by specifying a second alignment parameter. Acceptable values are:

    auto - Automatically align with the top or bottom minimising the amount scrolled, If alignPreference is given, follow such preferred alignment. If item is smaller than the viewport and fully visible, do not scroll at all. smart - If the item is significantly visible, don't scroll at all (regardless of whether it fits in the viewport). If the item is less than one viewport away, scroll so that it becomes fully visible (following the auto heuristics). If the item is more than one viewport away, scroll so that it is centered within the viewport (center if smaller than viewport, top-center otherwise). center - Align the middle of the item with the middle of the viewport (it only works well for items smaller than the viewport). top-center - Align the top of the item with the middle of the viewport (works well for items larger than the viewport). end - Align the bottom of the item to the bottom of the list. start - Align the top of item to the top of the list.

    Parameters

    • index: number

      Item index to scroll to

    • Optionalalign: ScrollToAlign

      Type of alignment

    • Optionalmargin: number

      In 'smart' mode the viewport proportion to add

    • OptionalalignPreference: BaseScrollToAlignment

      Allows to override the alignment of item when the auto heuristic decides that the item needs to be scrolled into view.

    Returns Promise<void>

select

setFlag

  • setFlag(flag: Flag): void

  • Set the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.

    Parameters

    • flag: Flag

    Returns void

setFragment

setHidden

  • setHidden(hidden: boolean): void

  • Show or hide the widget according to a boolean value.

    Parameters

    • hidden: boolean

      true to hide the widget, or false to show it.

      Notes

      This is a convenience method for hide() and show().

    Returns void

ProtectedsetMode

  • setMode(newValue: NotebookMode, options?: { focus?: boolean }): void

  • Set the notebook mode.

    Parameters

    • newValue: NotebookMode

      Notebook mode

    • options: { focus?: boolean } = {}

      Control mode side-effect

      • Optionalfocus?: boolean

        Whether to ensure focus (default) or not when setting the mode.

    Returns void

show

  • show(): void

  • Show the widget and make it visible to its parent widget.

    Notes

    This causes the isHidden property to be false.

    If the widget is not explicitly hidden, this is a no-op.

    Returns void

testFlag

  • testFlag(flag: Flag): boolean

  • Test whether the given widget flag is set.

    Notes

    This will not typically be called directly by user code.

    Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.

    Parameters

    • flag: Flag

    Returns boolean

toggleClass

  • toggleClass(name: string, force?: boolean): boolean

  • Toggle a class name on the widget's DOM node.

    Parameters

    • name: string

      The class name to toggle on the node.

    • Optionalforce: boolean

      Whether to force add the class (true) or force remove the class (false). If not provided, the presence of the class will be toggled from its current state.

    Returns boolean

    true if the class is now present, false otherwise.

    Notes

    The class name must not contain whitespace.

update

  • update(): void

  • Post an 'update-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
_onCellsChangedactivateaddClassaddFooteraddHeaderchildrenclearFlagclosecontainsdeselectdeselectAlldisposeextendContiguousSelectionTofitgetContiguousSelectionhandleEventhasClasshasNavigableModifiedCellBackhasNavigableModifiedCellForwardhideisSelectedisSelectedOrActivemoveCellnotifyLayoutonActivateRequestonAfterAttachonAfterDetachonAfterHideonAfterShowonBeforeAttachonBeforeDetachonBeforeHideonBeforeShowonCellInsertedonCellRemovedonChildAddedonChildRemovedonCloseRequestonFitRequestonMetadataChangedonModelChangedonModelContentChangedonResizeonScrollonStateChangedonUpdateRequestpopLastModifiedCellpopNextModifiedCellprocessMessagerecordCellClipboardInteractionremoveClassremoveHeaderrenderCellOutputsscrollToscrollToCellscrollToItemselectsetFlagsetFragmentsetHiddensetModeshowtestFlagtoggleClassupdate