Skip Headers
Oracle® Fusion Middleware Web User Interface Developer's Guide for Oracle Application Development Framework
11g Release 2 (11.1.2.0.0)

Part Number E16181-01
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

25 Using Map Components

This chapter describes how to display data in geographic and thematic maps using ADF Faces data visualization map and thematicMap components. If your application uses the Fusion technology stack, then you can use data controls to create geographic map themes and thematic map area and point data layers to display data. For more information, see the "Creating Databound ADF Data Visualization Components" chapter in the Oracle Fusion Middleware Fusion Developer's Guide for Oracle Application Development Framework.

This chapter includes the following sections:

25.1 About Map Components

A geographic map represents business data in one or more interactive layers of information (known as themes), superimposed on a single map. Geographic maps require a configuration that contains a URL to a remote Oracle Application Server (AS) MapViewer service, and optionally, a geocoder service if address data will have to be converted to longitude and latitude.

A thematic map represents business data as patterns in stylized areas or associated markers and does not require a connection to an Oracle MapViewer service. Thematic maps focus on data without the geographic details in a geographic map.

25.1.1 End User and Presentation Features of Maps

The ADF Data Visualization map and thematic map components provides a range of features for end users, such as panning and zooming and legend display. It also provides a range of presentation features, such as state management.

25.1.1.1 Geographic Map End User and Presentation Features

To understand how geographic maps are used and can be customized, it may be helpful to review these elements and features:

  • Viewport: The container for the geographic map and its presentation features. The default size is 600px by 375px and is customizable.

  • Base map: The background geographic data, zoom levels, and the appearance and presence of items such as countries, cities, and roads. By default, geographic maps use based maps from the remote Oracle MapViewer service. The base map can be any image that can be configured using a map viewer and map builder, for example, the floor maps of office buildings.

  • Zoom control: Pan icons and a zoom slider that render in the upper left-hand corner of the map. Figure 25-1 shows a map zoom control that is zoomed out all the way (that is, the zoom level is set to 0). At zero, the entire map is displayed.

    You can customize the location and the initial setting of the zoom control in the map component. The View menu in the map toolbar lets you determine the visibility of the zoom control. By default, the initial zoom level for a map is set to 0.

    Figure 25-1 Zoom Control of a Map

    Zoom control of a map
    • Pan icons: Icons (with arrows that point north, south, east, west, northeast, northwest, southeast, and southwest) at the top of the zoom control. You can use these icons to move the entire map in specific directions.

    • Zoom slider: Slider with a thumb for large scale zooming and icons for zooming a single level. You can use the plus icon to zoom in and the minus icon to zoom out one level at a time. When the thumb is at the bottom of the slider, the zoom level is zero.

  • Scale: Two horizontal bars that display in the lower left-hand corner of the map below the information panel and above the copyright. Figure 25-2 shows the scale. The top bar represents miles (mi) and the bottom bar represents kilometers (km). Labels appear above the miles bar and below the kilometers bar in the format: [distance] [unit of measure]. The length and distance values of the bars change as the zoom level changes and as the map is panned.

    Figure 25-2 Map Information Panel, Scale, and Copyright

    Map Information panel, scale, and Copyright
  • Information panel: Displays latitude and longitude in the lower left-hand corner above the scale. Figure 25-2 shows the information panel. By default, the information panel is not visible. You can display this panel from the View menu or by clicking the Information button on the toolbar.

  • Measurement panel: Displays either distance, area, or radius depending on which tools in the toolbar are currently in use. Text appears in the following format: [label] [value] [unit of measure] to the right of the information panel. Figure 25-3 shows the measurement panel with a distance measurement. Area measurement and radius measurement appear in a similar manner with the appropriate labels.

    Figure 25-3 Map Measurement Panel Beside the Information Panel

    Map measurement panel beside the information panel

    The following tools provide information in the measurement panel:

    • Area measurement: Appears only when the Area, Rectangular Selection, or Multi-Point Selection tools are active.

    • Distance measurement: Appears only when the Distance tool is active.

    • Radius measurement: Appears only when the Circular Selection tool is active.

  • Copyright: Appears in the lower left-hand corner of the map and contains text that you can customize in the map component.

  • Overview map: Consists of a miniature view of the main map as shown in Figure 25-4. This map appears in the lower right-hand corner of the main map and lets you change the viewable region of the main map without having to use the pan tool or the pan icons.

    Figure 25-4 Overview Map

    Overview map

    The following items are part of the overview map:

    • Reticule: Appears in a small window that you can move across a miniature view of the main map. The position of the reticule in the miniature map determines the viewable area of the main map. As you move the reticule, the main map is updated automatically.

    • Show/Hide icon: Appears in the upper left-hand corner when the overview map is displayed. When you click the Show/Hide icon, the overview map becomes invisible and only the icon can be seen in the lower right corner of the main map.

  • Toolbar: Appears in association with the map to provide user controls to adjust the display of the map and map themes.

    The toolbar contains the following elements in the sequence listed:

    • View menu: Lets the user control which themes are visible, select a specific theme for display, and determine the visibility of the zoom control, information panel, and the legend. Figure 25-5 show a sample View menu.

      Figure 25-5 Map View Menu

      Map View Menu

      The Themes option on the View menu provides a dialog to configure a geographic map when multiple themes are available. Figure 25-6 shows a sample map themes dialog.

      Figure 25-6 Map Themes Dialog

      Map themes dialog.
    • Toolbar buttons: Provides user controls to interact with the geographic map including:

      • Pan: Use to pan the map by drag and drop operation within the view

      • Zoom: Use to zoom in or out in the map view

      • Selection: Use to select shaped (rectangle, circle, or polygon) areas or points on the map. The themes within the selection will be highlighted

      • Measurement: Use to hide or show the map distance and area measurements tools

      • Legend: Use to hide or show the map legend

      • Information panel: Use to hide or show the map information panel

      Figure 25-7 shows the features supported by the map toolbar buttons

      Figure 25-7 Map Toolbar Button Features

      Map toolbar button functions.

25.1.1.2 Thematic Map End User and Presentation Features

To understand how thematic maps are used and can be customized, it may be helpful to review these elements and features:

  • Viewport: The container for the thematic map and its presentation features. The default size is 600px by 375px and is customizable.

  • Base map: The background geographic area. Each base map includes several sets of regions and one fixed set of cities referred to as points. A set of regions or cities is referred to as an layer. Only one base map and one layer may be displayed at a time, with the exception of enabled drilling. The base maps prebuilt for the thematic map include:

    • United States

    • United States and Canada

    • World

    • Africa

    • Asia

    • Europe

    • North America

    • Latin America

    • South America

    • APAC (Asia Pacific)

    • EMEA (Europe, Middle East, and Africa

    • World Regions

  • Layers and labels: Each base map includes several regions that represent levels in a geographical hierarchy. For example, in the United States map the hierarchy is country > states > counties > cities. The hierarchical relationship supports drilling in the region. When displayed, the cities in the city layer associated with the base map will appear as data points. By default, each region in a layer displays a label that can be customized.

    Thematic maps support one or more custom area layers, a named group of regions based on either an existing area layer or another custom region. A custom region fits naturally into the geographical hierarchy of the base map. For example, a custom area layer based on the Counties layer would appear between the US States and US Counties layers in the hierarchy.

  • Data layers: Each layer can be bound to a data collection and sylized to represent the data with color and pattern fills, or a data marker, or both. A map layer may display only one data layer at a time, whereas multiple data markers may appear at the same time. Data layers can be defined by geographic area, or by points associated with a map position as in longitude and latitude, or x and y coordinates.

  • Data markers and labels: Data markers are bound to a data collection and can be associated with a region or city layer to represent data as shapes available with the thematicMap component, custom shapes, or graphic files. A data marker can also be associated with a map position as in longitude and latitude, or x and y coordinates. By default, each data marker displays a label.

  • Control panel: Optional tool that allows user to control the following operations:

    • Pan and zoom control: Use to pan the map, and zoom and center the map within the view

    • Zoom to fit: Use to center and fit the full view of the map within the viewport

    • Zoom buttons: Use to zoom in or out on the view of the thematic map

    • Show/hide control panel button: Use to show or hide the control panel

    • Reset button: Available when drilling is enabled for the thematic map. Use to reset map to display with no drilling in regions.

    • Drill buttons: Available when drilling is enabled for the thematic map. Use arrows pointing up or down to drill up or down in a map region.

    Figure 25-8 shows the control panel with drilling enabled in the map.

    Figure 25-8 Control Panel with Drilling Enabled

    Control panel with drilling enabled.
  • Context menus: By default, thematic maps display context menus for the viewport background, map regions, and data markers. Custom context menu items can be added to the default menus.

    Figure 25-9 shows the default context menu for the map viewport. The same menu items are available for data markers.

    Figure 25-9 Map Viewport Background Context Menu

    Map viewport context menu.

    Figure 25-10 shows the context menu for a map region.

    Figure 25-10 Map Region Context Menu

    Map region context menu.
  • State management: By default, display changes made to a thematic map such as center, zoom, selection, and drill state persist across sessions, and carry over to printing.

  • Image formats: By default, thematic maps are displayed using a Flash player and a Portable Network Graphics (PNG) output format is used when printing thematic maps. Both Flash and PNG image formats support bi-directional locales. Static rendering, such as maintaining pan and zoom state of the Flash display, is fully supported in the printable PNG image.

  • Printing: Thematic maps are printed using a PNG output format, maintaining any zoom or pan state in the map.

  • Animation: By default, thematic maps are animated upon initial rendering of the map, when the data associated with the map changes, and when a region is drilled in the map.

  • Drilling: When enabled, drilling of the next layer in the geographical hierarchy is displayed. For example, the counties within a US state are displayed when the user double-clicks a state region. Drilling icons are added to the Control Panel when drilling is enabled.

  • Drag and drop: Maps can be configured to support these operations:

    • Drag selected map regions or data markers to another page component.

    • Move data markers from one location to another on the map.

    • Drag data elements from another page component to a map region or data marker.

  • Disable features: End user features including map zoom, zoom-to-fit, and pan can be disabled for a thematic map. When disabled, the controls are removed from the control panel.

  • Tooltips: By default, thematic maps use tooltips to orient the user to the map location and associated data when moving the cursor over the map.

25.1.2 Map Component Use Cases and Examples

Both geographic and thematic maps are designed to display data. The difference is that geographic maps focus on data that is best displayed with details such as roads or rivers. and requires configuration to an Oracle MapViewer service and optionally, a geocoder service. Thematic maps focus on data trends or patterns without the visual clutter of geographic details and do not require configuration to an Oracle MapViewer or geocoder service.

Geographic maps support a variety of map themes, each of which must be bound to a data collection. The following kinds of map themes are available:

  • Color: Applies to regions. For example, a color theme might identify a range of colors to represent the population in the states of a region or the popularity of a product in the states of a region. A geographic map can have multiple color themes visible at different zoom levels. For example, a color theme at zoom levels 1 to 5 might represent the population of a state, and the county median income at zoom levels 6 to 10.

  • Point: Displays individual latitude/longitude locations in a map. For example, a point theme might identify the locations of warehouses in a map. If you customize the style of the point that is displayed, you might choose to use a different image for the type of inventory (electronics, housewares, garden supplies) in a set of warehouses to differentiate them from each other.

  • Graph: Creates any number of pie graph themes and bar graph themes. However, only one graph theme can be visible at a given time. You select the desired theme from the View menu of the map toolbar. Graph themes can show statistics related to a given region such as states or counties. For example, a graph theme could display the sales values for a number of products in a state.

Figure 25-11 displays a geographic map with color, point, and graph themes.

Figure 25-11 Geographic Map of Southwest US with Color, Point, and Pie Graph Themes

Map with color, point, and pie graph themes

Figure 25-12 shows a geographic map with a customized bar graph theme.

Figure 25-12 Geographic Map with Custom Bar Graph Theme

Geographic map with custom bar graph theme

Thematic maps display trends or patterns in data associated with a geographic location. Data is stylized by region, for example, using a fill color based on data values, associating a marker with the region, or both.

Figure 25-13 shows a thematic map that displays unemployment rates by states in the US. The map displays multiple selection of the states with an employment rate of 2.0-4.0 percent.

Figure 25-13 Thematic Map of Unemployment Rates in the US

Thematic map of unemployment rates in the US

Figure 25-14 shows a thematic map that displays a graduated symbol for the size of the major cities in South America.

Figure 25-14 Thematic Map with City by Size in South American

Thematic Map with City by Size in South American

25.1.3 Additional Functionality for Map Components

You may find it helpful to understand other ADF Faces features before you implement your map component. Additionally, once you have added a map component to your page, you may find that you need to add functionality such as validation and accessibility. Following are links to other functionality that map components can use:

  • Partial page rendering: You may want a map to refresh to show new data based on an action taken on another component on the page. For more information, see Chapter 8, "Rerendering Partial Page Content."

  • Personalization: When enabled, users can change the way the map displays at runtime, and those values will not be retained once the user leaves the page unless you configure your application to allow user customization. For information, see Chapter 32, "Allowing User Customization on JSF Pages."

  • Accessibility: You can make your map components accessible. For more information, see Chapter 30, "Developing Accessible ADF Faces Pages."

  • Skins and styles: You can customize the appearance of gauge components using an ADF skin that you apply to the application or by applying CSS style properties directly using a style-related property (styleClass or inlineStyle). For more information, see Chapter 28, "Customizing the Appearance Using Styles and Skins."

  • Content Delivery: You can configure your thematic map area and point data layers to fetch a certain number of rows from your data source using the contentDelivery attribute. For more information, see Section 12.2.2, "Content Delivery."

  • Automatic data binding: If your application uses the Fusion technology stack, then you can create automatically bound gauges based on how your ADF Business components are configured. For more information, see the "Creating Databound Gauges" chapter of the Oracle Fusion Middleware Web User Interface Developer's Guide for Oracle Application Development Framework.

    Note:

    If you know the UI components on your page will eventually use ADF data binding, but you need to develop the pages before the data controls are ready, then you should consider using placeholder data controls, rather than manually binding the components. Using placeholder data controls will provide the same declarative development experience as using developed data controls. For more information, see the "Designing a Page Using Placeholder Data Controls" chapter of the Oracle Fusion Middleware Fusion Developer's Guide for Oracle Application Development Framework.

Additionally, data visualization components share much of the same functionality, such as how data is delivered, automatic partial page rendering (PPR), image formats, and how data can be displayed and edited. For more information, see Section 21.2, "Common Functionality in Data Visualization Components."

25.2 Using the Geographic Map Component

When you create a map, you are prompted to select a base map that an administrator has already configured using the Map Builder tool of Oracle Spatial. During configuration, the map administrator defines the zoom levels that the map supports. These levels also determine the zoom capability of the geographic map.

Administrators also have the option of creating predefined map themes using the Map Builder tool. For example, a predefined theme might use specific colors to identify regions. In the geographic map component, you can select such a predefined map theme, but you cannot modify it because this theme is part of the base map.

The base map becomes the background on which you build interactive themes of information using the geographic map component. You can create as many themes as you wish, but you must define at least one map theme.

Geographic maps have the following data requirements:

25.2.1 Configuring Geographic Map Components

The geometric map has parent components, map child components, and components that modify map themes. The prefix dvt: occurs at the beginning of each map component name indicating that the component belongs to the ADF Data Visualization Tools (DVT) tag library. You can configure the following map components:

  • Map (map): The main map component. Unlike other data visualization components, the map component is not bound to data. Instead, all the map theme child components are bound individually to data collections. The map component contains general information about the map including the identification of the base map, the URL for the remote server that is running Oracle Application Server MapViewer service and the URL for the Geocoder web service that converts street addresses into longitude and latitude coordinates for mapping.

    The map component supports the following map child components:

    • Color theme (mapColorTheme): Map layer that you bind to a data collection. The color theme can be used to identify regions on a base map.

    • Point theme (mapPointTheme): Map layer that you bind to a data collection. The point theme identifies individual locations on a map.

      Optionally, you can use child map point style components (mapPointStyleItem) if you want to customize the image that represents points that fall in a certain data value range. To define multiple images, create a component for each image and specify the associated data value range and image.

    • Bar graph theme (mapBarGraphTheme): Map layer that you bind to a data collection. This theme displays a bar graph at points to represent multiple data values related to that location. For example, this tag might be used to display a graph that shows inventory levels at warehouse locations.

      Optionally, use the map bar graph series set component (mapBarSeriesSet) to wrap map bar graph series components (mapBarSeriesItem) if you want to customize the color of the bars in a map bar graph. Each map bar graph component customizes the color of one bar in a map bar graph.

    • Pie graph theme (mapPieGraphTheme): Map layer that you bind to a data collection. This theme displays a pie graph at specific points to represent multiple values at that location. For example, this tag might be used to display a graph that shows inventory levels at warehouse locations.

      Optionally, use the map pie slice set component (mapPieSliceSet) to wrap map pie slice components (mapPieSliceItem) if you want to customize the color of the slices in a map pie graph. Each map pie slice component customizes the color of one slice in a map pie graph.

    • Predefined graph theme (predefinedTheme): Map layer defined using the Map adminstrator tool stored along with the map metadata in the database. The predefined theme tag is used when you have your own custom Oracle AS MapViewer instance and need to display large datasets that can be rendered directly by the map viewer.

    • Map legend (mapLegend): Created automatically when you create a map. Use this component to customize the map legend.

    • Overview map (mapOverview): Created automatically when you create a map. Use this tag to customize the overview map that appears in the lower right-hand corner of the map.

  • Toolbar (mapToolbar): A parent component that allows the map toolbar to be placed in any location on a JSF page that contains a map. This toolbar contains a mapID attribute that points to the map associated with the toolbar. The toolbar lets you perform significant interaction with the map at runtime including the ability to display the map legend and to perform selection and distance measurement. The map toolbar tag has no child components.

25.2.2 How to Add a Geographic Map to a Page

When you are designing your page using simple UI-first development, you use the Component Palette to add a geographic map to a JSF page. When you drag and drop a geographic map component onto the page, you are prompted to configure the an Oracle MapViewer service, and optionally a geocoder service.

Once you complete the configuration, and the geographic map is added to your page, you can use the Property Inspector to configure additional display attributes for the map.

In the Property Inspector you can use the dropdown menu for each attribute field to display a property description and options such as displaying an EL Expression Builder or other specialized dialogs. shows the dropdown menu for a thematic map component mapServerConfigId attribute.

Figure 25-15 Geographic Map MapServerConfigId Attribute Dropdown Menu

Geographic map MapServerConfigId attribute property

Note:

If your application uses the Fusion technology stack, then you can use data controls to create a geographic map and the binding will be done for you. For more information, see the "Creating Databound Geographic Maps" section in the Oracle Fusion Middleware Fusion Developer's Guide for Oracle Application Development Framework

Before you begin:

It may be helpful to have an understanding of how geographic map attributes and geographic map child components can affect functionality. For more information, see Section 25.2.1, "Configuring Geographic Map Components."

You may also find it helpful to understand functionality that can be added using other ADF Faces features. For more information, see Section 25.1.3, "Additional Functionality for Map Components."

To add a geographic map to a page:

  1. In the Component Palette, from the ADF Data Visualizations page, in the Map panel, drag and drop a Geographic map onto the page to open the Create Geographic Map dialog. Use the dialog Maps page to specify Map Configuration in one of two ways:

    • Use the dropdown list to choose an available configuration, or

    • Click the Add icon to open the Create Geographic Map Configuration dialog.

      In the dialog you can specify the MapViewer URL and Geocoder URL from the respective dropdown list, or click the Add icon to open the Create URL Connection dialog for each URL.

      Note:

      For the Oracle AS MapViewer service use this URL: http://elocation.oracle.com/mapviewer

      For the Oracle AS Geocoder service use this URL: http://elocation.oracle.com/geocoder/gcserver

    If you need help with any of the dialogs, press F1 or click Help. As you complete each dialog to create the configuration, the settings are reflected in the Create Geographic Map dialog. Figure 25-16 shows a sample completed dialog.

    Figure 25-16 Maps Page of the Create Geographic Map Dialog

    Maps page of the Create Geographic Map dialog
  2. Optionally, use the map Preview control panel to make adjustments to the center and zoom level of the base map. When you click Refresh, the Starting X (X coordinate of the center), Starting Y (Y coordinate of the center), and Zoom Level (initial zoom level) values are updated. If you need help, press F1 or click Help.

    Note:

    Optionally, use the Themes page of the Create Geographic Map dialog to add and configure color, point, bar graph, or pie graph themes to display data on the map.

    When you create a geographic map using the Data Controls panel and the theme binding dialogs, the data bindings are created for you. For more information, see the "Creating Databound Geographic Maps" section in the Oracle Fusion Middleware Fusion Developer's Guide for Oracle Application Development Framework.

  3. In the Property Inspector, view the attributes for the geographic map. Use the help button to display the complete tag documentation for the map component.

  4. Expand the Appearance section. Use this section to set the following attributes:

    • ShowScaleBar: Use to specify the display of the map scale bar. The default value is false.

    • ZoomBarPosition: Use to specify the location of the map zoom bar. The default value is West for placement on the left side of the map. Other valid values include East for placement on the right side of the map, and none for no zoom bar display.

    • AutoZoomThemeId: Use to specify the id of the theme where the map view and zoom level will be centered upon initial map display. The value set in the AutoZoomStrategy will be used to determine how the map adjusts the center and zoom level.

    • ShowInfoArea: Use to specify the display of the information area. The default value is true.

    • MapZoom: Use to specify the initial zoom level of the geographic map. The zoom levels are defined in the map cache instance as part of the base map.

    • Unit: Use to specify the unit of measurement to use for the geographic map. The default value is miles. The attribute can also be set to meters.

    • Selection subsection: Use the attributes in this subsection to define the appearance of the area (rectangular, circular, polygon) and point selection tools. For more information, see Section 25.3.3, "How to Customize and Use Map Selections."

  5. Expand the Other section. Use this section to set the following attributes:

    • AutoZoomStrategy: Use to specify how the map adjusts the center and zoom level. If the AutoZoomStrategy value is set to MAXZOOM (default), the map will zoom to the maximum level where all objects in AutoZoomThemeId are visible. If the AutoZoomStrategy is set to CENTERATZOOMLEVEL, the map will center on the theme in AutoZoomThemeId, and will use the value in the MapZoom attribute as the starting zoom level.

    • Summary: Enter a description of the geographic map. This description is accessed by screen reader users.

25.2.3 What Happens When You Add a Geographic Map to a Page

When you use a Component Palette to add a geographic map to a page, JDeveloper adds code to the JSF page. Example 25-1 shows the code added to the JSF page.

Example 25-1 Geographic Map Added to JSF Page

<dvt:map startingY="46.06" startingX="-78.67" mapZoom="1"
                         mapServerConfigId="mapConfig2"
                         baseMapName="ELOCATION_MERCATOR.WORLD_MAP"
                         inlineStyle="width:600px; height:375px;" id="m2">
  <f:facet name="rtPopup"/>
  <f:facet name="popup"/>
</dvt:map>

Note:

JDeveloper automatically inserts two popup facets. The rtPopup facet supports a single child component for a right click af:menu. The popup facet supports a single child component for a left click af:dialog or af:noteWindow. For more information about configuring popup components, see Chapter 15, "Using Popup Dialogs, Menus, and Windows."

You can then configure the geographic map to display data in color, point, pie graph or bar graph themes using the ADF Data Controls panel and the theme binding dialogs. For information about configuring geographic maps to display data, see the "Creating Databound Geographic Maps" section in the Oracle Fusion Middleware Fusion Developer's Guide for Oracle Application Development Framework.

25.3 Customizing Geographic Map Display Attributes

You can customize geographic display attributes including the size of the map, how the map centers and zoom the map size, zoom strategy, the appearance of selected regions, and the display of the map legend.

25.3.1 How to Adjust the Map Size

You can control the width and height of the map by using the inlineStyle attribute in the dvt:map tag.

Before you begin:

It may be helpful to have an understanding of how map attributes and map child tags can affect functionality. For more information, see Section 25.2.1, "Configuring Geographic Map Components."

You should already have a map on your page. If you do not, follow the instructions in this chapter to create a map. For information, see Section 25.2.2, "How to Add a Geographic Map to a Page."

To adjust the size of a map:

  1. In the Structure window, right-click the dvt:map component and choose Go to Properties.

  2. In Property Inspector, expand the Style section. Specify the initial size of the map in the InlineStyle attribute.

    For example, to specify a width of 600 pixels and a height of 400 pixels, use the following setting:

    width:600px;height:400px
    

    For a map that uses half the available width and height of the page, use the following setting:

    width:50%;height:50%
    

    Best Practice Tip:

    Instead of specifying width at 100% in the inlineStyle attribute, set the styleClass attribute to AFStretchWidth.

25.3.2 How to Specify Strategy for Map Zoom Control

You can customize how the geographic map display attributes for the initial zoom level, starting location, initial map theme, and zoom strategy.

Before you begin:

It may be helpful to have an understanding of how map attributes and map child tags can affect functionality. For more information, see Section 25.2.1, "Configuring Geographic Map Components."

You should already have a map on your page. If you do not, follow the instructions in this chapter to create a map. For information, see Section 25.2.2, "How to Add a Geographic Map to a Page."

You should have already configured at least one map color, point, pie graph, or bar graph theme to display data on the map.

To control the initial zoom and starting location on a map:

  1. In the Structure window, right-click the dvt:map component and choose Go to Properties.

  2. In the Property Inspector, expand the Appearance section. Use this section to set the following attributes:

    • AutoZoomThemeID: Enter the Id of the first theme that will be displayed.

    • ZoomBarStrategy: Select the default value MAXZOOM to direct the map to zoom down to the maximum level where all objects in the AutoZoomThemeId are visible, or select CENTERATZOOMLEVEL to direct the map to center on the theme in AutoZoomThemeId and to set the zoom level to the value in the MapZoom attribute.

    • If you want to change the starting location on the map, enter latitude and longitude in StartingX and StartingY respectively.

    • MapZoom: Enter the beginning zoom level for the map. This setting is required for the zoom bar strategy CENTERATZOOMLEVEL.

      Note:

      The property autoZoomThemeID takes precedence over the property set in mapZoom.

25.3.3 How to Customize and Use Map Selections

The geographic map provides selection tools for map areas displaying data in color, pie graph, and bar graph themes. By default, the selection tools are available on the map toolbar and include options for rectangular, circular, polygonal, or point selection. Figure 25-17 show the use of the polygon tool to select an area in a map with a color theme.

Figure 25-17 Polygon Selection Tool in Map

Polygon selection tool in map

You can customize the attributes used by the selection tools when users make selection on a colorTheme, barGraphTheme, and pieGraphTheme, using the rectangle tool, circle tool, polygon tool or point tool on the mapToolbar.

Before you begin:

It may be helpful to have an understanding of how map attributes and map child tags can affect functionality. For more information, see Section 25.2.1, "Configuring Geographic Map Components."

You should already have a map on your page. If you do not, follow the instructions in this chapter to create a map. For information, see Section 25.2.2, "How to Add a Geographic Map to a Page."

You should have already configured at least one map color, point, pie graph, or bar graph theme to display data on the map.

To customize map selection tool attributes:

  1. In the Structure window, right-click the dvt:map component and choose Go to Properties.

  2. In the Property Inspector, expand the Appearance section. Use this section to set the following attributes:

    • SelectionFillColor: Use to specify the fill color for the selected region. Valid values are RGB hexadecimal. For example, color="#000000" for black. The default value is #49E0F6.

    • SelectionStrokeColor: Use to specify the stroke color for the selected region. Valid values are RGB hexadecimal. For example, color="#000000" for black, the default color.

    • SelectionOpacity: Use to specify the opacity of the fill color for the selected region. Valid values range from 0 to 100, where 0 is 100% transparent, and 100 is opaque. The default value is 40.

When an end user clicks on a selection tool and uses the tool to highlight an area on the map, the data values in that area can be displayed in another UI element such as a table, or totalled in the information panel, by using a selection listener.

Figure 25-18 shows a map with the states selected in the area outlined in the color red. The related information about the area is displayed in an associated table.

Figure 25-18 Selected Map Area with Table Data Display

Selected map area with table data display

You can provide a selection listener that totals the values associated with a map area selected with one of the map selection tools such as the rectangular selection tool. The total is displayed in an area under the map. You must provide a class that takes MapSelectionEvent as an argument in a backing bean method. Example 25-2 shows sample code for a backing bean.

Example 25-2 Sample Code in Backing Bean for Selection Listener

package view;
import java.util.Iterator;
import oracle.adf.view.faces.bi.component.geoMap.DataContent;
import oracle.adf.view.faces.bi.event.MapSelectionEvent;
public class SelectionListener {
    private double m_total = 0.0;
    public SelectionListener() {
    }
    public void processSelection(MapSelectionEvent mapSelectionEvent) {
        // Add event code here...
        m_total = 0.0;
        Iterator selIterator = mapSelectionEvent.getIterator();
        while (selIterator.hasNext())
        {
            DataContent dataContent = (DataContent) selIterator.next();
            if (dataContent.getValues() != null)
            {
                Double allData[] = dataContent.getValues();
                m_total += allData[0];    
            }
        }
    }
    public double getTotal () {
        return m_total;
    }
    public void setTotal (double total) {
        m_total = total;
    }
}

To provide a selection listener to total map selection values:

  1. In the Structure window, right-click the dvt:map component and choose Go to Properties.

  2. In the Property Inspector, expand the Behavior section. For the SelectionListener attribute, enter a method reference that points to the backing bean. For example:

    #{eventBean.processSelection}
    

25.3.4 How to Customize the Map Legend

The map legend provides an explanation of the map theme data in symbol and label pairs. The legend displays by default in a popup upon initial display of the map, and when a map toolbar is added and configured, the map legend can display in a window when the user clicks the legend toolbar button. When multiple themes are configured, a dropdown list is available to display the legend for each theme. Figure 25-19 shows a map displaying the legend for one of its multiple themes.

Figure 25-19 Thematic Map Legend Display

Thematic Map Legend Display

Note:

In order for the legend toolbar button to be available, you must add and configure a toolbar to the map. For more information, see Section 25.5, "Adding a Toolbar to a Geographic Map."

Before you begin:

It may be helpful to have an understanding of how map attributes and map child tags can affect functionality. For more information, see Section 25.2.1, "Configuring Geographic Map Components."

You should already have a map on your page. If you do not, follow the instructions in this chapter to create a map. For information, see Section 25.2.2, "How to Add a Geographic Map to a Page."

You should have already configured at least one map color, point, pie graph, or bar graph theme to display data on the map.

To customize a map legend:

  1. In the Structure window, right-click the dvt:map component and choose Insert inside dvt:map > Legend.

  2. In the Property Inspector, expand the Common section. In this section set the following attributes:

    • InitialShown: Use to specify whether or not the map legend is displayed in a popup upon initial display of the map. The default value is true.

    • Width: Enter the width of the legend. The default value is 200px.

    • Height: Enter the height of the legend. The default value is 150px.

    • PointThemeLabel: Enter the label to use for the map point theme in the legend. All point themes are shown as one option in the dropdown list. The default value is Point Theme.

    • NumberOfColumns: Enter the number of columns to use for displaying the colors of a color map theme in the legend.

      For example, if a color theme has 15 colors, and the value of the attribute is set to 3, then the legend will show 5 rows on the legend for the theme, where each row has 3 columns.

25.4 Customizing Geographic Map Themes

Each of the geographic map themes, color, point, pie graph, and bar graph, can be customized using one or more of the following: the map theme binding dialogs, the attributes of the theme tag, or the child tags of the theme tag.

25.4.1 How to Customize Zoom Levels for a Theme

For all map themes, you must verify that the theme specifies zoom levels that match the related zoom levels in the base map. For example, if the base map shows counties only at zoom levels 6 through 8, then a theme that displays points or graphs by county should be applied only at zoom levels 6 through 8.

Before you begin:

It may be helpful to have an understanding of how map attributes and map child tags can affect functionality. For more information, see Section 25.2.1, "Configuring Geographic Map Components."

You should already have a map on your page. If you do not, follow the instructions in this chapter to create a map. For information, see Section 25.2.2, "How to Add a Geographic Map to a Page."

You should have already configured at least one map color, point, pie graph, or bar graph theme to display data on the map.

To customize the zoom levels of a map theme:

  1. In the Structure window, right-click the dvt:mapColorTheme, dvt:mapPointTheme, dvt:mapBarGraphTheme, or dvt:mapPieGraphTheme component that you want to customize, and select Go to Properties.

  2. In the Property Inspector, expand the Appearance section. For the MinZoom and MaxZoom attribute, enter the desired low and high zoom values, respectively.

25.4.2 How to Customize the Labels of a Map Theme

By default, the Id attribute of a map theme is used as the label when that theme is displayed in the legend or in the View menu, Theme Selection dialog. You can customize map theme labels using shortLabel and menuLabel attributes to create meaningful labels that identify both the theme type (color, point, bar graph, or pie graph) and the data (such as population, sales, or inventory) so that users can easily recognize the available themes.

Use these attributes to create meaningful labels that identify both the theme type (color, point, bar graph, or pie graph) and the data (such as population, sales, or inventory) so that users can easily recognize the available themes.

Before you begin:

It may be helpful to have an understanding of how map attributes and map child tags can affect functionality. For more information, see Section 25.2.1, "Configuring Geographic Map Components."

You should already have a map on your page. If you do not, follow the instructions in this chapter to create a map. For information, see Section 25.2.2, "How to Add a Geographic Map to a Page."

You should have already configured at least one map color, point, pie graph, or bar graph theme to display data on the map.

To customize the labels of a map theme:

  1. In the Structure window, right-click the dvt:mapColorTheme, dvt:mapPointTheme, dvt:mapBarGraphTheme, or dvt:mapPieGraphTheme component that you want to customize, and select Go to Properties.

  2. In the Property Inspector expand the Appearance section. Use this section to set the following attributes:

    • ShortLabel: Use to specify a label for the theme when displayed in the map legend.

    • MenuLabel: Use to specify a label for the theme in the View menu, Theme Selection dialog.

    For example, you might want to enter the following text for a color theme that colors New England states according to population:

    shortLabel="Color - Population, NE Region"
    

25.4.3 How to Customize Color Map Themes

When you create a color map theme, you can customize the colors used for the coloring of the background layer. You can specify the colors associated with the minimum and maximum ranges, and then specify the number of color ranges for the theme. For example, if the colors relate to the population on the map, the least populated areas display the minimum color and the most populated areas display the maximum color. Graduated colors between the minimum and maximum color are displayed for ranges between these values.

Before you begin:

It may be helpful to have an understanding of how map attributes and map child tags can affect functionality. For more information, see Section 25.2.1, "Configuring Geographic Map Components."

You should already have a map on your page. If you do not, follow the instructions in this chapter to create a map. For information, see Section 25.2.2, "How to Add a Geographic Map to a Page."

You should have already configured a map color theme to display data on the map.

To customize the colors of a color map theme:

  1. In the Structure window, right-click the dvt:mapColorTheme component and choose Go to Properties.

  2. In the Property Inspector, expand the Theme Data section. Use this section to set the following attributes:

    • If you want to change the default colors associated with the minimum and maximum range of data values, then select the desired colors for the MinColor and MaxColor attributes respectively.

    • If you want to change the default number of color ranges for this theme, change the integer in the BucketCount attribute.

    For example, if <dvt:mapColorTheme minColor="#000000" maxColor= "#ffffff" bucketCount="5"/>, then the colors for the five buckets are: #000000, #444444, #888888, #bbbbbb, #ffffff.

Alternatively, you can specify the color for each bucket. To specify colors for multiple buckets, for the ColorList attribute of mapColorTheme, bind a color array to the attribute or use a semicolon-separated string. Color can be specified using RGB hexadecimal.

For example, if the value is colorList="#ff0000;#00ff00;#0000ff", then the value of the first bucket is red, the second bucket is green, and the third bucket is blue.

25.4.4 How to Customize Point Images in a Point Theme

A map point theme uses a default image to identify each point. However, you can specify multiple custom images for a point theme and identify the range of data values that each image should represent, using a mapPointStyleItem component for each custom image you want to use in a map point theme.

Before you begin:

It may be helpful to have an understanding of how map attributes and map child tags can affect functionality. For more information, see Section 25.2.1, "Configuring Geographic Map Components."

You should already have a map on your page. If you do not, follow the instructions in this chapter to create a map. For information, see Section 25.2.2, "How to Add a Geographic Map to a Page."

You should have already configured a map point theme to display data on the map.

To customize the images for points in a map point theme:

  1. In the Structure window, right-click the dvt:mapPointTheme component and select Insert inside dvt:mapPointTheme > Point Style Item.

  2. In the Property Inspector, expand the Common section. Use this section to set the following attributes:

    • ImageURL: Use to specify the path to the image file to display on the map for a point that falls in the data value range for this custom image. Alternatively, you can choose Edit from the attribute dropdown menu to open a dialog to navigate to the image file.

    • MaxValue and MinValue: Use to specify the data value range that this custom image represents by entering minimum values and maximum values for each attribute respectively.

    • Id: Enter a unique identifier for the custom image that you are defining.

    • ShortLabel: Use to specify the descriptive text that you want to display in front of the actual data value when a user hovers the cursor over a point that falls in the range represented by this tag.

      For example, you might want to enter the following text for a custom point that falls in the lowest data value range:

      Low Inventory
      
    • HoverURL: Optionally, specify the path to a different image to use when the end user moves the mouse over an image on the map.

    • SelectedURL: Optionally, specify the path to a different image to use when the end user selects an image on the map.

  3. Repeat Step 2 for each custom image that you want to create for your point theme.

25.4.5 What Happens When You Customize the Point Images in a Map

When you use the point style item components to specify a custom image representing a range of data values for a point theme, a child mapPointStyleItem tag is defined inside the parent mapPointTheme tag. Example 25-3 shows the code generated on a JSF page for a map point theme that has three custom point images that represent ranges of inventory at each warehouse point.

The initial point style setting (ps0) applies to values that do not exceed 500. This point style displays an image for very low inventory and provides corresponding tooltip information.

The second point style setting (ps1) applies to values between 500 and 1000. This point style displays an image for low inventory and provides corresponding tooltip information.

The final point style setting (ps2) applies to values between 1000 and 1600. This point style displays an image for high inventory and provides corresponding tooltip information.

Example 25-3 Map Point Theme Code with Custom Point Images

<dvt:map id="map1"
...
  <dvt:mapPointTheme id="mapPointTheme1"
     shortLabel="Warehouse Inventory"
     value="{bindings.WarehouseStockLevelsByProduct1.geoMapModel}">
    <dvt:mapPointStyleItem id="ps0" minValue="0"
         maxValue="500"
         imageURL="/images/low.png"
         selectedImageURL="/images/lowSelected.png"
         shortLabel="Very Low Inventory"/>
    <dvt:mapPointStyleItem id="ps1" minValue="500"
         maxValue="1000"
         imageURL="/images/medium.png"
         selectedImageURL="/images/mediumSelected.png"
         shortLabel="Low Inventory"/>
    <dvt:mapPointStyleItem id="ps2" minValue="1000"
         maxValue="1600"
         imageURL="/images/regularGreen.png"
         selectedImageURL="/images/regularGreenSelected.png"
         shortLabel="High Inventory"/>
  </dvt:mapPointTheme>
</dvt:map>

25.4.6 How to Customize the Bars in a Bar Graph Theme

When you create a map bar graph theme, default colors are assigned to the bars in the graph. You can customize the colors of the bars. Use one mapBarSeriesSet tag to wrap all the mapBarSeriesItem tags for a bar graph theme and insert a mapBarSeriesItem tag for each bar in the graph.

Before you begin:

It may be helpful to have an understanding of how map attributes and map child tags can affect functionality. For more information, see Section 25.2.1, "Configuring Geographic Map Components."

You should already have a map on your page. If you do not, follow the instructions in this chapter to create a map. For information, see Section 25.2.2, "How to Add a Geographic Map to a Page."

You should have already configured a map bar graph theme to display data on the map.

To customize the color of the bars in a map bar graph theme:

  1. In the Structure window, right-click the dvt:mapBarGraphTheme tag and choose Insert inside dvt:mapBarGraphTheme > Map Bar Series Set.

    There are no attributes to set for this tag. It is used to wrap the individual bar series item tags.

  2. In the Structure window, right-click the dvt:mapBarSeriesSet tag and choose Insert inside dvt:mapBarSeriesSet > Map Bar Series Item.

  3. In the Property Inspector, set the following attributes:

    • Id: Enter a unique Id for the bar series item.

    • Color: Enter the unique color to use for the bar. Valid values are RGB hexidecimal colors. Alternatively, you can choose Edit from the attribute dropdown menu to open an Edit Property: Color dialog.

  4. Repeat Step 3 for each bar in the graph.

    Note:

    To find and modify the sequence of the bars in the graph, examine the Edit Bar Graph Map Theme Binding dialog by clicking the Edit icon for the mapBarGraphTheme component. The sequence of the entries in the Series Attribute column of that dialog determines the sequence that bars appear in the graph. After selecting an existing series, use the arrow icons (Up, Down, Top, Bottom) to reorder the series or use the Delete icon to delete that series.

25.4.7 What Happens When You Customize the Bars in a Map Bar Graph Theme

When you use the Edit Bar Graph Map Theme Binding dialog to customize the bars in a map bar graph theme, the sequence of the bars reflect the sequence of the entries in the Series Attribute column in the dialog. Example 25-4 shows sample source code generated on the JSF page when you customize the bars in a map bar graph.

Example 25-4 Code for Customizing the Bars in a Map Bar Graph

<dvt:map
...
  <dvt:mapBarGraphTheme
  ...
    <dvt:mapBarSeriesSet>
      <dvt:mapBarSeriesItem color="#333399" id="bar1"/>
      <dvt:mapBarSeriesItem color="#0000ff" id="bar2"/>
    </dvt:mapBarSeriesSet>
  </dvt:mapBarGraphTheme>
</dvt:map>

25.4.8 How to Customize the Slices in a Pie Graph Theme

When you create a map pie graph theme, default colors are assigned to the slices in the graph. You can customize the colors of the slices. Use one mapPieSliceSet tag to wrap all the mapPieSliceItem tags for a pie graph theme and insert a mapPieSliceItem tag for each slice in the graph.

Before you begin:

It may be helpful to have an understanding of how map attributes and map child tags can affect functionality. For more information, see Section 25.2.1, "Configuring Geographic Map Components."

You should already have a map on your page. If you do not, follow the instructions in this chapter to create a map. For information, see Section 25.2.2, "How to Add a Geographic Map to a Page."

You should have already configured a map pie graph theme to display data on the map.

To customize the color of the slices in a map pie graph theme:

  1. In the Structure window, right-click the dvt:mapPieGraphTheme tag and choose Insert inside dvt:mapPieGraphTheme > Pie Slice Set.

    There are no attributes to set for this tag. It is used to wrap the individual pie graph item tags.

  2. In the Structure window, right-click the dvt:mapPieSliceSet node and choose Insert inside dvt:mapPieSliceSet > Pie Slice Item.

  3. In the Property Inspector, set the following attributes:

    • Id: Enter a unique Id for the pie slice item.

    • Color: Enter the unique color to use for the pie slice. Valid values are RGB hexidecimal colors. Alternatively, you can choose Edit from the attribute dropdown menu to open an Edit Property: Color dialog.

  4. Repeat Step 3 for each pie slice in the graph.

    Note:

    To find and modify the sequence of the slices in the graph, examine the Edit Pie Graph Map Theme Binding dialog by clicking the Edit icon for the mapPieGraphTheme component. The sequence of the entries in the Pie Slice Attribute column of that dialog determines the sequence that bars appear in the graph. After selecting an existing pie slice, use the arrow icons (Up, Down, Top, Bottom) to reorder the slices or use the Delete icon to delete that slice.

25.4.9 What Happens When You Customize the Slices in a Map Pie Graph Theme

When you use the Edit Pie Graph Map Theme Binding dialog to customize the slices in a map pie graph theme, the sequence of the slices reflect the sequence of the entries in the Pie Slices Attribute column of the dialog. Example 25-5 shows sample code generated in a JSF page when you customize the slices in a map pie graph.

Example 25-5 Code for Customizing the Slices in a Map Pie Graph

<dvt:map
...
  <dvt:mapPieGraphTheme
  ...
    <dvt:mapPieSliceSet>
      <dvt:mapPieSliceItem color="#ffffff" id="slice1"/>
      <dvt:mapPieSliceItem color="#ffff00" id="slice2"/>
      <dvt:mapPieSliceItem color="#ff0000" id="slice3"/>
    </dvt:mapPieSliceSet>
  </dvt:mapPieGraphTheme>
</dvt:map>

25.5 Adding a Toolbar to a Geographic Map

When you create a geographic map, you can also add and configure a map toolbar to display the legend and information panel, select themes (if you have multiple themes of the same type) or use any of the distance measurement, area measurement, or selection tools. Figure 25-20 shows a map toolbar.

Figure 25-20 Geographic Map Toolbar

Geographic map toolbar

For more information about toolbar functionality, see Section 25.1.1.1, "Geographic Map End User and Presentation Features."

25.5.1 How to Add a Toolbar to a Map

The map toolbar is a separate component and can be positioned on the JSF page above or below the map.

Before you begin:

It may be helpful to have an understanding of how map attributes and map child tags can affect functionality. For more information, see Section 25.2.1, "Configuring Geographic Map Components."

You should already have a map on your page. If you do not, follow the instructions in this chapter to create a map. For information, see Section 25.2.2, "How to Add a Geographic Map to a Page."

To add and configure a map toolbar:

  1. In the Structure window, right-click the dvt:map component and choose Insert before dvt:map or Insert after dvt:map > ADF Data Visualization.

  2. From the ADF Data Visualization Item dialog, select Toolbar to open the Create Map Toolbar dialog.

  3. From the dropdown list, choose the ID of the map on which this toolbar will operate and click OK.

  4. In the Property Inspector, expand the Common section. In this section set the following attributes:

    • ShowDistanceTools: Use to specify whether or not the distance tool is available on the toolbar. The default value is true.

    • ShowSelectThemeDialog: Use to specify whether or not the Select Theme dialog is available on the View menu of the toolbar. The default value is true.

    • ShowSelectThemeMenuItem: Use to specify whether or not the Select Theme option is available on the View menu of the toolbar. The default value is true.

    • ShowSelectionTools: Use to specify whether or not the selection tools, area rectangle, circle, polygon, or point tool is available on the toolbar. The default value is true.

    • ShowViewMenu: Use to specify whether or not the View menu is available on the toolbar. The default is true.

    • ShowZoomTools: Use to specify whether or not the zoom in and zoom out tools are available on the toolbar. The default is true.

25.5.2 What Happens When You Add a Toolbar to a Map

When you add a toolbar to a map, the following occurs:

  • A toolbar appears in the JSF page above or below the map as specified. By default, the toolbar contains all the tools unless you change the visibility of one or more tools.

  • Source code is generated and appears in the JSF page above or below the code for the map.

Example 25-6 shows sample code for a toolbar that is associated with a map with the ID of map_us. The example shows the location of the code for the map.

Example 25-6 Code Generated for a Map Toolbar

<af:form>
  <dvt:mapToolbar mapId="map_us" id="T1"/>
  <dvt:map  id="map_us" 
   ...
  </dvt:map>
</af:form>

25.6 Using Thematic Map Components

To display data in thematic maps, a named data collection is required. A data collection represents a set of data objects (also known as a row set) in the data model. Each object in a data collection represents a specific structured data item (also known as a row) in the data model.

25.6.1 Configuring Thematic Maps

The thematic map has a parent component that specifies the geographic base map and child components that are used to style map regions with colors, patterns, or markers, or both, or to add a legend to the map. The prefix dvt: occurs at the beginning of each thematic map component name indicating that the component belongs to the ADF Data Visualization Tools (DVT) tag library. You can configure the following map components:

  • Thematic map component (thematicMap): The main thematic map component used to specify the base map upon which data is displayed. The thematic map is packaged with prebuilt base maps including a USA base map, a world base map, as well as base maps for continents and regions of the world such as EMEA and APAC. The thematic map component does not require a map service to display a base map.

  • Layer (areaLayer): Use to specify the layers in the base map that are displayed. Each areaLayer component references a single layer, for example, States, or Points (cities) in the USA base map, and only the map layers for which an areaLayer tag is present will be displayed. Data is then associated with a layer by nesting a data layer within the layer. The areaLayer child tags are area data layer (areaDataLayer) and point data layer (pointDataLayer).

  • Area Data Layer (areaDataLayer): Use to associate map layers with a data collection. Using stamping, each row of data in the data model can be identified by a style, for example a color or pattern; a marker, for example a circle or square; or an image.

    Note:

    When you use stamping, child components are not created for every area, marker, or image in a thematic map. Rather, the content of the component is repeatedly rendered, or stamped, once per data attribute, such as the rows in a data collection.

    Each time a child component is stamped, the data for the current component is copied into a var property used by the data layer component in an EL Expression. Once the thematic map has completed rendering, the var property is removed, or reverted back to its previous value.

    The location of the data layer is identified by its immediate child, the areaLocation tag. This component specifies the location of the named region or area in the map layer. The three types of data that can be stylized in a child tag to the areaLocation tag include:

    • Area (area): Use to stamp out stylistic attributes such as fill colors, patterns, or opacity onto the geographical regions of the map.

    • Marker (marker): Use to stamp out built-in or custom shapes associated with data points on the map. Markers can be customized with different stylistic attributes such as colors and patterns based on their underlying data.

    • Images (af:image): Use to stamp out an image associated with geographical regions of the map.

    Note:

    Instead of directly specifying the style attributes for the area or marker tags, you can use a child attributeGroups tag to generate the style attribute type automatically based on categorical definitions of the data set. If the same style attribute is set in both the area or marker tags, and by an attributeGroups tag, the attributeGroups style type will take precedence.

    Note:

    You can format a numerical value represented in the area or marker tag, for example, apply a currency format, by using an af:convertNumber tag. For more information, see Section 25.7.3, "How to Format Numeric Data Values in Area and Marker Labels."

    Figure 25-21 illustrates the basic tag structure for configuring a data layer in a thematic map.

    Figure 25-21 Tag Structure for Thematic Map Area Data Layers

    Tag structure for thematic map data layers.
  • Point data layer (pointDataLayer): Use to associate a map with a specific data point or a map layer with a data collection. The data point can be specified by a named point in a map layer, for example, cities in the USA map, or by longitude and latitude. Using stamping, each point in the data model can be identified by a marker, for example a circle or square, or an image.

    Note:

    When you use stamping, child components are not created for every marker or image in a thematic map. Rather, the content of the component is repeatedly rendered, or stamped, once per data attribute, such as the rows in a data collection.

    Each time a child component is stamped, the data for the current component is copied into a var property used by the point layer component in an EL Expression. Once the thematic map has completed rendering, the var property is removed, or reverted back to its previous value.

    The location of the point layer is identified in its immediate child, a pointLocation tag. You can configure the location to specify longitude and latitude, or by the location of the named area in the map layer. The two types of data that can be stylized in a child tag to the pointLocation tag include:

    • Marker (marker): Use to stamp out built-in or custom shapes associated with data points on the map. Markers can be customized with different stylistic attributes such as colors and patterns based on their underlying data.

    • Images (af:image): Use to stamp out an image associated with geographical regions of the map.

    Note:

    Instead of directly specifying the style attributes for the marker tag, you can use a child attributeGroups tag to generate the style attribute type automatically based on categorical definitions of the data set. If the same style attribute is set in both the marker tags, and by an attributeGroups tag, the attributeGroups style type will take precedence.

    Note:

    You can format a numerical value represented in the marker tag, for example, apply a currency format, by using an af:convertNumber tag. For more information, see Section 25.7.3, "How to Format Numeric Data Values in Area and Marker Labels."

    Figure 25-22 illustrates the basic tag structure for configuring a point data layer in a thematic map.

    Figure 25-22 Tag Structure for Configuring Thematic Map Point Data Layer

    Tag structure for configuring thematic map point layer

    When a point data layer is configured as a direct child of the thematic map component, the data points are always displayed as a global point layer. If the point layer is nested inside a map layer, the data points are only displayed when that map layer is displayed.

    Figure 25-23 illustrates the tag structure for nesting point data layers. In the illustration, point data layer pd1 is only displayed when the states layer is displayed. Point data layer pd2 is always displayed.

    Figure 25-23 Tag Structure for Nesting Thematic Map Point Data Layers

    Tag structure for nesting thematic map point data layers.
  • Custom layer (customAreaLayer): Use to create a new map layer from independent region data and insert the newly created layer into the layer hierarchy. The custom layer is created by extending a predefined map layer and aggregating the lower level regions to form the new regions in the custom layer. After defining a custom map layer, it is used in the same way as any other map layer

    Use the child customArea component to specify the regions from the predefined base map that will be aggregated to form the new area.

  • Categorical attributes (attributeGroups): Use to generate stylistic attribute values such as colors or shapes based on categorical data values in a data set.

    An alternative to configuring a default stamp across all areas or markers in the thematic map, you use an area or marker component child attributeGroups tag to generate the style attribute type automatically based on categorical groups in the data set. If the same style attribute is set in both the area or marker tag, and by an attributeGroups tag, the attributeGroups style type will take precedence.

    Based on the attribute representing the column in the data model to group by, the attributeGroups component can generate style values for each unique value, or group, in the data. The type property of the attributeGroups tag specifies the type of stylistic attribute for which values are produced. Supported types for area components are color, pattern, and opacity. Supported types for marker components are color, shape, pattern, opacity, scaleX, and scaleY. These types can be combined in a space-delimited list to generate multiple stylistic properties for each unique data value.

    The default style values that are generated are defined using CSS style properties in the ADF skin. Each attributeGroups type has a default ramp defined in the ADF skin that can be customized by setting the index-based selectors to the desired values.

    To achieve a finer level of detail in the display of data, the grouping rules specified in the attributeGroups component can be overridden by two types of rules defined in these child components:

    • Matching rule (attributeMatchRule): Use to substitute an attribute when the data matches a certain value.

    • Exception rule (attributeExceptionRule): Use to replace an attribute value with another when a particular boolean condition is met.

    Note:

    The attributeMatchRule and attributeExceptionRule tags use a child f:attribute tag to define the override values, where the name property defines the type of attribute (such as color or shape), and the value property defines the override value to use (such as red or square). When the value property of the attributeGroups tag overrides the value in the group property of the attributeMatchRule, then the style value in the child f:attribute will be assigned to that group of data instead of the next value from the default ramp.

    The f:attribute tag name property must match one of the attributes listed in the type of the attributeGroups tag grouping rules. If the value provided by an override also happens to be in the prebuilt ramp returned by the attributeGroups, then that value will only be used by the overrides and will be skipped in the prebuilt ramp.

  • Legend (legend): Use to display an explanatory table of the map's styled data in symbol and label pairs. Legend components support symbols for color, shape, custom shape, fill pattern, opacity, and images.

    • Legend section (legendSection): Use one or more to point to a thematic map area, marker, attributeGroups, or af:image components stamped to style the data displayed in the map. Legend items sourced from the attributeGroups component split area or marker attribute types into different sections.

    • Legend group (showLegendGroup): Use to create a disclosable section that contains legend section components.

25.6.2 What You May Need to Know About Prebuilt Base Maps

Each base map provided for the thematic map component has two or more prebuilt map layers that represent a set of regions. For example, the world base map includes a map layer for continents and another layer for countries. The regions in the lower level map layers are aggregated to make up the next level in the geographical hierarchy. The map layer is specified in the layer attribute of the areaLayer component.

Table 25-1 shows the valid map layers for each base map.

Table 25-1 Prebuilt Base Maps and Layers

Base Map Layers

usa

country, states, counties, cities

world

continents, countries, cities

worldRegions

regions, countries, cities

africa, asia, australia, europe, northAmerica, southAmerica

continents, countries, cities

apac, emea, latinAmerica, usaAndCanada

regions, countries, cities


When you are binding your data collection to a thematic map, you must provide a column in the data model that specifies the location of the area or point data using the map location Ids of the regions from the base map for which the data is being displayed. Area locations are specified in the name attribute of the areaLocation component, and point locations are specified in the pointName attribute for the pointLocation component when its type attribute is set to pointName. For more information, see the "What You May Need to Know About Base Map Location Ids" section in the Oracle Fusion Middleware Fusion Developer's Guide for Oracle Application Development Framework.

25.6.3 Using the Layer Browser

JDeveloper provides a Layer Browser as a tool to ease the development of structuring map layers, data layers, and styling areas and markers to display data in a thematic map. The Layer Browser displays on top of the thematic map in the visual editor and can be repositioned and resized. If not visible, right-click in the map and select Open Layer Browser.

The Layer Browser visually represents the logical structure of the thematic map and its hierarchical map layers and components. Selection of a component in the Layer Browser is coordinated with selection in the Property Inspector, Structure window, and page source code.

The Layer Browser toolbar provides controls for the following operations:

  • Add: Provides a dropdown menu for opening a create map layer, data layer, area, or marker dialog to add and configure the component and add source code to the thematic map. The menu choices are provided to maintain the correct structure of the thematic map

  • Edit: Open a data layer, area, or marker binding dialog to modify the settings for the component and change the thematic map source code.

  • Delete: Remove a selected map layer, data layer, area or marker from the thematic map structure and source code.

The Layer Browser displays the Id for each component represented in the hierarchical structure. Components are automatically assigned a unique, consecutively numbered id value. Map layers (areaLayer) are assigned al1, al2, al3, and so on. Custom layers (customAreaLayer) are assigned cal1, cal2, cal3, and then referenced by an areaLayer component within the consecutive order. Data layers including area (areaDataLayer) and point (pointDataLayer) components are assigned dl1,dl2, dl3, and so on. When a point layer (pointDataLayer) is added as a direct child of the thematic map, it is a global point layer and always displayed in the thematic map. Markers (marker) are assigned m1, m2, m3 and so on. Areas (area) are assigned a1, a2, a3, and so on.

Figure 25-23 shows a Layer Browser displaying the hierarchical structure of a thematic map.

Figure 25-24 Thematic Map Layer Browser

Thematic map layer browser

25.6.4 How to Add a Thematic Map to a Page

When you are designing your page using simple UI-first development, you use the Component Palette to add a thematic map to a JSF page. When you drag and drop a thematic map component onto the page, the Component Gallery displays available base maps, prebuilt regional layers, and a custom layer option to provide visual assistance when creating thematic maps. Figure 25-25 show the Component Gallery for thematic maps with the United States base map and states layer selected.

Figure 25-25 Component Gallery for Thematic Maps

Component Gallery for thematic maps.

Once you complete the dialog, and the thematic map is added to your page, you can use the Property Inspector to specify data values and configure additional display attributes for the map.

In the Property Inspector you can use the dropdown menu for each attribute field to display a property description and options such as displaying an EL Expression Builder or other specialized dialogs. Figure 25-26 shows the dropdown menu for a thematic map component tooloTipDisplay attribute.

Figure 25-26 Thematic Map ToolTipDisplay Attribute Dropdown Menu

Thematic Map ToolTipDisplay Attribute Dropdown Menu

Note:

If your application uses the Fusion technology stack, then you can use data controls to create a thematic map and the binding will be done for you. For more information, see the "Creating Databound Thematic Maps" section in the Oracle Fusion Middleware Fusion Developer's Guide for Oracle Application Development Framework

Before you begin:

It may be helpful to have an understanding of how thematic map attributes and thematic map child components can affect functionality. For more information, see Section 25.6.1, "Configuring Thematic Maps."

You may also find it helpful to understand functionality that can be added using other ADF Faces features. For more information, see Section 25.1.3, "Additional Functionality for Map Components."

To add a thematic map to a page:

  1. In the Component Palette, from the ADF Data Visualizations page, in the Map panel, drag and drop a Thematic map onto the page to open the Create Thematic Map dialog in the Component Gallery.

    Use the dialog to select the thematic map base map and layer in the prebuilt map hierarchy that you want the thematic map to display. If you need help, press F1 or click Help.

  2. In the Property Inspector, view the attributes for the thematic map. Use the help button to display the complete tag documentation for the thematicMap component.

  3. Expand the Common section. Use this section to set the following attributes:

    • Basemap: If you want to change the base map selected in the Component Gallery, use the dropdown list to select any of the following valid values: usa, world, africa, asia, australia, europe, northAmerica, southAmerica, apac, emea, latinAmerica, usaAndCanada, or worldRegions.

    • Map Layers: Use the dialog that displays inside the Property Inspector to add additional map layers you wish to display in the thematic map. For example, the USA base map includes a map layer for the country, the states, the counties, the cities (points), and a custom layer. Use the dropdown list associated with the Add icon to add available map layers in the predefined geographic hierarchy, to create a custom map layer and insert it into the hierarchy, or to add a global point layer into the base map. Use the Delete icon to delete a layer you do not wish to display in the thematic map. Figure 25-27 shows the map layers dialog outlined in the Property Inspector for the thematicMap component.

      Figure 25-27 Map Layers Dialog in the Property Inspector

      Map layers dialog in the Property Inspector

      Alternatively, you can use the Layer Browser to add map layers to the thematic map. For more information, see Section 25.6.3, "Using the Layer Browser."

  4. Expand the Appearance section. Use this section to set the following attributes:

    • ImageFormat: Use the dropdown list to select the image format with which to display the thematic map. By default, thematic maps are displayed with a Flash player. For more information, see Section 25.6.6, "What You May Need to Know About Flash and PNG Image Formats."

    • TooltipDisplay: By default (auto), thematic maps automatically display tooltips using prebuilt map labels when the user moves the cursor over the map. If data is available, the label is concatenated with the shortDesc attribute from the area or marker component stamp. Other valid values include none to disable the display of tooltips, and shortDesc to display only the data coming from the stamps, not including the prebuilt label of the base map. For more information, see Section 25.7, "Customizing Thematic Map Display Attributes."

    • Animation subsection: Use the animation attributes in this subsection to configure animation in thematic maps. For more information, see Section 25.8.3, "How to Configure Animation Effects."

  5. Expand the Behavior section. Use this section to set the following attributes:

    • Drilling: Use to enable drilling the data view between thematic map layers. From the dropdown list select on to enable drilling. The default value is off.

    • MaintainDrill: Use to specify an optional true value for maintaining the drilled state of a previously drilled area when a new area is drilled. The default value is false.

    • DrillBehavior: Use to specify an optional zoomToFit effect on the area being drilled. The default value is none.

    • ControlPanelBehavior: Use the dropdown list to select the display of the thematic map control panel. The default value is initCollapsed for only display of the hide/show button. Other valid values include hidden and initExpanded.

    • FeaturesOff: Enter a space delimited list of end user features to disable at runtime. Valid values are pan, zoom, and zoomToFit. The default value is none.

  6. Expand the Other category. For the Summary attribute, enter a description of the thematic map. This description is accessed by screen reader users.

25.6.5 What Happens When You Add a Thematic Map to a Page

When you use the Component Palette to create a thematic map, JDeveloper inserts code in the JSF page. Example 25-7 shows the code inserted in the JSF page.

Example 25-7 Thematic Map Code In JSF Page

<dvt:thematicMap basemap="usa" id="tm1">
  <dvt:areaLayer layer="states" id="al1"/>
</dvt:thematicMap>

The Layer Browser displays the hierarchical structure of the thematic map. Figure 25-28 shows the Layer Browser after using the Component Palette to create a thematic map.

Figure 25-28 Thematic Map Layer Browser

Thematic map layer browser

You can then configure the thematic map to display data in stylized areas or markers using the ADF Data Controls panel and the thematic map binding dialogs. For information about configuring thematic maps to display data, see the "Creating Databound Thematic Maps" section in the Oracle Fusion Middleware Fusion Developer's Guide for Oracle Application Development Framework.

25.6.6 What You May Need to Know About Flash and PNG Image Formats

By default, thematic maps are displayed using a Flash player and a Portable Network Graphics (PNG) output format is used when printing thematic maps. Both Flash and PNG image formats support bi-directional locales. Static rendering, such as maintaining pan and zoom state of the Flash display, is fully supported in the printable PNG image.

In order to display thematic maps, do not disable the use of Flash content across the entire application by setting a flash-player-usage context parameter in adf-config.xml. For more information, see Section A.4.3, "Configuring Flash as Component Output Format."

25.7 Customizing Thematic Map Display Attributes

You can customize the display attributes of thematic maps labels, including prebuilt map layer labels and labels for area and marker components that stamp out the data values for the thematic map. Data values that require special formatting, for example, currency or percentages, can be configured to display special symbols and decimal points. You can also configure tooltips to display data when the user moves the cursor over the map.

25.7.1 How to Customize Thematic Map Labels

By default, each region in each map layer for a prebuilt base map has a label with a short and long type, for example, BRA and Brazil in the countries layer of the world base map. The map layer is specified by the areaLayer component in the layer attribute, for example:

<dvt:areaLayer id="al1" layer="countries">

Note:

Labels are only displayed when they fit within the named region of the map layer. When a label does not fit inside the region, it is not displayed unless leader lines determining the alternate label location are provided for that layer in the base map. Only the prebuilt usa map provides leader lines for labels outside the states layer.

Figure 25-29 shows the default labels for the europe and usa base maps.

Figure 25-29 Default Labels for Europe and USA Base Maps

Default labels for Europe and USA base maps.

You can customize the default labels provided by the base map for display and style.

Before you begin:

It may be helpful to have an understanding of how thematic map attributes and thematic map child components can affect functionality. For more information, see Section 25.6.1, "Configuring Thematic Maps."

You should already have a thematic map on your page. If you do not, follow the instructions in this chapter to create a thematic map. For more information, see Section 25.6.4, "How to Add a Thematic Map to a Page."

To customize a map layer label:

  1. In the Structure window, right-click the dvt:areaLayer component representing the map layer for which you wish to customize the label, and select Go to Properties.

  2. In the Property Inspector, expand the Appearance section, and set the following attributes:

    • LabelDisplay: Use the dropdown list to select how the prebuilt base map labels for the layer are to be displayed. Valid values are: auto (default) to display the label if there is sufficient space in the region; on to display the base map labels for all regions of this layer; and off to disable the display of labels.

    • LabelStyle: Enter the font-related CSS styles to use for the label font.

    • LabelType: Use the dropdown list to select the prebuilt base map labels to display. Valid values are short (default) to display the short labels defined in the base map, for example, TX, and long to display the long labels defined in the base map, for example, Texas.

You can also override the default labels in the base map by specifying attributes for the area components that stamp out stylistic attributes such as fill colors, patterns, or opacity onto the geographic regions of the map, and for marker components that stamp out built-in or custom shapes associated with data points on the map.

To customize area and marker labels:

  1. In the Structure window, right-click the dvt:aler component or dvt:areaGraph component representing the stamp for which you wish to customize the label, and select Go to Properties.

  2. In the Property Inspector, expand the Other section, and set the following attributes:

    • LabelDisplay: Use the dropdown list to select on to display the text displayed in the value attribute.

    • Value: Enter the text you wish to use for the area or marker label when LabelDisplay is set to on.

    • LabelStyle: Enter the font-related CSS styles to use for the area or marker label font.

    • LabelPosition: Available only for the marker label. Use the dropdown list to select the position relative to the marker that the specified value label should be displayed. Valid values are center (default), top, and bottom.

      Note:

      If a marker is displayed on a region, that is as a child component to a pointLocation for an areaDataLayer, and that marker has a label, then the label associated with the base map region will not be displayed.
    • ShortDesc: Enter the short description you wish to use for the area or marker stamp. This value is used for the tooltip that displays when the user moves the cursor over the area or marker. For more information, see Section 25.7.2, "How to Configure Tooltips to Display Data."

25.7.2 How to Configure Tooltips to Display Data

By default, thematic maps automatically display tooltips using map layer labels when the user moves the cursor over the map. If data is available, the map layer label is concatenated with the value from the area or marker component stamp. You can also configure the tooltip to only display available data.

Before you begin:

It may be helpful to have an understanding of how thematic map attributes and thematic map child components can affect functionality. For more information, see Section 25.6.1, "Configuring Thematic Maps."

You should already have a thematic map on your page. If you do not, follow the instructions in this chapter to create a thematic map. For more information, see Section 25.6.4, "How to Add a Thematic Map to a Page."

To configure tooltips to display data:

  1. In the Structure window, right-click the dvt:thematicMap component and select Go to Properties.

  2. In the Property Inspector, expand the Appearance section. For the TooltipDisplay attribute choose auto to display the label concatenated with the value of the area or marker stamp, or shortDesc to only display the value.

  3. In the Structure window, right-click the dvt:area component or dvt:marker component representing the stamp for which you wish to display data in the tooltip, and select Go to Properties.

  4. In the Property Inspector, expand the Other section. For the ShortDesc attribute enter the value you want to display in the tooltip. For example, if an area component value attribute is #{row.data}, use that same value for the shortDesc attribute.

25.7.3 How to Format Numeric Data Values in Area and Marker Labels

Thematic map area and marker components can display numeric data values in labels, for example a dollar value, or a percentage. Area and marker labels are specified in the value attribute of the component. You can format numeric data values by adding a standard ADF converter, af:convertNumber, as a child of the area or marker component, or by specifying a converter through an EL Expression directly on the component. If both a converter and a child af:convertNumber tag are specified, then the properties of the child tag take precedence.

Before you begin:

It may be helpful to have an understanding of how thematic map attributes and thematic map child components can affect functionality. For more information, see Section 25.6.1, "Configuring Thematic Maps."

You should already have a thematic map on your page. If you do not, follow the instructions in this chapter to create a thematic map. For more information, see Section 25.6.4, "How to Add a Thematic Map to a Page."

You should already have configured an area or marker label in your thematic map. If you do not, follow the instructions in this chapter to customize an area or marker label. For more information, see Section 25.7.1, "How to Customize Thematic Map Labels."

To format numeric data values in area or maker labels:

  1. In the Structure window, right-click the dvt:area or dvt:marker component representing the stamp you wish to format, and choose insert inside dvt:area or insert inside dvt:marker > Convert number.

  2. In the Property Inspector, specify values for the attributes of the af:convertNumber component to produce numeric formatting. Use the help button to display the complete tag documentation for the af:convertNumber component.

Example 25-8 shows sample code for formatting numeric data values for an area and a marker label.

Example 25-8 Sample Code for Area and Marker Numeric Data Value Formatting

...
<dvt:area id="a2" labelDisplay="on" value="#{mapBean.value}" >
  <af:convertNumber id="cn1" type="currency"/>
</dvt:area>
<dvt:marker id="m2" labelDisplay="on" value="#{mapBean.value}" >
  <af:convertNumber id="cn1" type="currency"/>
</dvt:marker>
...

Alternatively, specify a converter through an EL expression directly on the area or marker component. For example:

<dvt:marker id="m1" labelDisplay="on" value="#{mapBean.value}"
       converter="#{mapBean.myConverter}"/>

25.8 Adding Interactivity to Thematic Maps

Thematic maps include support for interaction features including selection and action events, drilling, popups, animation, and drag and drop operations.

25.8.1 How to Configure Selection and Action Events in Thematic Maps

You can configure your thematic map components to allow users to select one or more areas or markers across multiple data layers. By default, selection is not enabled.

You configure selection on areaDataLayer and pointDataLayer components to allow selection of one or multiple area or marker stamps.

Once selection is enabled, you can configure an area or marker stamp with an action listener to specify and handle a custom event such as displaying output text or navigating to another page. For more information about ADF action events, see Chapter 6, "Handling Events."

Figure 25-30 shows a thematic map configured to display output text when a human marker is clicked, and navigate to another JSF page when a circle marker is clicked.

Figure 25-30 Thematic Map Action Events

Thematic map action events

Before you begin:

It may be helpful to have an understanding of how thematic map attributes and thematic map child components can affect functionality. For more information, see Section 25.6.1, "Configuring Thematic Maps."

You should already have a thematic map on your page. If you do not, follow the instructions in this chapter to create a thematic map. For more information, see Section 25.6.4, "How to Add a Thematic Map to a Page."

You should have already configured a data layer with an area or marker to display data on your thematic map.

To configure selection and action events:

  1. In the Structure window, right-click the dvt:areaDataLayer or dvt:pointDataLayer component and select Go to Properties.

  2. In the Property Inspector, expand the Behavior section. For the SelectionMode attribute choose single to enable single selection of an area or marker, or multiple to enable multiple selection of areas or markers.

  3. In the Structure window, right-click the dvt:area component or dvt:marker component representing the stamp for which you wish to configure an action event, and select Go to Properties.

  4. In the Property Inspector, expand the Behavior section. In this section set the following attributes:

    • Action: Enter a reference to an action method sent by the component, or the static outcome of an action. For example, mapAction.

    • ActionListener: Enter a method reference to an action listener. For example, #{tmapEventBean.processClick}

shows sample code for configuring markers to fire action events.

Example 25-9 Sample Code for Thematic Map Marker Action Events

<f:facet name="center">
  <dvt:thematicMap id="thematicMap"
                   imageFormat="flash" basemap="usa"
                   inlineStyle="width:98%;height:95%;" 
                   summary="Thematic map showing action events">
    <dvt:areaLayer id="areaLayer" layer="states"
                   labelDisplay="off">
      <dvt:areaDataLayer id="dataLayer"
                         contentDelivery="immediate"
                         value="#{tmapBean.colorModel}"
                         var="row"
                         varStatus="rowStatus"
                         selectionMode="single">
        <dvt:areaLocation id="dataLoc"
                          name="#{row.name}">
          <dvt:marker id="marker1"
                      shape="human" scaleX="3"
                      scaleY="3"
                      fillColor="#666699"
                      actionListener="#{tmapEventBean.processClick}"
                      rendered="#{row.category == 'category1'}" 
                      shortDesc="Human shape"/>
          <dvt:marker id="marker2"
                      shape="circle"
                      scaleX="2" scaleY="2"
                      fillColor="#006666"
                      action="mapAction"
                      rendered="#{row.category == 'category2'}" 
                      shortDesc="Circle shape"/>
        </dvt:areaLocation>
      </dvt:areaDataLayer>
    </dvt:areaLayer
  </dvt:thematicMap>
</f:facet>
<f:facet name="end">
  <af:outputText value="#{tmapEventBean.clickString}"
                 id="ot1"
                 partialTriggers="thematicMap:areaLayer:dataLayer:marker1"/>
</f:facet>

You can also configure an area or point data layer with a selection listener for declarative master-detail processing, for example, to display the thematic map associated data in another UI component on the page such as a table. For more information, see the "What You May Need to Know About Master-Detail Processing" section in the Oracle Fusion Middleware Fusion Developer's Guide for Oracle Application Development Framework.

25.8.2 How to Add Popups to Thematic Map Areas and Markers

Thematic map area and marker components can be configured to display popup dialogs, windows, and menus that provide information or request input from end users. Using the af:popup component with other ADF Faces components, you can configure functionality to allow your end users to show and hide information in secondary windows, input additional data, or invoke functionality such as a context menu.

With ADF Faces components, JavaScript is not needed to show or hide popups. The af:showPopupBehavior tag provides a declarative solution, so that you do not have to write JavaScript to open a popup component or register a script with the popup component. For more information about these components, see Chapter 15, "Using Popup Dialogs, Menus, and Windows."

For example, you may want to associate a popup to display information in a dialog or note window with thematic map areas or markers. Figure 25-31 shows a thematic map area (Texas) clicked to display a dialog of data about voting results, and the cursor hovered over marker (human) displaying a note window of data about a specific location.

Figure 25-31 Area Dialog and Marker Note Window

area dialog and marker note window

Before you begin:

It may be helpful to have an understanding of how thematic map attributes and thematic map child components can affect functionality. For more information, see Section 25.6.1, "Configuring Thematic Maps."

You should already have a thematic map on your page. If you do not, follow the instructions in this chapter to create a thematic map. For more information, see Section 25.6.4, "How to Add a Thematic Map to a Page."

You should already have created the popup components for the thematic map area or marker components to reference. Example 25-10 shows sample code for the dialog to be referenced when an area stamp is clicked.

Example 25-10 Code Sample for the Area Dialog Popup

<af:popup id="pop1" contentDelivery="lazyUncached" launcherVar="source"
                  eventContext="launcher">
  <af:setPropertyListener from="#{tmapPopupBean.colorModel.rowData}"
                  to="#{tmapPopupBean.source}"
                  type="popupFetch"/>
    <af:dialog id="nw1" modal="false" type="none"
                  title="Results - #{tmapPopupBean.source.fullName}">
      <af:panelGroupLayout id="pgl6">
      <af:panelGroupLayout id="pgl7" layout="horizontal"
                  halign="center">
        <af:outputText value="Candidate 1" id="ot2"
                  inlineStyle="color:#{tmapPopupBean.strColor2};
                  font-size:medium;"/>
        <af:spacer width="50" height="10" id="spacer1"/>
        <af:outputText value="Candidate 2" id="ot1"
                  inlineStyle="color:#{tmapPopupBean.strColor1};
                  font-size:medium;"/>
      </af:panelGroupLayout>
      <af:panelGroupLayout id="pgl5" layout="horizontal"
                  halign="center">
        <dvt:pieGraph id="graph1" subType="PIE"
                  inlineStyle="height:250.0px;width:250.0px"
                  tabularData="#{tmapPopupBean.graphData[tmapPopupBean.source]}"
                  imageFormat="PNG">
          <dvt:background fillTransparent="true"/>
          <dvt:graphPieFrame fillTransparent="true"/>
            <dvt:seriesSet>
              <dvt:series index="0" color="#{tmapPopupBean.color1}"/>
              <dvt:series index="1" color="#{tmapPopupBean.color2}"/>
            </dvt:seriesSet>
              <dvt:sliceLabel rendered="true">
              <dvt:graphFont id="graphFont1" size="14"/>
              </dvt:sliceLabel>
              <dvt:pieLabel rendered="false"/>
              <dvt:legendArea rendered="false"/>
        </dvt:pieGraph>
      </af:panelGroupLayout>
    </af:panelGroupLayout>
  </af:dialog>
</af:popup>

Example 25-11 shows sample code for the note window to be referenced when the user hovers the mouse over a marker stamp.

Example 25-11 Sample Code for Marker Note Window

<af:popup id="pop2" contentDelivery="lazyUncached" launcherVar="source"
                  eventContext="launcher">
  <af:setPropertyListener from="#{tmapPopupBean.pointModel.rowData}"
                  to="#{tmapPopupBean.noteSource}"
                  type="popupFetch"/>
  <af:noteWindow id="nw2">
    <af:panelGroupLayout id="pgl8" halign="center" layout="vertical">
      <af:outputText value="Latitude: #{tmapPopupBean.noteSource.latitude}"
                  id="ot4"/>
      <af:outputText value="Longitude: #{tmapPopupBean.noteSource.longitude}"
                  id="ot5"/>
    </af:panelGroupLayout>
  </af:noteWindow>
</af:popup>

For more information about popup components, see Chapter 15, "Using Popup Dialogs, Menus, and Windows."

To add a popup to an area or marker:

  1. In the Structure window, right-click the dvt:area or dvt:marker component and choose insert inside dvt:area or insert inside dvt:marker > Show Popup Behavior.

  2. In the Property Inspector, set the following attributes:

    • PopupId: Enter the ID of the popup referenced by the area or marker component. An ID beginning with a colon will be treated as absolute after trimming off the colon.

    • TriggerType: Enter the event type that will trigger the popup being displayed. Valid values for thematic map area or marker components are action, click and mouseHover.

    • Align: From the dropdown list, choose how the popup should be aligned with the area or marker component.

    • AlignID: Enter the ID of the area or marker component associated with the popup. An ID beginning with a colon will be treated as absolute after trimming off the colon.

Example 25-12 shows sample code for adding popup components to the area and marker stamps in a thematic map.

Example 25-12 Popups Associated With Area and Marker Components

<dvt:thematicMap id="thematicMap" imageFormat="flash
                 basemap="usa" summary="Thematic map showing voting data in US">
  <dvt:legend label="Legend">
    <dvt:showLegendGroup label="Voting Majority">
      <dvt:legendSection source="areaLayer:dataLayer:area1"/>
    </dvt:showLegendGroup>
  <dvt:legendSection source="areaLayer:pointLayer:marker1"/>
</dvt:legend>
<dvt:areaLayer id="areaLayer" layer="states">
  <dvt:areaDataLayer id="dataLayer" contentDelivery="immediate"
                 value="#{tmapPopupBean.colorModel}"
                 var="row" varStatus="rowStatus">
    <dvt:areaLocation id="areaLoc" name="#{row.name}">
      <dvt:area id="area1"
                 fillColor="#{row.value > 50 ? tmapPopupBean.color1 :
                 tmapPopupBean.color2}"
        <f:attribute name="legendLabel" value="#{row.value > 50 ? 'Candidate 2' :
                 'Candidate 1'}" />
        <af:showPopupBehavior triggerType="click"
                 popupId="::::pop1"
                 alignId="area1"
                 align="endAfter"/>
      </dvt:area>
    </dvt:areaLocation>
  </dvt:areaDataLayer>
  <dvt:pointDataLayer id="pointLayer"
                 value="#{tmapPopupBean.pointModel}" var="row"
                 varStatus="rowStatus"
                 contentDelivery="immediate">
    <dvt:pointLocation id="pointLoc" type="pointXY"
                 pointX="#{row.longitude}"
                 pointY="#{row.latitude}">
      <dvt:marker id="marker1" shape="human" fillColor="#FF9900"
                 scaleX="3" scaleY="3"
        <f:attribute name="legendLabel" value="Location of Interest" />
        <af:showPopupBehavior triggerType="mouseHover"                        
                  alignId="marker1"
                  popupId="::::pop2"
                  align="endAfter"/>
      </dvt:marker>
    </dvt:pointLocation>
   </dvt:pointDataLayer>
  </dvt:areaLayer>
</dvt:thematicMap>

25.8.3 How to Configure Animation Effects

By default, thematic maps are animated upon initial rendering of the map, when the data associated with the map changes, and when a region is drilled in the map. You can customize the default setting of each animation event.

Before you begin:

It may be helpful to have an understanding of how thematic map attributes and thematic map child components can affect functionality. For more information, see Section 25.6.1, "Configuring Thematic Maps."

You should already have a thematic map on your page. If you do not, follow the instructions in this chapter to create a thematic map. For more information, see Section 25.6.4, "How to Add a Thematic Map to a Page."

To customize animation effects in a thematic map:

  1. In the Structure window, right-click the thematicMap component and select Go to Properties.

  2. In the Property Inspector, expand the Appearance section. Use this section to set the following attributes:

    • AnimationDuration: Enter the animation duration in milliseconds. The default value is 1000.

    • AnimationOnDisplay: Use the dropdown list to select the animation effect upon initial display of the thematic map. The default value is zoom.

    • AnimationOnDrill: Use the dropdown list to select the animation effect when a map layer is drilled to a lower level. The default value is alphaFade.

    • AnimationOnMapChange: Use the dropdown list to select the animation effect when the value of the area or point data layer changes, or when the base map changes. The default value is none.

    Table 25-2 shows the animation effect available for each supported thematic map event.

    Table 25-2 Thematic Map Animation Effects

    Animation Effect AnimationOnDisplay AnimationOnDrill AnimationOnMapChange

    none

    x

    x

    x

    alphaFade

    x

    x

    x

    conveyorFromLeft

    x

     

    x

    conveyorFromRight

    x

     

    x

    cubeToLeft

    x

     

    x

    cubeToRight

    x

     

    x

    flipLeft

    x

    x

    x

    flipRight

    x

     

    x

    slideToLeft

    x

     

    x

    slideToRight

    x

     

    x

    transitionToLeft

    x

     

    x

    transitionToRight

    x

     

    x

    zoom

    x

     

    x


25.8.4 How to Add Drag and Drop to Thematic Map Components

The ADF Faces framework provides the ability to drag and drop items from one place to another on a page. For thematic maps, area and marker components can be used as a drag source by adding and configuring a child af:dragSource component, and areaLayer components can be used as a drop target by adding and configuring a child af:dropTarget component. For example, you could drag an area representing the population for a state in a USA map and drop it into a table to display the data.

Before you begin:

It may be helpful to have an understanding of how thematic map attributes and thematic map child components can affect functionality. For more information, see Section 25.6.1, "Configuring Thematic Maps."

You should already have a thematic map on your page. If you do not, follow the instructions in this chapter to create a thematic map. For more information, see Section 25.6.4, "How to Add a Thematic Map to a Page."

To use an area or marker as a drag source:

  1. In the Structure window, right-click the area or marker component you are configuring as a drag source, and select insert inside dvt:area or insert inside dvt:marker > Drag source.

  2. In the Property Inspector, specify the actions attribute.

Example 25-13 shows sample code for adding and configuring an area as a drag source.

Example 25-13 Sample Code for Area as a Drag Source

<dvt:area id="area" fillColor="#{tmapTargetActualBean.colorObj}" 
             shortDesc="#{tmapTargetActualBean.tooltip}">
  <af:dragSource actions="COPY" discriminant="DnDDemoModel"/>             
</dvt:area>

To use a map layer as a drop target:

  1. In the Structure window, right-click the areaLayer component you are configuring as a drop target, and select insert inside dvt:areaLayer > Drop target.

  2. Enter an expression for the dropListener that evaluates to a method on a managed bean that will handle the event.

  3. In the managed bean referenced in the EL expression created in Step 2 for the dropListener attribute, create the event handler method (using the same name as in the EL expression) that will handle the drag and drop functionality.

Example 25-14 shows sample code for adding and configuring a map layer as a drop target.

Example 25-14 Sample Code for Area Layer as a Drop Target

<dvt:areaLayer id="areaLayer" layer="states">
  <af:dropTarget actions="COPY"
                    dropListener="#{TestDropHandler.handleCollectionFireDrop}">
    <af:dataFlavor flavorClass="java.util.Collection"/>
  </af:dropTarget>
</dvt:areaLayer>

For more information about adding drag and drop functionality, see Section 33.5, "Adding Drag and Drop Functionality for Components."