IFrame | @jupyterlab (original) (raw)

activate

• activate(): void

• Returns void

addClass

• addClass(name: string): void
• Add a class name to the widget's DOM node.

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.

clearFlag

• clearFlag(flag: Flag): void

• Returns void

close

• close(): void

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

dispose

• dispose(): void

• Returns void

fit

• fit(): void

• 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

• Returns void

ProtectednotifyLayout

• notifyLayout(msg: Message): void
• Invoke the message processing routine of the widget's layout.

Returns void

ProtectedonActivateRequest

• onActivateRequest(msg: Message): void

• Returns void

ProtectedonAfterAttach

• onAfterAttach(msg: Message): void

• Returns void

ProtectedonAfterDetach

• onAfterDetach(msg: Message): void

• Returns void

ProtectedonAfterHide

• onAfterHide(msg: Message): void

• Returns void

ProtectedonAfterShow

• onAfterShow(msg: Message): void

• Returns void

ProtectedonBeforeAttach

• onBeforeAttach(msg: Message): void

• Returns void

ProtectedonBeforeDetach

• onBeforeDetach(msg: Message): void

• Returns void

ProtectedonBeforeHide

• onBeforeHide(msg: Message): void

• Returns void

ProtectedonBeforeShow

• onBeforeShow(msg: Message): void

• Returns void

ProtectedonChildAdded

• onChildAdded(msg: ChildMessage): void

• Parameters

  • msg: ChildMessage

Returns void

ProtectedonChildRemoved

• onChildRemoved(msg: ChildMessage): void

• Parameters

  • msg: ChildMessage

Returns void

ProtectedonCloseRequest

• onCloseRequest(msg: Message): void

• Returns void

ProtectedonFitRequest

• onFitRequest(msg: Message): void

• Returns void

ProtectedonResize

• onResize(msg: ResizeMessage): void

• Parameters

  • msg: ResizeMessage

Returns void

ProtectedonUpdateRequest

• onUpdateRequest(msg: Message): void

• Returns void

processMessage

• processMessage(msg: Message): void
• Process a message sent to the widget.

Returns void

removeClass

• removeClass(name: string): void
• Remove a class name from the widget's DOM node.

Returns void

setFlag

• setFlag(flag: Flag): void

• Returns void

setHidden

• setHidden(hidden: boolean): void
• Show or hide the widget according to a boolean value.

Parameters

• hidden: boolean

Returns void

show

• show(): void

• Returns void

testFlag

• testFlag(flag: Flag): boolean

• 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

• Returns void