WidgetTracker | @jupyterlab (original) (raw)

Type Parameters

• T extends Widget = Widget

Hierarchy (View Summary)

• WidgetTracker
  • NotebookTracker

Implements

• IWidgetTracker<T>
• IRestorable<T>

Index

Constructors

constructor

• new WidgetTracker<T extends Widget = Widget>(
  options: WidgetTracker.IOptions,
  ): WidgetTracker<T>

• Type Parameters

  • T extends Widget = Widget

Returns WidgetTracker<T>

Properties

Readonlynamespace

namespace: string

Accessors

currentChanged

• get currentChanged(): ISignal<this, null | T>

• Returns ISignal<this, null | T>

currentWidget

• get currentWidget(): null | T

• Returns null | T

isDisposed

• get isDisposed(): boolean

• Returns boolean

restored

• get restored(): Promise<void>

• Returns Promise<void>

size

• get size(): number

• Returns number

widgetAdded

• get widgetAdded(): ISignal<this, T>

• Returns ISignal<this, T>

widgetUpdated

• get widgetUpdated(): ISignal<this, T>

• Returns ISignal<this, T>

Methods

add

• add(widget: T): Promise<void>

• Returns Promise<void>

defer

• defer(options: IRestorable.IOptions<T>): void

• Returns void

dispose

• dispose(): void

• Returns void

filter

• filter(fn: (widget: T) => boolean): T[]

• Parameters

  • fn: (widget: T) => boolean

Returns T[]

find

• find(fn: (widget: T) => boolean): undefined | T

• Parameters

  • fn: (widget: T) => boolean

Returns undefined | T

forEach

• forEach(fn: (widget: T) => void): void

• Parameters

  • fn: (widget: T) => void

Returns void

has

• has(widget: Widget): boolean

• Returns boolean

inject

• inject(widget: T): Promise<void>

• Returns Promise<void>

ProtectedonCurrentChanged

• onCurrentChanged(value: null | T): void

• Parameters

  • value: null | T

Returns void

restore

• restore(options?: IRestorable.IOptions<T>): Promise<any>

• Returns Promise<any>

A promise that resolves when restoration has completed.

Notes

This function should not typically be invoked by client code. Its primary use case is to be invoked by a restorer.

save

• save(widget: T): Promise<void>

• Returns Promise<void>