Hierarchy

  • Manager

Constructors

Properties

getters: ApiGetters
items: IRenderedItem[] = []
onUpdate: BruceEvent<IMenuItemUpdate> = ...
sharedGetters: Cache
sharedMonitor: Monitor
viewer: Viewer
visualsRegister: Register

Accessors

Methods

  • Disposes the menu item manager. This will dispose all render managers and unregister all menu items.

    Parameters

    • Optional params: {
          disposeRegister?: boolean;
      }
      • Optional disposeRegister?: boolean

    Returns void

  • Rerenders given entities. If no menu items are specified then the rerender is called on all enabled menu items. It is highly recommended to supply menu item ids.

    Parameters

    • params: {
          entities?: IEntity[];
          entityIds?: string[];
          force?: boolean;
          menuItemIds?: string[];
      }
      • Optional entities?: IEntity[]
      • Optional entityIds?: string[]
      • Optional force?: boolean
      • Optional menuItemIds?: string[]

    Returns Promise<void>

  • Disables a menu item by its id. This will disable all children as well.

    Parameters

    • params: {
          menuItemId: string;
          recursive?: boolean;
      }
      • menuItemId: string
      • Optional recursive?: boolean

    Returns void

  • Renders a given menu item and all its children. Will return the enabled item id.

    Parameters

    • params: {
          apiGetter?: IGetter;
          getters?: ApiGetters;
          item: IItem;
          recursive?: boolean;
      }
      • Optional apiGetter?: IGetter
      • Optional getters?: ApiGetters
      • item: IItem
      • Optional recursive?: boolean

    Returns string

Generated using TypeDoc