NotebookPanel | @jupyterlab (original) (raw)

Hierarchy (View Summary)

• DocumentWidget<Notebook, INotebookModel>
  • NotebookPanel

Index

Constructors

constructor

• new NotebookPanel(
  options: DocumentWidget.IOptions<Notebook, INotebookModel>,
  ): NotebookPanel

• Returns NotebookPanel

Properties

Protected Readonly_trans

Readonlycontext

OptionalisUntitled

isUntitled?: boolean

Readonlynode

translator

Accessors

content

• get content(): T

• Returns T

contentHeader

• get contentHeader(): BoxPanel

• Returns BoxPanel

dataset

• get dataset(): DOMStringMap

• Returns DOMStringMap

disposed

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

• Returns ISignal<this, void>

hiddenMode

• get hiddenMode(): HiddenMode

• Returns HiddenMode

• set hiddenMode(value: HiddenMode): void

• Parameters

  • value: HiddenMode

Returns void

id

• get id(): string

• Returns string

• set id(value: string): void

• Returns void

isAttached

• get isAttached(): boolean

• Returns boolean

isDisposed

• get isDisposed(): boolean

• Returns boolean

isHidden

• get isHidden(): boolean

• Returns boolean

isRevealed

• get isRevealed(): boolean

• Returns boolean

isVisible

• get isVisible(): boolean

• Returns boolean

layout

• get layout(): null | Layout

• Returns null | Layout

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

• Parameters

  • value: null | Layout

Returns void

model

• get model(): null | INotebookModel

• Returns null | INotebookModel

parent

• get parent(): null | Widget

• Returns null | Widget

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

• Parameters

  • value: null | Widget

Returns void

revealed

• get revealed(): Promise<void>

• Returns Promise<void>

sessionContext

• get sessionContext(): ISessionContext

• Returns ISessionContext

title

• get title(): Title<Widget>

• Returns Title<Widget>

toolbar

• get toolbar(): Toolbar<Widget>

• Returns Toolbar<Widget>

Methods

[symbol]

• "[symbol]"(): () => Promise<void>

• Returns () => Promise<void>

activate

• activate(): void

• Returns void

addClass

• addClass(name: string): void

• Returns void

children

• children(): IterableIterator<Widget>

• 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

• 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

• Returns boolean

true if the node has the class, false otherwise.

hide

• hide(): void

• Returns void

ProtectednotifyLayout

• notifyLayout(msg: Message): void

• 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

• Returns void

removeClass

• removeClass(name: string): void

• Returns void

setConfig

• setConfig(config: NotebookPanel.IConfig): void

• Returns void

setFlag

• setFlag(flag: Flag): void

• Returns void

setFragment

• setFragment(fragment: string): void

• Parameters

  • fragment: string

Returns void

setHidden

• setHidden(hidden: boolean): void

• Parameters

  • hidden: boolean

Returns void

show

• show(): void

• Returns void

testFlag

• testFlag(flag: Flag): boolean

• Returns boolean

toggleClass

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

• Parameters

  • name: string
  • Optionalforce: boolean

Returns boolean

true if the class is now present, false otherwise.

Notes

The class name must not contain whitespace.

update

• update(): void

• Returns void