Construct a console widget.
The content factory used by the console.
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.
The model factory for the console widget.
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 console.
The client session used by the console.
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.
A default content factory for the code console.
The default ModelFactory instance.
The list of content cells in the console.
This list does not include the current banner or the prompt for a console. It may include previous banners as raw cells.
A signal emitted when the console finished executing its prompt cell.
A signal emitted when a new prompt cell is created.
Create the options used to initialize a code cell widget.
Handle the 'keydown' event for the widget.
Handle mousedown events for the widget.
Handle mousemove event of widget
Handle the 'mouseup' event for the widget.
Execute the code in the current prompt cell.
Update the console based on the kernel info.
Handle cell disposed signals.
Handle a keydown event on an editor.
Handle a change to the kernel.
Handle a change to the kernel status.
Test whether we should execute the prompt cell.
Start a drag event
Post an 'activate-request' message to the widget.
This is a simple convenience method for posting the message.
Add a banner cell.
Add a new cell to the content panel.
The code cell widget being added to the content panel.
The optional execution message id for the cell.
This method is meant for use by outside classes that want to add cells to a
console. It is distinct from the inject method in that it requires
rendered code cell widgets and does not execute them (though it can store
the execution message id).
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 code cells.
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.
Create a new cell with the built-in factory.
Dispose of the resources held by the widget.
Execute the current prompt.
Whether to force execution without checking code completeness.
The length of time, in milliseconds, that the execution
should wait for the API to determine whether code being submitted is
incomplete before attempting submission anyway. The default value is 250.
Post a 'fit-request' message to the widget.
This is a simple convenience method for posting the message.
Get a cell given a message id.
The message id.
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.
Inject arbitrary code for the console to execute immediately.
The code contents of the cell being injected.
A promise that indicates when the injected cell's execution ends.
Insert a line break in the prompt cell.
Make a new prompt 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.
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.
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.
A message handler invoked on a 'before-show' message.
The default implementation of this handler 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.
A message handler invoked on a 'resize' message.
The default implementation of this handler is a no-op.
Handle update-request messages.
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.
Serialize the output.
This only serializes the code cells and the prompt cell if it exists, and skips any old banner cells.
Set the given widget flag.
This will not typically be called directly by user code.
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.
Attach a widget to a host DOM node.
The widget of interest.
The DOM node to use as the widget's host.
The child of host to use as the reference element.
If this is provided, the widget will be inserted before this
node in the host. The default is null, which will cause the
widget to be added as the last child of the host.
This will throw an error if the widget is not a root widget, if the widget is already attached, or if the host is not attached to the DOM.
Detach the widget from its host DOM node.
The widget of interest.
This will throw an error if the widget is not a root widget, or if the widget is not attached to the DOM.
Generated using TypeDoc
A widget containing a Jupyter console. A namespace for CodeConsole statics.
Notes
The CodeConsole class is intended to be used within a ConsolePanel instance. Under most circumstances, it is not instantiated by user code.