Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Notebook

A notebook widget that supports interactivity.

Hierarchy

Index

Constructors

constructor

Properties

Private _activeCell

_activeCell: any

Private _activeCellChanged

_activeCellChanged: any

Private _activeCellIndex

_activeCellIndex: any

Private Optional _cellLayoutStateCache

_cellLayoutStateCache: any

Private _checkCacheOnNextResize

_checkCacheOnNextResize: any

Private _drag

_drag: any

Private _dragData

_dragData: any

Private _ensureFocus

_ensureFocus: any

Ensure that the notebook has proper focus.

Private _evtContextMenuCapture

_evtContextMenuCapture: any

Handle contextmenu event.

Private _evtDblClick

_evtDblClick: any

Handle dblclick events for the widget.

Private _evtDocumentMousemove

_evtDocumentMousemove: any

Handle the 'mousemove' event for the widget.

Private _evtDocumentMouseup

_evtDocumentMouseup: any

Handle the 'mouseup' event on the document.

Private _evtDragEnter

_evtDragEnter: any

Handle the 'lm-dragenter' event for the widget.

Private _evtDragLeave

_evtDragLeave: any

Handle the 'lm-dragleave' event for the widget.

Private _evtDragOver

_evtDragOver: any

Handle the 'lm-dragover' event for the widget.

Private _evtDrop

_evtDrop: any

Handle the 'lm-drop' event for the widget.

Private _evtFocusIn

_evtFocusIn: any

Handle focus events for the widget.

Private _evtFocusOut

_evtFocusOut: any

Handle focusout events for the notebook.

Private _evtMouseDown

_evtMouseDown: any

Handle mousedown events for the widget.

Private _evtMouseDownCapture

_evtMouseDownCapture: any

Handle mousedown event in the capture phase for the widget.

Private _findCell

_findCell: any

Find the cell index containing the target html element.

Notes

Returns -1 if the cell is not found.

Private _findEventTargetAndCell

_findEventTargetAndCell: any

Find the target of html mouse event and cell index containing this target.

Notes

Returned index is -1 if the cell is not found.

Private _fragment

_fragment: any

Private _mode

_mode: any

Private _mouseMode

_mouseMode: any

Private _onEdgeRequest

_onEdgeRequest: any

Handle edge request signals from cells.

Private _selectionChanged

_selectionChanged: any

Private _startDrag

_startDrag: any

Start a drag event.

Private _stateChanged

_stateChanged: any

Private _trimSelections

_trimSelections: any

Remove selections from inactive cells to avoid spurious cursors.

Readonly contentFactory

contentFactory: IContentFactory

The cell factory used by the widget.

Readonly dataset

dataset: DOMStringMap

The dataset for the widget's DOM node.

Readonly disposed

disposed: ISignal<Notebook, void>

A signal emitted when the widget is disposed.

id

id: string

Set the id of the widget's DOM node.

Readonly isAttached

isAttached: boolean

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

Readonly isDisposed

isDisposed: boolean

Test whether the widget has been disposed.

Readonly isHidden

isHidden: boolean

Test whether the widget is explicitly hidden.

Readonly isVisible

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.

layout

layout: Layout

Set the layout for the widget.

Notes

The layout is single-use only. It cannot be changed after the first assignment.

The layout is disposed automatically when the widget is disposed.

Readonly node

node: HTMLElement

Get the DOM node owned by the widget.

parent

parent: Widget

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.

Readonly rendermime

The Rendermime instance used by the widget.

Readonly title

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.

Accessors

activeCell

  • Get the active cell widget.

    Notes

    This is a cell or null if there is no active cell.

    Returns Cell<ICellModel>

activeCellChanged

  • A signal emitted when the active cell changes.

    Notes

    This can be due to the active index changing or the cell at the active index changing.

    Returns ISignal<this, Cell<ICellModel>>

activeCellIndex

  • get activeCellIndex(): number
  • set activeCellIndex(newValue: number): void
  • The active cell index of the notebook.

    Notes

    The index will be clamped to the bounds of the notebook cells.

    Returns number

  • The active cell index of the notebook.

    Notes

    The index will be clamped to the bounds of the notebook cells.

    Parameters

    • newValue: number

    Returns void

codeMimetype

  • get codeMimetype(): string
  • Get the mimetype for code cells.

    Returns string

editorConfig

  • A configuration object for cell editor settings.

    Returns IEditorConfig

  • A configuration object for cell editor settings.

    Parameters

    Returns void

fullyRendered

  • get fullyRendered(): ISignal<this, boolean>
  • A signal emitted when the notebook is fully rendered.

    Returns ISignal<this, boolean>

mode

  • The interactivity mode of the notebook.

    Returns NotebookMode

  • The interactivity mode of the notebook.

    Parameters

    Returns void

model

  • The model for the widget.

    Returns INotebookModel

  • The model for the widget.

    Parameters

    Returns void

modelChanged

  • get modelChanged(): ISignal<this, void>
  • A signal emitted when the model of the notebook changes.

    Returns ISignal<this, void>

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

  • A configuration object for notebook settings.

    Returns INotebookConfig

  • A configuration object for notebook settings.

    Parameters

    Returns void

placeholderCellRendered

  • A signal emitted when the a placeholder cell is rendered.

    Returns ISignal<this, Cell<ICellModel>>

selectionChanged

  • get selectionChanged(): ISignal<this, void>
  • A signal emitted when the selection state of the notebook changes.

    Returns ISignal<this, void>

stateChanged

  • get stateChanged(): ISignal<this, IChangedArgs<any, any, string>>
  • A signal emitted when the state of the notebook changes.

    Returns ISignal<this, IChangedArgs<any, any, string>>

widgets

  • A read-only sequence of the widgets in the notebook.

    Returns readonly Cell<ICellModel>[]

Methods

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

children

  • children(): IIterator<Widget>
  • Create an iterator over the widget's children.

    Returns IIterator<Widget>

    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.

    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

  • Deselect a cell widget.

    Notes

    It is a no-op if the value does not change. It will emit the selectionChanged signal.

    Parameters

    Returns void

deselectAll

  • deselectAll(): void
  • Deselect all of the cells.

    Returns void

dispose

  • dispose(): void
  • Dispose of the resources held by the widget.

    Returns void

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.

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

  • Whether a cell is selected.

    Parameters

    Returns boolean

isSelectedOrActive

  • Whether a cell is selected or is the active cell.

    Parameters

    Returns boolean

Protected notifyLayout

  • 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

Protected onActivateRequest

  • onActivateRequest(msg: Message): void
  • Handle 'activate-request' messages.

    Parameters

    • msg: Message

    Returns void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void
  • Handle after-attach messages for the widget.

    Parameters

    • msg: Message

    Returns void

Protected onAfterDetach

  • 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

Protected onAfterHide

  • 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

Protected onAfterShow

  • onAfterShow(msg: Message): void
  • A message handler invoked on an 'after-show' message.

    Parameters

    • msg: Message

    Returns void

Protected onBeforeAttach

  • 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

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void
  • Handle before-detach messages for the widget.

    Parameters

    • msg: Message

    Returns void

Protected onBeforeHide

  • onBeforeHide(msg: Message): void
  • A message handler invoked on an 'before-hide' message.

    Parameters

    • msg: Message

    Returns void

Protected onBeforeShow

  • 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

Protected onCellInserted

Protected onCellMoved

  • onCellMoved(fromIndex: number, toIndex: number): void
  • Handle a cell being moved.

    Parameters

    • fromIndex: number
    • toIndex: number

    Returns void

Protected onCellRemoved

Protected onChildAdded

  • 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

Protected onChildRemoved

  • 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

Protected onCloseRequest

  • 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

Protected onFitRequest

  • 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

Protected onMetadataChanged

  • Handle changes to the notebook model metadata.

    Notes

    The default implementation updates the mimetypes of the code cells when the language_info metadata changes.

    Parameters

    Returns void

Protected onModelChanged

Protected onModelContentChanged

Protected onResize

  • onResize(msg: ResizeMessage): void
  • A message handler invoked on a 'resize' message.

    Parameters

    • msg: ResizeMessage

    Returns void

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void
  • Handle update-request messages sent to the widget.

    Parameters

    • msg: Message

    Returns void

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

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

scrollToCell

  • Scroll so that the given cell is in view. Selects and activates cell.

    Parameters

    Returns void

scrollToPosition

  • scrollToPosition(position: number, threshold?: number): void
  • Scroll so that the given position is centered.

    Parameters

    • position: number

      The vertical position in the notebook widget.

    • Optional threshold: number

      An optional threshold for the scroll (0-50, defaults to 25).

      Notes

      If the position is within the threshold percentage of the widget height, measured from the center of the widget, the scroll position will not be changed. A threshold of 0 means we will always scroll so the position is centered, and a threshold of 50 means scrolling only happens if position is outside the current window.

    Returns void

select

  • Select a cell widget.

    Notes

    It is a no-op if the value does not change. It will emit the selectionChanged signal.

    Parameters

    Returns void

setFlag

  • setFlag(flag: Flag): void
  • Set the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

setFragment

  • setFragment(fragment: string): void
  • Set URI fragment identifier.

    Parameters

    • fragment: string

    Returns void

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

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.

    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.

    • Optional force: 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

Generated using TypeDoc