editor › Globals › MenuGenerator
Class: MenuGenerator
Based on the menu item definitions in each module and the module config, the menu generator builds up a hierarchical menu structure that can be fed into the angular floatingMenu ToDo: test
Hierarchy
- MenuGenerator
Index
Properties
Methods
- _createState
- _generateMenuItems
- _generateStates
- _traverseMenuItems
- generateMenuItem
- getMenuItems
- getStates
- init
Properties
Private menuItems
• menuItems: MenuItem[] = []
Defined in src/modularization/MenuGenerator.ts:25
Private states
• states: object
Defined in src/modularization/MenuGenerator.ts:24
Type declaration:
- [ key: string]: EnumState
Methods
Private _createState
▸ _createState(__namedParameters: object): EnumState
Defined in src/modularization/MenuGenerator.ts:87
Parameters:
▪ __namedParameters: object
| Name | Type |
|---|---|
defaultValue |
any |
possibleValues |
any |
stateRef |
any |
stateType |
any |
Returns: EnumState
Private _generateMenuItems
▸ _generateMenuItems(menuTree: any): Promise‹MenuItem‹›[]›
Defined in src/modularization/MenuGenerator.ts:75
Parameters:
| Name | Type |
|---|---|
menuTree |
any |
Returns: Promise‹MenuItem‹›[]›
Private _generateStates
▸ _generateStates(stateDefinitions: any): object
Defined in src/modularization/MenuGenerator.ts:80
Parameters:
| Name | Type |
|---|---|
stateDefinitions |
any |
Returns: object
- [ key: string]: EnumState
Private _traverseMenuItems
▸ _traverseMenuItems(menuItems: any[], callback: function): void
Defined in src/modularization/MenuGenerator.ts:116
Parameters:
▪ menuItems: any[]
▪ callback: function
▸ (menuItem: any): void
Parameters:
| Name | Type |
|---|---|
menuItem |
any |
Returns: void
generateMenuItem
▸ generateMenuItem(menuTree: any, parentItem?: MenuItem, automaticallyAddPossibleValue: boolean): Promise‹any›
Defined in src/modularization/MenuGenerator.ts:44
Generates a menu item based on the item specification and links it with existing items Does not support instantiating new states.
Parameters:
| Name | Type | Default |
|---|---|---|
menuTree |
any | - |
parentItem? |
MenuItem | - |
automaticallyAddPossibleValue |
boolean | true |
Returns: Promise‹any›
getMenuItems
▸ getMenuItems(): MenuItem[]
Defined in src/modularization/MenuGenerator.ts:32
Returns: MenuItem[]
getStates
▸ getStates(): MenuGenerator["states"]
Defined in src/modularization/MenuGenerator.ts:36
Returns: MenuGenerator["states"]
init
▸ init(menuTree: any, stateDefinitions: any): Promise‹void›
Defined in src/modularization/MenuGenerator.ts:27
Parameters:
| Name | Type |
|---|---|
menuTree |
any |
stateDefinitions |
any |
Returns: Promise‹void›