API Reference
@univerjs
@univerjs/ui
classes
Menuservice

@univerjs/ui v0.1.17Docs


Class: MenuService

Extends

Implements

Constructors

new MenuService()

new MenuService(_shortcutService): MenuService

Parameters

ParameterType
_shortcutServiceIShortcutService

Returns

MenuService

Overrides

Disposable.constructor

Defined in

packages/ui/src/services/menu/menu.service.ts:52 (opens in a new tab)

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedpackages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
menuChanged$publicObservable<void>undefined-packages/ui/src/services/menu/menu.service.ts:50 (opens in a new tab)

Methods

addMenuItem()

addMenuItem(item, config): IDisposable

Parameters

ParameterType
itemIMenuItem
configMenuConfig

Returns

IDisposable

Implementation of

IMenuService.addMenuItem

Defined in

packages/ui/src/services/menu/menu.service.ts:61 (opens in a new tab)


dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

packages/ui/src/services/menu/menu.service.ts:56 (opens in a new tab)


disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)


getMenuConfig()

getMenuConfig(id): null | MenuConfig

Parameters

ParameterType
idstring

Returns

null | MenuConfig

Defined in

packages/ui/src/services/menu/menu.service.ts:139 (opens in a new tab)


getMenuItem()

getMenuItem(id): null | IMenuItem

Parameters

ParameterType
idstring

Returns

null | IMenuItem

Implementation of

IMenuService.getMenuItem

Defined in

packages/ui/src/services/menu/menu.service.ts:127 (opens in a new tab)


getMenuItems()

getMenuItems(positions): IDisplayMenuItem<IMenuItem>[]

Get menu items for display at a given position or a submenu.

Parameters

ParameterType
positionsstring

Returns

IDisplayMenuItem<IMenuItem>[]

Implementation of

IMenuService.getMenuItems

Defined in

packages/ui/src/services/menu/menu.service.ts:109 (opens in a new tab)


setMenuConfigs()

setMenuConfigs(id, config): void

Parameters

ParameterType
idstring
configMenuConfig

Returns

void

Defined in

packages/ui/src/services/menu/menu.service.ts:135 (opens in a new tab)


setMenuItem()

setMenuItem(item): void

Parameters

ParameterType
itemIMenuItem

Returns

void

Implementation of

IMenuService.setMenuItem

Defined in

packages/ui/src/services/menu/menu.service.ts:122 (opens in a new tab)


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.