Construct a notebook widget.
The cell factory used by the widget.
The dataset for the widget's DOM node.
A signal emitted when the widget is disposed.
Set the id of the widget's DOM node.
Test whether the widget's node is attached to the DOM.
Test whether the widget has been disposed.
Test whether the widget is explicitly hidden.
Test whether the widget is visible.
A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.
Set the layout for the widget.
The layout is single-use only. It cannot be changed after the first assignment.
The layout is disposed automatically when the widget is disposed.
Get the DOM node owned by the widget.
Set the parent of the widget.
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.
The Rendermime instance used by the widget.
The title object for the widget.
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.
Default content factory for the static notebook widget.
Get the active cell widget.
This is a cell or null if there is no active cell.
A signal emitted when the active cell changes.
This can be due to the active index changing or the cell at the active index changing.
The active cell index of the notebook.
The index will be clamped to the bounds of the notebook cells.
The active cell index of the notebook.
The index will be clamped to the bounds of the notebook cells.
Get the mimetype for code cells.
A configuration object for cell editor settings.
A configuration object for cell editor settings.
The interactivity mode of the notebook.
The interactivity mode of the notebook.
The model for the widget.
The model for the widget.
A signal emitted when the model of the notebook changes.
A signal emitted when the model content changes.
This is a convenience signal that follows the current model.
A configuration object for notebook settings.
A configuration object for notebook settings.
A signal emitted when the selection state of the notebook changes.
A signal emitted when the state of the notebook changes.
A read-only sequence of the widgets in the notebook.
Ensure that the notebook has proper focus.
Handle contextmenu event.
Handle dblclick events for the widget.
Handle the 'mousemove' event for the widget.
Handle the 'mouseup' event on the document.
Handle the 'p-dragenter' event for the widget.
Handle the 'p-dragleave' event for the widget.
Handle the 'p-dragover' event for the widget.
Handle the 'p-drop' event for the widget.
Handle focus events for the widget.
Handle focusout events for the notebook.
Handle mousedown events for the widget.
Handle mousedown event in the capture phase for the widget.
Find the cell index containing the target html element.
Returns -1 if the cell is not found.
Handle edge request signals from cells.
Start a drag event.
Remove selections from inactive cells to avoid spurious cursors.
Post an 'activate-request' message to the widget.
This is a simple convenience method for posting the message.
Add a class name to the widget's DOM node.
The class name to add to the node.
If the class name is already added to the node, this is a no-op.
The class name must not contain whitespace.
Create an iterator over the widget's children.
A new iterator over the children of the widget.
The widget must have a populated layout in order to have children.
If a layout is not installed, the returned iterator will be empty.
Clear the given widget flag.
This will not typically be called directly by user code.
Send a 'close-request' message to the widget.
This is a simple convenience method for sending the message.
Test whether a widget is a descendant of this widget.
The descendant widget of interest.
true if the widget is a descendant, false otherwise.
Deselect a cell widget.
It is a no-op if the value does not change.
It will emit the selectionChanged signal.
Deselect all of the cells.
Dispose of the resources held by the widget.
Move the head of an existing contiguous selection to extend the selection.
The new head of the existing selection.
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).
Post a 'fit-request' message to the widget.
This is a simple convenience method for posting the message.
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.
Handle the DOM events for the widget.
The DOM event sent to the widget.
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.
Test whether the widget's DOM node has the given class name.
The class name of interest.
true if the node has the class, false otherwise.
Hide the widget and make it hidden to its parent widget.
This causes the isHidden property to be true.
If the widget is explicitly hidden, this is a no-op.
Whether a cell is selected.
Whether a cell is selected or is the active cell.
Invoke the message processing routine of the widget's layout.
The message to dispatch to the layout.
This is a no-op if the widget does not have a layout.
This will not typically be called directly by user code.
Handle 'activate-request' messages.
Handle after-attach messages for the widget.
A message handler invoked on an 'after-detach' message.
The default implementation of this handler is a no-op.
A message handler invoked on an 'after-hide' message.
The default implementation of this handler is a no-op.
A message handler invoked on an 'after-show' message.
A message handler invoked on a 'before-attach' message.
The default implementation of this handler is a no-op.
Handle before-detach messages for the widget.
A message handler invoked on an 'before-hide' message.
A message handler invoked on a 'before-show' message.
The default implementation of this handler is a no-op.
Handle a cell being inserted.
Handle a cell being moved.
Handle a cell being removed.
A message handler invoked on a 'child-added' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'child-removed' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'close-request' message.
The default implementation unparents or detaches the widget.
A message handler invoked on a 'fit-request' message.
The default implementation of this handler is a no-op.
Handle changes to the notebook model metadata.
The default implementation updates the mimetypes of the code cells
when the language_info metadata changes.
Handle a new model.
Handle changes to the notebook model content.
The default implementation emits the modelContentChanged signal.
A message handler invoked on a 'resize' message.
Handle update-request messages sent to the widget.
Process a message sent to the widget.
The message sent to the widget.
Subclasses may reimplement this method as needed.
Remove a class name from the widget's DOM node.
The class name to remove from the node.
If the class name is not yet added to the node, this is a no-op.
The class name must not contain whitespace.
Scroll so that the given position is centered.
The vertical position in the notebook widget.
An optional threshold for the scroll (0-50, defaults to 25).
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.
Select a cell widget.
It is a no-op if the value does not change.
It will emit the selectionChanged signal.
Set the given widget flag.
This will not typically be called directly by user code.
Set URI fragment identifier.
Show or hide the widget according to a boolean value.
true to hide the widget, or false to show it.
This is a convenience method for hide() and show().
Show the widget and make it visible to its parent widget.
This causes the isHidden property to be false.
If the widget is not explicitly hidden, this is a no-op.
Test whether the given widget flag is set.
This will not typically be called directly by user code.
Toggle a class name on the widget's DOM node.
The class name to toggle on the node.
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.
true if the class is now present, false otherwise.
The class name must not contain whitespace.
Post an 'update-request' message to the widget.
This is a simple convenience method for posting the message.
Default configuration options for cell editors.
Default configuration options for notebooks.
Generated using TypeDoc
A notebook widget that supports interactivity. The namespace for the
Notebookclass statics.