View Heat Map charts in an embedded worksheet

Map charts are used to display maps based on the related data of a worksheet. To view the map chart, select a worksheet for which the:

  • Report source: Embedded
  • Report Type: pivot_editor
  • rv_chart_number: 6.

The rv_map_type parameter is used to display the map chart. However, to ensure that these charts are displayed as required, at least one of these parameters must be specified:

  • rv_map_continent_atrr: Used to define the location attribute that determines the continent to be displayed.
  • rv_map_country_atrr: Used to define the location attribute that determines the country to be displayed.
  • rv_map_province_atrr: Used to define the location attribute to determine the province, that is, state, country and so on.

The location attributes must be populated and enabled in the planning hierarchy:

  • Continent: u (Europe), oc (Oceania), af (Africa), as (Asia), na (North America), sa (South America).
  • Country: ISO short code for country (hckey).
    Note: Some countries can be part of more than one continent map. Therefore, the user must determine the appropriate continent.

Display Settings:

When the map is displayed in the worksheet panel below the pivot table:

  • The chart utilizes the available space after the pivot table, based on rv_pivot_size (pivot table size in pixels). If not defined, the pivot and chart are allotted equal space in the panel.
  • If the panel size is reduced, for example in a multi-panel worksheet, the chart is hidden when the available space in the panel below the pivot table is less than rv_min_chart_size (minimum number of pixels to draw the chart). If rv_min_chart_size is not defined, the default value is 0.
  • If the pivot table is not included (rv_pivot_hide = TRUE), the entire worksheet panel is used to display the chart. The available area is used to retain and fit the map proportions and the rv_fit_panel parameter is ignored.

Functionality and conditions:

  • The Item, Location, and Period dimensions must be displayed on the pivot and not in the slicers area. The Measure dimension can be displayed either in the slicer or pivot area.

    If the rv_pivot_hide = true, by default, the chart is displayed in the slicers area. To hide the dimensions in the slicers area, you must set these dimensions using the rv_slicers_hide parameter.

  • The chart is used to plot the data for each location (rv_chart_rows are ignored):
    • If the locations are displayed in the rows, the values from the first or the selected column are considered.
    • If the locations are displayed in the columns, the values from the first or currently selected row are considered.
    • If a location attribute is applicable for more than one location, the values of all the measures for the locations are summed up and displayed for the appropriate location.

      The map can be used to only plot one set of values (either row or column).

  • If you select a different cell in the grid, the map based on the cross section of period, measure, or item dimensions selected is updated. Selecting a different location does not affect the map, as all locations linked to the grid are considered.
  • If you modify the measure in the slicer area, the selected measure data in the chart is also updated.
  • Based on the defined map type (rv_map_type), the worksheet attempts to plot the data appropriately:
    • Map type = 0 (Best fit), depending on the parameters and the specified data the most appropriate map is populated.
    • Map type = 1 (world), the rv_map_country_attr parameter is required and rv_map_Continent_attr parameter is ignored.
    • Map_type = 2 (world continents), the rv_map_continent_attr parameter is required and the rv_map_Country_attr is ignored.
    • Map_type = 3-8 (individual continent maps), the rv_map_country_attr parameter is required and the rv_map_continent_attr parameter is ignored.
    • Map_type = 9-12, the rv_map_province_attr parameter must be specified. The rv_map_continent_attr and rv_map_country_attr parameters are ignored.
    Note: Values which are outside the range of the chart or are not included in the chart are totaled and displayed as part of the Other Locations seciton at the top of the chart area.
  • If rv_map_type = 0 (Best Fit), the most appropriate chart is used to display the data. This chart encompasses all locations specified in the pivot table.
    • If only rv_map_continent_attr is specified, only the continents map chart can be displayed.
    • If only rv_map_map_country_attr is specified, only the world map can be displayed. Individual continent maps are not applicable as some countries are plotted on more than one continent map).The type of map that must be displayed below the pivot area:
    • Default = 0 or if not defined = Best Fit. However, if rv_map_province_attr and rv_map_country_attr are defined, the map selects the USA map option, if a single country is specified in the rv_map_coutnry_attr parameter.
      • World = 1
      • Continents = 2
      • Africa = 3
      • Asia = 4
      • Oceania = 5
      • Europe = 6
      • North America = 7
      • South America = 8
      • USA = 9
      • Brazil = 10
      • Australia = 11
      • Thailand = 12
    • If both the parameters are defined, the most appropriate map is displayed. However, the rv_continent_attr must only contain a single continent to display the individual continent map. Otherwise, the country map is used.
  • By default, the map displays a heat map with variations in color, depicting the range of values from light (low values) to dark (high values). Use rv_color_palette to define the color palette. If rv_color_palette is not defined, by default, Azure color palette is used. If rv_measure_format is defined then the values specifed for rv_color_palette are not considered.
    • The rv_measure_format can be used to override the rv_color_palette values to determine the color variations in the map, using the highamber, highred, lowamber, lowred, and highlightgreen parameters. For example: 
      <Row name="[SOP_FBAISPER]">
<Property name="format" value="0%" />
<Property name="highamber" value="0.2" /> <Property name="highred" value="0.4" />
<Property name="lowamber" value="-0.2" />
<Property name="lowred" value="-0.4" />
<Property name="highlightgreen" value="TRUE" /> </Row>
    • The locations for each parameter are displayed in the appropriate colours and there is a convergence of colors for each boundary. For example, red to amber, amber to green, and green to red, to indicate a change in the boundary. Based on the example, the highest values (above 40%) are displayed as dark Red, the lowest values (below 40%) as lighter shades of Red, and to shades of Amber.
  • A legend details the series and the corresponding colors. If rv_map_show_title = true, the measure displayed is the title of the map. If rv_map_show_title = false, the measure displayed is the title of the legend. Move the pointer over a location on the map to display a tooltip that details the location, measure, item, period, and the related value.
    • Use rv_legend_position to set the position of the legend. By default, set to the left of the chart. If rv_legend_position = 5 (only applicable for pie and funnel charts), the default rv_legend_position = 1 (Left) is used.
    • If rv_legend_position = 3 (Top), then rv_map_show_title is ignored, and the legend is placed in the title area. The title is displayed as the measure name and the legend bar is displayed below the title. The Other Locations data is also displayed in the title area.
  • Data labels can be hidden from the map (country or location labels) by utilizing the rv_map_show_labels= FALSE. Default value = TRUE.
    Note:  Some locations are not displayed on the map, as this functionality enables the application to select the labels that can be displayed, based on the size and so on. This ensures that a cluttered map is not displayed. You can use the zoom option for the areas to display the additional labels, for the areas.
Related topics