Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MenuModel

MenuModel provides a general purpose, loosely coupled model for defining menus that can be accessed by any module.

Hierarchy

  • MenuModel

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initializes a new instance of the MenuModel class.

    Parameters

    • app: ViewerApplication

      The {@link geocortex.essentialsHtmlViewer.ViewerApplication} that this menu belongs to.

    • entry: MenuEntryConfig

      A {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.menus.MenuEntryConfig} object to configure this menu.

    Returns MenuModel

Properties

app

app: ViewerApplication

The ViewerApplication that this menu model instance belongs to.

defaultIconUri

defaultIconUri: string

Default URI for an icon (if any), used if a menu item does not have one defined.

description

description: string

Description (if any) of this menu.

id

id: string

The unique id of this menu.

items

items: MenuItemModel[]

Array of menu items contained in this menu.

title

title: string

Title (if any) of this menu.

Methods

Protected _createMenuItems

  • Create menu items and populate the menu model based on the given configuration.

    Parameters

    • items: MenuItemConfig[]

      An array of {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.menus.MenuItemConfig} objects to configure the menu items.

    Returns MenuItemModel[]

    An array of {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.menus.MenuItemModel} objects created based on the provided configuration.