GlobalMenu Module

The GlobalMenu Module implements a submenu at the top of the I Want To menu.

Global menu in the I Want To menu

By default, the following menu items are included:

• Sign in / Sign out: Sign into or sign out of the viewer.

• Open: Open the Projects panel.

  The Projects panel lists the projects that this user is allowed to load. The user clicks a project in the list to load the project. This restores the viewer session that is saved in the project.

• Save: Save a project.

  If a project is currently loaded and the user has the necessary privileges, update the project with the current viewer session. Otherwise, create a new project using the name and description entered by the user.

• Save as: Create a new project using the name and description entered by the user.

For information about the project options (Open, Save, Save as), see Project Module. The Sign in and Sign out options perform the same functions as the Sign in and Sign out links in the viewer's banner. For more information, see User Module.

If you do not want the Global menu to show in the I Want To menu, you can turn it off using the IWantToMenu Module's showGlobalMenu property. For example, you might want to hide the Global menu if the viewer does not allow users to sign in. See IWantToMenu Module for information.

Configuration Properties

Module

• menus: An array of menus to display in the I Want To menu. By default there is one menu, the Global menu:

  • id: The menu's unique ID. The default menu's ID is GlobalMenuConfig.

  • defaultIconUri: The icon to use when a menu item's iconUri property is not configured.

  • items: An array of menu items. Menu items have the following properties:

    • iconUri: The image to display on the menu item. The recommended image size is 24px by 24px.

    • text: The text to display on the menu item. You can use a text key or the literal text.

      If your viewer is going to be available in more than one language, enter the text key that the description is assigned to. See Configure User Interface Text for more information on using text keys.

    • description: The tool tip to display when the user positions the pointer over the menu item.

    • command: The command to execute when the user clicks the menu item. For more information, see Viewer Commands and Events.

    • hideOnDisable: If this property is set to true and the menu item's command cannot run, the menu item does not show in the menu.

      If hideOnDisable is false and the menu item's command cannot run, the menu item shows in the menu, but it is grayed out.

      For example, the SignIn command cannot run when the user is already signed in, so the Sign in menu item is either hidden (if hideOnDisable is true) or grayed out (if hideOnDisable is false).

Views

• GlobalMenuView:

  • menuId: The ID of the menu to display in this view. The menu is defined in the module's menus property. The default is GlobalMenuConfig.

View Models

• GlobalMenuViewModel: No configuration properties