HelpMenu | @jupyterlab (original) (raw)

activate

• activate(): void

• Returns void

activateNextItem

• activateNextItem(): void

• Returns void

activatePreviousItem

• activatePreviousItem(): void

• Returns void

addClass

• addClass(name: string): void

• Returns void

addGroup

• addGroup(items: IRankedMenu.IItemOptions[], rank?: number): IDisposable

• Returns IDisposable

Disposable of the group

addItem

• addItem(options: IRankedMenu.IItemOptions): IDisposableMenuItem

• Returns IDisposableMenuItem

The menu item added to the menu.

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

clearItems

• clearItems(): 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

getRankAt

• getRankAt(index: number): number

• Returns number

Rank of the item.

handleEvent

• handleEvent(event: Event): void

• Returns void

hasClass

• hasClass(name: string): boolean

• Returns boolean

true if the node has the class, false otherwise.

hide

• hide(): void

• Returns void

insertItem

• insertItem(
  index: number,
  options: IRankedMenu.IItemOptions,
  ): IDisposableMenuItem

• Returns IDisposableMenuItem

The menu item added to the menu.

Notes

The index will be clamped to the bounds of the items.

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

open

• open(x: number, y: number, options?: IOpenOptions): void

• Parameters

  • x: number
  • y: number
  • Optionaloptions: IOpenOptions

Returns void

processMessage

• processMessage(msg: Message): void

• Returns void

removeClass

• removeClass(name: string): void

• Returns void

removeItem

• removeItem(item: IItem): void

• Returns void

removeItemAt

• removeItemAt(index: number): void

• Returns void

setFlag

• setFlag(flag: Flag): void

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

triggerActiveItem

• triggerActiveItem(): void

• Returns void

update

• update(): void

• Returns void

StaticsaveWindowData

• saveWindowData(): void

• Returns void