Terminal | @jupyterlab (original) (raw)

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

getOption

• getOption<K extends keyof ITerminal.IOptions>(option: K): ITerminal.IOptions[K]

• Type Parameters

  • K extends keyof ITerminal.IOptions

Returns ITerminal.IOptions[K]

getSelection

• getSelection(): null | string

• Returns null | string

hasClass

• hasClass(name: string): boolean

• Returns boolean

true if the node has the class, false otherwise.

hasSelection

• hasSelection(): boolean

• Returns boolean

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

paste

• paste(data: string): void

• Returns void

processMessage

• processMessage(msg: Message): void

• Returns void

refresh

• refresh(): Promise<void>

• Returns Promise<void>

removeClass

• removeClass(name: string): void

• Returns void

setFlag

• setFlag(flag: Flag): void

• Returns void

setHidden

• setHidden(hidden: boolean): void

• Parameters

  • hidden: boolean

Returns void

setOption

• setOption<K extends keyof ITerminal.IOptions>(
  option: K,
  value: ITerminal.IOptions[K],
  ): void

• Type Parameters

  • K extends keyof ITerminal.IOptions

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