Construct a notebook widget.
Set the id of the wrapper's DOM node.
Set the layout for the widget.
The layout is single-use only. It cannot be set to null
and it
cannot be changed after the first assignment.
The layout is disposed automatically when the widget is disposed.
Get the DOM node managed by the wrapper.
This property is read-only.
Set the parent of the widget.
The widget will be automatically removed from its current parent.
This is a no-op if there is no effective parent change.
Get the title data object for the widget.
The title data is used by some container widgets when displaying the widget along with a title, such as a tab panel or dock panel.
Not all widgets will make use of the title data, so it is created on-demand the first time it is accessed.
The active cell index of the notebook.
The active cell index of the notebook.
The interactivity mode of the notebook.
The interactivity mode of the notebook.
Get the model for the widget.
This is a read-only property.
Get the rendermime instance used by the widget.
This is a read-only property.
A signal emitted when the state of the notebook changes.
Handle click
events for the widget.
Handle dblclick
events for the widget.
Add a class name to the wrapper'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.
Attach the widget to a host DOM node.
The DOM node to use as the widget's host.
Get the child widget at the specified index.
Get the number of child widgets.
Clear the given widget flag.
This will not typically be consumed directly by user code.
Send a 'close-request'
message to the widget.
See also: [[MsgCloseRequest]]
Compress a message posted to the widget.
The message posted to the widget.
The queue of pending messages for the widget.
true
if the message should be ignored, or false
if
the message should be enqueued for delivery as normal.
Subclasses may reimplement this method as needed.
Test whether a widget is a descendant of this widget.
The widget of interest.
true
if the widget is a descendant, false
otherwise.
Deselect a cell widget.
This has no effect on the "active" cell.
Detach the widget from its host DOM node.
Dispose of the resources held by the widget.
Find the cell index containing the target html element.
Returns -1 if the cell is not found.
Post a 'fit-request'
message to the widget.
See also: [[MsgFitRequest]]
The mime type for code cells.
The default implementation uses the language info to set the mimetype.
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 dock panel's node. It should
not be called directly by user code.
Test whether the wrapper'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
.
Initialize a cell widget.
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.
Handle after_attach
messages for the widget.
A message handler invoked on an 'after-show'
message.
The default implementation of this handler is a no-op.
See also: [[MsgAfterShow]]
Handle before_detach
messages for the widget.
A message handler invoked on a 'before-hide'
message.
The default implementation of this handler is a no-op.
See also: [[MsgBeforeHide]]
Handle a change cells event.
A message handler invoked on a 'child-added'
message.
The default implementation of this handler is a no-op.
See also: [[ChildMessage]]
A message handler invoked on a 'child-removed'
message.
The default implementation of this handler is a no-op.
See also: [[ChildMessage]]
A message handler invoked on a 'close-request'
message.
The default implementation of this handler detaches the widget.
See also: close, [[MsgCloseRequest]]
Handle edge request signals from cells.
Handle changes to the notebook model.
A message handler invoked on a 'resize'
message.
The default implementation of this handler is a no-op.
See also: [[ResizeMessage]]
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 wrapper'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.
Select a cell widget.
Set the given widget flag.
This will not typically be consumed directly by user code.
Set whether the widget is hidden.
true
to hide the widget, or false
to show it.
widget.setHidden(true)
is equivalent to widget.hide()
, and
widget.setHidden(false)
is equivalent to widget.show()
.
Show the widget and make it visible to its parent widget.
This causes the isHidden property to be false
.
Test whether the given widget flag is set.
This will not typically be consumed directly by user code.
Toggle a class name on the wrapper'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.
Post an 'update-request'
message to the widget.
See also: [[MsgUpdateRequest]]
Create a new cell widget given a cell model.
Create the DOM node for a new node wrapper instance.
The DOM node to use with the node wrapper instance.
The default implementation creates an empty <div>
.
This may be reimplemented by a subclass to create a custom node.
Generated using TypeDoc
A notebook widget that supports interactivity.