@univerjs/ui v0.1.17 • Docs
Class: MenuService
Extends
Implements
Constructors
new MenuService()
new MenuService(_shortcutService): MenuService
Parameters
Parameter | Type |
---|---|
_shortcutService | IShortcutService |
Returns
Overrides
Defined in
packages/ui/src/services/menu/menu.service.ts:52 (opens in a new tab)
Properties
Property | Modifier | Type | Default value | Inherited from | Defined in |
---|---|---|---|---|---|
_disposed | protected | boolean | false | Disposable ._disposed | packages/core/src/shared/lifecycle.ts:93 (opens in a new tab) |
menuChanged$ | public | Observable <void > | undefined | - | packages/ui/src/services/menu/menu.service.ts:50 (opens in a new tab) |
Methods
addMenuItem()
addMenuItem(item, config): IDisposable
Parameters
Parameter | Type |
---|---|
item | IMenuItem |
config | MenuConfig |
Returns
IDisposable
Implementation of
Defined in
packages/ui/src/services/menu/menu.service.ts:61 (opens in a new tab)
dispose()
dispose(): void
Returns
void
Overrides
Defined in
packages/ui/src/services/menu/menu.service.ts:56 (opens in a new tab)
disposeWithMe()
protected disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
IDisposable
Inherited from
Defined in
packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)
ensureNotDisposed()
protected ensureNotDisposed(): void
Returns
void
Inherited from
Defined in
packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)
getMenuConfig()
getMenuConfig(id): null | MenuConfig
Parameters
Parameter | Type |
---|---|
id | string |
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
Parameter | Type |
---|---|
id | string |
Returns
null
| IMenuItem
Implementation of
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
Parameter | Type |
---|---|
positions | string |
Returns
Implementation of
Defined in
packages/ui/src/services/menu/menu.service.ts:109 (opens in a new tab)
setMenuConfigs()
setMenuConfigs(id, config): void
Parameters
Parameter | Type |
---|---|
id | string |
config | MenuConfig |
Returns
void
Defined in
packages/ui/src/services/menu/menu.service.ts:135 (opens in a new tab)
setMenuItem()
setMenuItem(item): void
Parameters
Parameter | Type |
---|---|
item | IMenuItem |
Returns
void
Implementation of
Defined in
packages/ui/src/services/menu/menu.service.ts:122 (opens in a new tab)