Construct a notebook widget.
Private _cellPrivate _cellPrivate _createCreate a code cell widget from a code cell model.
Private _createCreate a markdown cell widget from a markdown cell model.
Private _createCreate a raw cell widget from a raw cell model.
Private _editorPrivate _idlePrivate _insertCreate a cell widget and insert into the notebook.
Private _mimetypePrivate _mimetypePrivate _modelPrivate _modelPrivate _notebookPrivate _notebookPrivate _onCallback when a cell collapsed status changes.
Cell changed
New collapsed status
Private _onCallback when a cell viewport status changes.
Cell changed
Private _onEnsure to load in the DOM a cell requesting an user input
Cell requesting an input
Private _onHandle a new model on the widget.
Private _removeRemove a cell widget.
Private _renderCSSAndJSOutputsPrivate _renderingPrivate _renderingPrivate _runPrivate _schedulePrivate _updatePrivate _updateUpdate editor settings for notebook cells.
Private _updatePrivate _updateUpdate the mimetype of the notebook.
Private _updateApply updated notebook settings.
Protected _viewProtected cellsReadonly contentThe cell factory used by the widget.
Readonly nodeGet the DOM node owned by the widget.
Readonly rendermimeThe Rendermime instance used by the widget.
Readonly translatorTranslator to be used by cell renderers
Static Readonly DEFAULT_Default widget size
Get the mimetype for code cells.
The dataset for the widget's DOM node.
A configuration object for cell editor settings.
Get the method for hiding the widget.
Set the method for hiding the widget.
Get the id of the widget's DOM node.
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.
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.
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.
Widget layout
The model for the widget.
A configuration object for notebook settings.
Get the parent of 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 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.
Protected viewWindowed list view model
Viewport
A read-only sequence of the widgets in the notebook.
Protected _onHandle a change cells event.
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.
Protected addCreate 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.
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.
Post a 'fit-request' message to the widget.
This is a simple convenience method for posting the message.
Callback on event.
Event
Move cells preserving widget view state.
This is required because at the model level a move is a deletion followed by an insertion. Hence the view state is not preserved.
The index of the cell to move
The new index of the cell
Optional n: numberNumber of cells to move
Protected notifyInvoke 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.
Protected onA message handler invoked on an 'activate-request' message.
The default implementation of this handler is a no-op.
Protected onProtected onA message handler invoked on an 'after-detach' message.
The default implementation of this handler is a no-op.
Protected onA message handler invoked on an 'after-hide' message.
The default implementation of this handler is a no-op.
Protected onA message handler invoked on an 'after-show' message.
The default implementation of this handler is a no-op.
Protected onA message handler invoked on a 'before-attach' message.
The default implementation of this handler is a no-op.
Protected onProtected onA message handler invoked on a 'before-hide' message.
The default implementation of this handler is a no-op.
Protected onA message handler invoked on a 'before-show' message.
The default implementation of this handler is a no-op.
Protected onHandle a cell being inserted.
The default implementation is a no-op
Protected onHandle a cell being removed.
The default implementation is a no-op
Protected onA message handler invoked on a 'child-added' message.
The default implementation of this handler is a no-op.
Protected onA message handler invoked on a 'child-removed' message.
The default implementation of this handler is a no-op.
Protected onA message handler invoked on a 'close-request' message.
The default implementation unparents or detaches the widget.
Protected onA message handler invoked on a 'fit-request' message.
The default implementation of this handler is a no-op.
Protected onHandle changes to the notebook model metadata.
The default implementation updates the mimetypes of the code cells
when the language_info metadata changes.
Protected onHandle a new model.
This method is called after the model change has been handled
internally and before the modelChanged signal is emitted.
The default implementation is a no-op.
Protected onHandle changes to the notebook model content.
The default implementation emits the modelContentChanged signal.
Protected onProtected onCallback on scroll event
Scroll event
Protected onCallback on view model change
Windowed list model
Change
Protected onA message handler invoked on an 'update-request' message.
The default implementation of this handler is a no-op.
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.
Protected removeForce rendering the cell outputs of a given cell if it is still a placeholder.
The goal of this method is to allow search on cell outputs (that is based on DOM tree introspection).
The cell index
Scroll to the specified item.
By default, the list will scroll as little as possible to ensure the item is visible. You can control the alignment of the item though by specifying a second alignment parameter. Acceptable values are:
auto (default) - Scroll as little as possible to ensure the item is visible. (If the item is already visible, it won't scroll at all.) smart - If the item is already visible (including the margin), don't scroll at all. If it is less than one viewport away, scroll so that it becomes visible (including the margin). If it is more than one viewport away, scroll so that it is centered within the list. center - Center align the item within the list. end - Align the item to the end of the list start - Align the item to the beginning of the list
Item index to scroll to
Optional align: ScrollToAlignType of alignment
Optional margin: numberIn 'smart' mode the viewport proportion to add
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().
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.
Optional force: booleanWhether 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.
Generated using TypeDoc
A widget which renders static non-interactive notebooks.
Notes
The widget model must be set separately and can be changed at any time. Consumers of the widget must account for a
nullmodel, and may want to listen to themodelChangedsignal.