Regions

Regions are areas in an interface where views can be activated. Each view has a region property that controls which region the view is activated in. This is where the view is displayed.

For example, in the Desktop and Tablet interfaces, the Banner Module has a view called BannerView that displays the banner. BannerView's region property is set to HeaderRegion by default. This makes the banner display in the HeaderRegion.

Regions in the Desktop and Tablet Interfaces

The diagram below shows the main regions used in the Desktop and Tablet interfaces.

Main regions in the Desktop and Tablet interfaces

1. ApplicationRegion: Contains all the other regions. The ApplicationRegion is used by the Log Module and Shells Module.

2. HeaderRegion: Holds the banner.

3. ToolbarRegion: Holds the tabbed toolbar.

4. MapRegion: Holds the map. The following regions lie on top of the MapRegion. These regions are used by map widgets like the Basemap Switcher. You can also use these regions to display messages to the user, or anything else that you want to appear on top of the map.

   1. TopLeftMapRegion

   2. NavigationMapRegion

   3. TopCenterMapRegion

   4. BasemapMapRegion

   5. TopRightMapRegion

   6. MiddleRightMapRegion

   7. BottomRightMapRegion

   8. BottomCenterMapRegion

   9. BottomLeftMapRegion

   10. MiddleLeftMapRegion

5. RightPanelRegion

6. ResultsRegion: Holds the Results Table and other results-related views, like feature details. ResultsRegion is in the BottomPanelRegion (not shown in the diagram).

7. FooterRegion: Holds the application's footer. The FooterRegion has two regions on top of it—LeftFooterRegion and RightFooterRegion. The LeftFooterRegion's content is left justified. The RightFooterRegion's content is right justified.

8. LeftPanelRegion: Has a view-container view inside it that holds the DataRegion (9).

9. DataRegion: Hosts a number of container regions, listed below (10). The DataRegion is used by the Workflow Module.

   When a view is placed directly into the DataRegion, there is a tab for the view. This is useful for running workflows—you can display workflow content in one or more tabs so the user can navigate easily between the workflow, map layers, and other DataRegion tabs.

10. Container Regions: The following regions lie on top of the DataRegion. These container regions are where custom views are usually hosted.

    1. HomePanelContainerRegion: The default region for the Home Panel.

    2. LayerDataContainerRegion: The default region for the Layer List and other layer-related views.

    3. DataFrameResultsContainerRegion: The default region for the Results List and other results-related views, like Feature Details.

    4. FeatureEditingContainerRegion: Holds editing-related views.

    5. SimpleQueryBuilderContainerRegion: Holds the Simple Query Builder.

    6. SimpleFilterBuilderContainerRegion: Holds the Simple Filter Builder.

The BottomPanelRegion is not shown in the diagram. BottomPanelRegion hosts a container region that can display multiple side-by-side panes containing charts or third-party applications. BottomPanelRegion also contains the ResultsRegion.

The ModalWindowRegion is also not shown in the diagram. ModalWindowRegion is used to display content that the user must acknowledge before proceeding with the map session. For example, alerts and confirmation messages are often displayed in the ModalWindowRegion.

Regions in the Handheld Interface

The Handheld interface has the regions shown in the figure below, plus one more: ModalWindowRegion. The ModalWindowRegion is used to display content that the user must acknowledge before proceeding with the map session. For example, alerts and confirmation messages are often displayed in the ModalWindowRegion.

Regions in the Handheld interface

 

1. ApplicationRegion: Hosts the entire application

2. HeaderRegion: Hosts the I Want To menu button, Global Search box and Tools button

3. ScreenRegion: Hosts the map. Contains multiple subregions that correspond to different positions on the map

   1. TopLeftMapRegion

   2. NavigationMapRegion

   3. TopCenterMapRegion

   4. BasemapMapRegion

   5. TopRightMapRegion

   6. MiddleRightMapRegion

   7. BottomRightMapRegion

   8. BottomCenterMapRegion

   9. BottomLeftMapRegion

   10. MiddleLeftMapRegion

4. SmallNavigationRegion: Hosts the navigation bar that appears at the bottom of the screen when the user clicks at the bottom right corner of the screen

5. BottomPanelRegion: Hosts several view containers, each of which holds a region. These container regions are where custom views are most likely to be added, particularly the MiscViewContainerRegion. The regions are:

   1. LayerDataContainerRegion: Holds the layer list and other layer-related views

   2. ResultsViewContainerRegion: Holds the Results List, Feature Details, and other results-related views

   3. MiscViewContainerRegion: Holds various other views, such as the Home Panel

6. LeftPanelRegion: Hosts the I Want To menu

7. TopRightShellRegion: Hosts the compact toolbar

The Handheld, Tablet, and Desktop interfaces all display the map in the MapView. In the Handheld interface, the MapView uses the ScreenRegion—there is no dedicated MapRegion like there is in the Desktop and Tablet interfaces. When the MapView is active in the ScreenRegion, you can use all the same regions that lie on top of the MapRegion in the Desktop and Tablet interfaces. You can use these regions to display map widgets, messages to the user, or anything else that you want to appear on top of the map.