Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JupyterLabMenu

An extensible menu for JupyterLab application menus.

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new JupyterLabMenu(options: Menu.IOptions, includeSeparators?: boolean): JupyterLabMenu

  • Construct a new menu.

    Parameters

    • options: Menu.IOptions

      Options for the phosphor menu.

    • Optional includeSeparators: boolean

      whether to include separators between the groups that are added to the menu.

    Returns JupyterLabMenu

Properties

Private _groups

_groups: any

Private _includeSeparators

_includeSeparators: any

Private _isDisposed

_isDisposed: any

Readonly menu

menu: Menu

The underlying Phosphor menu.

Accessors

isDisposed

  • get isDisposed(): boolean

  • Whether the menu has been disposed.

    Returns boolean

Methods

addGroup

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

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

    Parameters

    • items: Menu.IItemOptions[]

      the list of menu items to add.

    • Optional rank: number

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

    Returns IDisposable

dispose

  • dispose(): void

  • Dispose of the resources held by the menu.

    Returns void

Generated using TypeDoc