Construct a notebook widget.
Create a code cell widget from a code cell model.
Create a markdown cell widget from a markdown cell model.
Create a placeholder cell widget from a raw cell model.
Create a raw cell widget from a raw cell model.
Create a cell widget and insert into the notebook.
Move a cell widget.
Handle a change cells event.
Handle an update to the collaborators.
Handle a new model on the widget.
Remove a cell widget.
Update editor settings for notebook cells.
Update the mimetype of the notebook.
Apply updated notebook settings.
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 method for hiding the widget.
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.
Translator to be used by cell renderers
Get the mimetype for code cells.
A configuration object for cell editor settings.
A configuration object for cell editor settings.
A signal emitted when the notebook is fully rendered.
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 a placeholder cell is rendered.
A signal emitted when the rendering layout of the notebook changes.
A read-only sequence of the widgets in the notebook.
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.
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.
Dispose of the resources held by the widget.
Post a 'fit-request' message to the widget.
This is a simple convenience method for posting the message.
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.
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.
A message handler invoked on an 'activate-request' message.
The default implementation of this handler is a no-op.
A message handler invoked on an 'after-attach' message.
The default implementation of this handler is a no-op.
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.
The default implementation of this handler is a no-op.
A message handler invoked on a 'before-attach' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'before-detach' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'before-hide' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'before-show' message.
The default implementation of this handler is a no-op.
Handle a cell being inserted.
The default implementation is a no-op
Handle a cell being moved.
The default implementation is a no-op
Handle a cell being removed.
The default implementation is a no-op
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.
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.
Handle changes to the notebook model content.
The default implementation emits the modelContentChanged signal.
A message handler invoked on a 'resize' message.
The default implementation of this handler is a no-op.
A message handler invoked on an 'update-request' message.
The default implementation of this handler is a no-op.
Process a message sent to the widget.
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.
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.
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.
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.