Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IJupyterLabMenu

deprecated

since version 3.1

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonly items

items: readonly IItem[]

A read-only array of the menu items in the menu.

Readonly menu

menu: Menu

The underlying Lumino menu.

deprecated

will be removed in v4

Optional Readonly rank

rank: number

Menu rank

Methods

addGroup

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

  • Add a group of menu items specific to a particular plugin.

    The rank can be set for all items in the group using the function argument or per item.

    Parameters

    • items: IItemOptions[]

      the list of menu items to add.

    • Optional rank: number

      the default rank in the menu in which to insert the group.

    Returns IDisposable

    Disposable of the group

addItem

  • Add a menu item to the end of the menu.

    deprecated

    It will return a IDisposable object in v4

    Parameters

    • options: IItemOptions

      The options for creating the menu item.

    Returns IItem

    The menu item added to the menu.

dispose

  • dispose(): void

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

Generated using TypeDoc