Class CodeConsole

A widget containing a Jupyter console.

Notes

The CodeConsole class is intended to be used within a ConsolePanel instance. Under most circumstances, it is not instantiated by user code.

Hierarchy

Constructors

constructor

Properties

contentFactory editorConfig modelFactory node rendermime sessionContext

Accessors

cells dataset disposed executed hiddenMode id isAttached isDisposed isHidden isVisible layout parent promptCell promptCellCreated title

Methods

activate addBanner addCell addClass children clear clearFlag close contains createCodeCell dispose execute fit getCell handleEvent hasClass hide inject insertLinebreak newPromptCell notifyLayout onActivateRequest onAfterAttach onAfterDetach onAfterHide onAfterShow onBeforeAttach onBeforeDetach onBeforeHide onBeforeShow onChildAdded onChildRemoved onCloseRequest onFitRequest onResize onUpdateRequest processMessage removeClass replaceSelection serialize setConfig setFlag setHidden show testFlag toggleClass update

Constructors

constructor

Properties

ReadonlycontentFactory

contentFactory: CodeConsole.IContentFactory

The content factory used by the console.

editorConfig

editorConfig: Record<string, any> = CodeConsole.defaultEditorConfig

The configuration options for the text editor widget.

ReadonlymodelFactory

modelFactory: CodeConsole.IModelFactory

The model factory for the console widget.

Readonlynode

node: HTMLElement

Get the DOM node owned by the widget.

Readonlyrendermime

rendermime: IRenderMimeRegistry

The rendermime instance used by the console.

ReadonlysessionContext

sessionContext: ISessionContext

The client session used by the console.

Accessors

cells

dataset

  • get dataset(): DOMStringMap

  • The dataset for the widget's DOM node.

    Returns DOMStringMap

disposed

  • get disposed(): ISignal<this, void>

  • A signal emitted when the widget is disposed.

    Returns ISignal<this, void>

executed

hiddenMode

  • get hiddenMode(): HiddenMode

  • Get the method for hiding the widget.

    Returns HiddenMode

  • set hiddenMode(value: HiddenMode): void

  • Set the method for hiding the widget.

    Parameters

    • value: HiddenMode

    Returns void

id

  • get id(): string

  • Get the id of the widget's DOM node.

    Returns string

  • set id(value: string): void

  • Set the id of the widget's DOM node.

    Parameters

    • value: string

    Returns void

isAttached

  • get isAttached(): boolean

  • Test whether the widget's node is attached to the DOM.

    Returns boolean

isDisposed

  • get isDisposed(): boolean

  • Test whether the widget has been disposed.

    Returns boolean

isHidden

  • get isHidden(): boolean

  • Test whether the widget is explicitly hidden.

    Notes

    You should prefer !{@link isVisible} over {@link isHidden} if you want to know if the widget is hidden as this does not test if the widget is hidden because one of its ancestors is hidden.

    Returns boolean

isVisible

  • get isVisible(): boolean

  • Test whether the widget is visible.

    Notes

    A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

    Since 2.7.0, this does not rely on the Widget.Flag.IsVisible flag. It recursively checks the visibility of all parent widgets.

    Returns boolean

layout

  • get layout(): null | Layout

  • Get the layout for the widget.

    Returns null | Layout

  • set layout(value: null | Layout): void

  • Set the layout for the widget.

    Notes

    The layout is single-use only. It cannot be changed after the first assignment.

    The layout is disposed automatically when the widget is disposed.

    Parameters

    • value: null | Layout

    Returns void

parent

  • get parent(): null | Widget

  • Get the parent of the widget.

    Returns null | Widget

  • set parent(value: null | Widget): void

  • Set the parent of the widget.

    Notes

    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.

    Parameters

    Returns void

promptCell

promptCellCreated

title

  • get title(): Title<Widget>

  • The title object for the widget.

    Notes

    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.

    Returns Title<Widget>

Methods

activate

  • activate(): void

  • Post an 'activate-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

addBanner

addCell

  • addCell(cell: CodeCell, msgId?: string): void

  • Add a new cell to the content panel.

    Parameters

    • cell: CodeCell

      The code cell widget being added to the content panel.

    • OptionalmsgId: string

      The optional execution message id for the cell.

      Notes

      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).

    Returns void

addClass

  • addClass(name: string): void

  • Add a class name to the widget's DOM node.

    Parameters

    • name: string

      The class name to add to the node.

      Notes

      If the class name is already added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

children

  • children(): IterableIterator<Widget>

  • Create an iterator over the widget's children.

    Returns IterableIterator<Widget>

    A new iterator over the children of the widget.

    Notes

    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

clearFlag

  • clearFlag(flag: Flag): void

  • Clear the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.

    Parameters

    • flag: Flag

    Returns void

close

  • close(): void

  • Send a 'close-request' message to the widget.

    Notes

    This is a simple convenience method for sending the message.

    Returns void

contains

  • contains(widget: Widget): boolean

  • Test whether a widget is a descendant of this widget.

    Parameters

    • widget: Widget

      The descendant widget of interest.

    Returns boolean

    true if the widget is a descendant, false otherwise.

createCodeCell

dispose

execute

  • execute(force?: boolean, timeout?: number): Promise<void>

  • Execute the current prompt.

    Parameters

    • force: boolean = false

      Whether to force execution without checking code completeness.

    • timeout: number = EXECUTION_TIMEOUT

      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.

    Returns Promise<void>

fit

  • fit(): void

  • Post a 'fit-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

getCell

handleEvent

  • handleEvent(event: Event): void

  • Handle the DOM events for the widget.

    Parameters

    • event: Event

      The DOM event sent to the widget.

      Notes

      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.

    Returns void

hasClass

  • hasClass(name: string): boolean

  • Test whether the widget's DOM node has the given class name.

    Parameters

    • name: string

      The class name of interest.

    Returns boolean

    true if the node has the class, false otherwise.

hide

  • hide(): void

  • Hide the widget and make it hidden to its parent widget.

    Notes

    This causes the isHidden property to be true.

    If the widget is explicitly hidden, this is a no-op.

    Returns void

inject

  • inject(code: string, metadata?: JSONObject): Promise<void>

  • Inject arbitrary code for the console to execute immediately.

    Parameters

    • code: string

      The code contents of the cell being injected.

    • metadata: JSONObject = {}

    Returns Promise<void>

    A promise that indicates when the injected cell's execution ends.

insertLinebreak

ProtectednewPromptCell

ProtectednotifyLayout

  • notifyLayout(msg: Message): void

  • Invoke the message processing routine of the widget's layout.

    Parameters

    • msg: Message

      The message to dispatch to the layout.

      Notes

      This is a no-op if the widget does not have a layout.

      This will not typically be called directly by user code.

    Returns void

ProtectedonActivateRequest

  • onActivateRequest(msg: Message): void

  • Handle 'activate-request' messages.

    Parameters

    • msg: Message

    Returns void

ProtectedonAfterAttach

  • onAfterAttach(msg: Message): void

  • Handle after_attach messages for the widget.

    Parameters

    • msg: Message

    Returns void

ProtectedonAfterDetach

  • onAfterDetach(msg: Message): void

  • A message handler invoked on an 'after-detach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

ProtectedonAfterHide

  • onAfterHide(msg: Message): void

  • A message handler invoked on an 'after-hide' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

ProtectedonAfterShow

  • onAfterShow(msg: Message): void

  • A message handler invoked on an 'after-show' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

ProtectedonBeforeAttach

  • onBeforeAttach(msg: Message): void

  • A message handler invoked on a 'before-attach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

ProtectedonBeforeDetach

  • onBeforeDetach(msg: Message): void

  • Handle before-detach messages for the widget.

    Parameters

    • msg: Message

    Returns void

ProtectedonBeforeHide

  • onBeforeHide(msg: Message): void

  • A message handler invoked on a 'before-hide' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

ProtectedonBeforeShow

  • onBeforeShow(msg: Message): void

  • A message handler invoked on a 'before-show' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

ProtectedonChildAdded

  • onChildAdded(msg: ChildMessage): void

  • A message handler invoked on a 'child-added' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ChildMessage

    Returns void

ProtectedonChildRemoved

  • onChildRemoved(msg: ChildMessage): void

  • A message handler invoked on a 'child-removed' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ChildMessage

    Returns void

ProtectedonCloseRequest

  • onCloseRequest(msg: Message): void

  • A message handler invoked on a 'close-request' message.

    Notes

    The default implementation unparents or detaches the widget.

    Parameters

    • msg: Message

    Returns void

ProtectedonFitRequest

  • onFitRequest(msg: Message): void

  • A message handler invoked on a 'fit-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

ProtectedonResize

  • onResize(msg: ResizeMessage): void

  • A message handler invoked on a 'resize' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ResizeMessage

    Returns void

ProtectedonUpdateRequest

  • onUpdateRequest(msg: Message): void

  • Handle update-request messages.

    Parameters

    • msg: Message

    Returns void

processMessage

  • processMessage(msg: Message): void

  • Process a message sent to the widget.

    Parameters

    • msg: Message

      The message sent to the widget.

      Notes

      Subclasses may reimplement this method as needed.

    Returns void

removeClass

  • removeClass(name: string): void

  • Remove a class name from the widget's DOM node.

    Parameters

    • name: string

      The class name to remove from the node.

      Notes

      If the class name is not yet added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

replaceSelection

  • replaceSelection(text: string): void

  • Replaces the selected text in the prompt cell.

    Parameters

    • text: string

      The text to replace the selection.

    Returns void

serialize

setConfig

setFlag

  • setFlag(flag: Flag): void

  • Set the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.

    Parameters

    • flag: Flag

    Returns void

setHidden

  • setHidden(hidden: boolean): void

  • Show or hide the widget according to a boolean value.

    Parameters

    • hidden: boolean

      true to hide the widget, or false to show it.

      Notes

      This is a convenience method for hide() and show().

    Returns void

show

  • show(): void

  • Show the widget and make it visible to its parent widget.

    Notes

    This causes the isHidden property to be false.

    If the widget is not explicitly hidden, this is a no-op.

    Returns void

testFlag

  • testFlag(flag: Flag): boolean

  • Test whether the given widget flag is set.

    Notes

    This will not typically be called directly by user code.

    Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.

    Parameters

    • flag: Flag

    Returns boolean

toggleClass

  • toggleClass(name: string, force?: boolean): boolean

  • Toggle a class name on the widget's DOM node.

    Parameters

    • name: string

      The class name to toggle on the node.

    • Optionalforce: boolean

      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.

    Returns boolean

    true if the class is now present, false otherwise.

    Notes

    The class name must not contain whitespace.

update

  • update(): void

  • Post an 'update-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

Settings

Member Visibility

On This Page

Notes
Constructors
Properties
Accessors
Methods