Adding a Map Portlet

Boundary maps require geographical formatted country, state, or postal code data as part of your marker.

IMPORTANT: You must know the format of the geographical data in the cBase, cPlan, Spectre Dive file, marker, or DivePlan that you are using to create the map. For example if you are mapping the number of sales by State, you need to know if the State dimension value is defined using the State name (New York), or State abbreviation (NY). You enter the format as the Location key in the Edit Map Portlet wizard.

To add a boundary map portlet:

1. In DivePort, browse to the page where you want to add the portlet.

2. On the DivePort toolbar, click Edit to unlock the page and enable edit mode.

   The Edit menu item is replaced with edit tools, including a page context menu chevron.

3. On the toolbar, click the chevron.
4. On the page context menu, click Add a Portlet.

5. On the Add Portlet page, under Data, double-click Map.

   The Edit Map Portlet dialog box opens.

   

6. On the dialog box:

7. In the Street Layer box, select a base map layer. The default, Automatic, selects the Open Street Map.

   TIP: When you select an option from the list, an image of the map appears in the preview section of the dialog box.

8. In the Data Layers box, click Add a layer.

   The Select a layer type dialog box opens.

   

7. Double-click Boundary.

   The Select a data source dialog box opens.

   

8. Browse to the marker that you are using as a data source, select it, and then click Next.

   The Select a location value dialog box opens.

   

9. Double-click the geographical dimension that you want to use.

   NOTE: The values in the geographical dimension must use the same format as the geometry source. These values are case-sensitive. For example, the US Counties source that is included with DivePort uses the format <County,ST> where County is the county name, and ST is the two-letter state abbreviation.

   The Select a geometry source dialog box opens.

   NOTE: The World States-Provinces 50m (Natural Earth).json file contains data for the United States and Canada only. For other parts of the globe, use World States-Provinces 10m (Natural Earth).json.

   

10. Double-click a geometry source that aligns with the location value set in step 9. For example, US Counties.

    The Select a location key dialog box opens.

    

11. Double-click the location key Enter the location key that matches the format of the geographical data in the marker. For example if you are mapping the number of sales by State, you need to know if the State dimension value is defined using the State name (New York), or State abbreviation (NY). as defined in the marker.

    The Select a value dialog box opens.

    

12. Under Numbers, select a value dimension.

    The Layers settings dialog box opens.

    

13. On the dialog box:
14. If you want to customize the label on the legend, enter a name in the Name box.
15. Verify the other settings.
16. If you want to customize the appearance of the boundary layer, click Zoom, Colors, or Labels. For more information, see Customizing the map portlet.

17. Click OK.

    The Street Layer page opens. You can add another layer at this point or customize the map using More settings options.

14. Click OK.

Boundary map example

Line maps require geographical formatted longitude/latitude data for the source and target values.

To add a line map portlet:

1. In DivePort, browse to the page where you want to add the portlet.

2. On the DivePort toolbar, click Edit to unlock the page and enable edit mode.

   The Edit menu item is replaced with edit tools, including a page context menu chevron.

3. On the toolbar, click the chevron.
4. On the page context menu, click Add a Portlet.

5. On the Add Port page, under Data, double-click Map.

   The Edit Map Portlet dialog box opens.

   

6. On the dialog box:

   • In the Street Layer box, select a base layer. The default, Automatic, selects the Open Street Map.

     TIP: When you select an option from the list, an image of the map appears in the preview section of the dialog box.

   • In the Data Layers box, click Add a layer.

     The Select a layer type dialog box opens.

     

7. Double-click Line.

   The Select a data source dialog box opens.

   

8. Browse to the data source that you want to use for the map, select it, and then click Next.

   The Select line ID dialog box opens.

   

9. Double-click a value for the line ID.

   NOTE: This column contains descriptive labels that are used to populate a tooltip that appears when you place your pointer on the line.

   

   The wizard advances to the Select a source location page.

10. Double-click the dimension that you want to use for the beginning of the line.

    The wizard advances to the Select a target location page.

11. Double-click the dimension that you want to use for the end of the line.

    The wizard advances to the Layer settings page.

12. Under Line Settings, select Straight or Curved.

    NOTE: A curved line shows a bi-directional route. You can specify the angle of the curve by degrees in the range of -45 to 45. Zero degrees draws a straight line.

13. Optionally, enter a line Thickness, Point Shape, and Point size.

14. If you want to customize the appearance of the point layer, click Zoom, Colors, or Labels. For more information, see Customizing the map portlet.

15. Click OK.

The Street Layer page opens. You can add another layer at this point or customize the map using More settings options.

Line map example

Point maps require geographical formatted longitude/latitude data in your data source.

To add a point map portlet:

1. In DivePort, browse to the page where you want to add the portlet.

2. On the DivePort toolbar, click Edit to unlock the page and enable edit mode.

   The Edit menu item is replaced with edit tools, including a page context menu chevron.

3. On the toolbar, click the chevron.
4. On the page context menu, click Add a Portlet.

5. On the Add Port page, under Data, double-click Map.

   The Edit Map Portlet dialog box opens.

   

6. On the dialog box:

   • In the Street Layer box, select a base layer. The default, Automatic, selects the Open Street Map.

     TIP: When you select an option from the list, an image of the map appears in the preview section of the dialog box.

   • In the Data Layers box, click Add a layer.

     The Select a layer type dialog box opens.

     

7. Double-click Point.

   The Select a data source dialog box opens.

   

8. Browse to the marker, Spectre dive file, cPlan, cBase, or DiveBook that you want to use for the map, select it, and then click Next.

   The Select a location value dialog box opens.

    

   

9. To use a location string, under Strings, double-click a geographical dimension in the format longitude/latitude.

   NOTE: Column data that contains longitude and latitude coordinates must be formatted as <longitude> <latitude> and the dimension name must be longlat. For example:

   

   NOTE: In DivePort 7.1(25) and later, you can use separate latitude and longitude columns to specify the location. If you choose this option, you must also select a Location ID, which is used to send data in click actions.

   The Select a value dialog box opens.

   

10. Under Numbers, double-click a numeric dimension.

    The Layer settings dialog box opens.

    

11. On the dialog box:

    • If you want to customize the label on the legend, enter a name in the Name box.
    • If you want to combine data points into clusters, select Cluster points with descriptor. You can specify a tooltip for the cluster in the descriptor box.

    • Select a shape for the data points. The default is Triangle. Other options are Circle, Square, and Icon. If you select Icon, you are prompted for an Icon Source.

      NOTE: You can use custom icons that are placed in the \webdata\<diveport>\doc-libraries\Portal Media\images folder. On the map, icons assume the size of the source image.

    • Verify the other settings.
    • If you want to customize the appearance of the point layer, click Display, Data polling Available in 7.1(19) or later, Colors, Legends and Labels, or Points (Advanced). For more information, see Customizing the map portlet.

    • Click OK.

      The Street Layer page opens. You can add another layer at this point or customize the map using More settings options.

Point map example

NOTE: Point maps with clustering enabled, that also use custom icons, display all clusters as a circle shape while single points render as the specified icon.

Heat maps require geographical formatted longitude/latitude data in your marker.

To add a heat map portlet:

1. In DivePort, browse to the page where you want to add the portlet.

2. On the DivePort toolbar, click Edit to unlock the page and enable edit mode.

   The Edit menu item is replaced with edit tools, including a page context menu chevron.

3. On the toolbar, click the chevron.
4. On the page context menu, click Add a Portlet.

5. On the Add Portlet page, under Data, double-click Map.

   The Edit Map Portlet dialog box opens.

   

6. On the dialog box:

7. In the Street Layer box, select a base layer. The default, Automatic, selects the Open Street Map.

   TIP: When you select an option from the list, an image of the map appears in the preview section of the dialog box.

8. In the Data Layers box, click Add a layer.

   The Select a layer type dialog box opens.

   

7. Double-click Heat.

   The Select a data sourcedialog box opens.

   

8. Browse to the marker that you want to use for the map, select it, and then click Next.

   The Select a location valuedialog box opens.

9. 

9. Under Strings, double-click a location value. The format of this value must be longitude/latitude.

   The Select a valuedialog box opens.

   

10. Under Numbers, double-click a dimension value.

    The Layer settingsdialog box opens.

    

11. On the dialog box:
12. If you want to give the layer a name, enter a name in the Name box.
13. Under Heat settings, set the Radius (in meters of each data point) and Blur factor (higher blur factors display smoother gradients) for the heat map.
14. Verify the other settings.
15. If you want to customize the appearance of the heat layer, click Zoom or Colors. For more information, see Customizing the map portlet.

16. Click OK.

    The Street Layer page opens. You can add another layer at this point or customize the map using More settings options.

TIP: Heat maps do not have a legend option. DI recommends that you add a text indicator to inform users about the type of data that is shown on the map.

Hexbin maps require geographical formatted longitude/latitude data.

To add a hexbin map portlet:

1. In DivePort, browse to the page where you want to add the portlet.

2. On the DivePort toolbar, click Edit to unlock the page and enable edit mode.

   The Edit menu item is replaced with edit tools, including a page context menu chevron.

3. On the toolbar, click the chevron.
4. On the page context menu, click Add a Portlet.

5. On the Add Portlet page, under Data, double-click Map.

   The Edit Map Portlet dialog box opens.

   

6. On the dialog box:

7. In the Street Layer box, select a base layer. The default, Automatic, selects the Open Street Map.

   TIP: When you select an option from the list, an image of the map appears in the preview section of the dialog box.

8. In the Data Layers box, click Add a layer.

   The Select a layer type dialog box opens.

   

7. Select Hexbin, and then click Next.

   The Select a data source dialog box opens.

8. Do one of the following:

   • Select Use latitude and longitude columns, and then specify the columns in the latitude and longitude boxes respectively.

   • Select Use a location string, and in under Strings, double-click a location value.

   The Select a value page opens

9. Under Numbers, double-click a dimension value.

   The Layer settings dialog box opens.

10. On the dialog box:
11. If you want to give the layer a name, enter a name in the Name box.
12. Verify the other settings.
13. If you want to customize the appearance of the hexbin layer, under More settings click the option settings that you care to customize. For more information, see Customizing the map portlet.

14. Click OK.

    The Street Layer page opens. You can add another layer at this point or customize the map using More settings options.

To create a web service map portlet:

1. In DivePort, browse to the page where you want to add the portlet.

2. On the DivePort toolbar, click Edit to unlock the page and enable edit mode.

   The Edit menu item is replaced with edit tools, including a page context menu chevron.

3. On the toolbar, click the chevron.
4. On the page context menu, click Add a Portlet.

5. On the Add Port page, under Data, double-click Map.

   The Edit Map Portlet dialog box opens.

   

6. In the Data Layers box, click Add a layer.

   The Select a layer type dialog box opens.

   

7. Double-click Web Map Service.

   The Layer setting dialog box opens.

   

8. Consider naming the layer for clarification and organization, especially when working with multiple layers on a portlet. Under Layer settings, enter a name in the Name box.

9. Under WMS settings, enter the URL of the web mapping service that you want to use in the format:

   URL?<attribute1>=<value>&<attribute2>=<value>&

   Note the following:

   • The URL must begin with https
   • Attributes can be appended to the URL in the format <attribute>=<value>&
   • Pipe characters cannot be used as attribute separators
   • The URL must end with a question mark (?) if there are no attributes, or an ampersand (&) if there are attributes— this is because DivePort adds more parameters after the end.

10. Select a WMS Layer Name.

11. If you want to customize the appearance of the WMS layer, click Zoom. For more information, see Customizing the map portlet.

12. Click OK.

TIP: WMS maps do not have a legend option. DI recommends that you add a text indicator to inform users about the type of data that is shown on the map.

Customizing the map portlet

Two of the pages in the Edit Map Portlet wizard provide an opportunity to customize the map portlet:

• The Layer Settings dialog box has options that vary, depending on the map type.

  

• The Street Layer dialog box has options that are common to all map portlets.

  

Layer settings

Zoom—Click to open the Layer zoom settings dialog box, which you can use to show or hide the layer and define the zoom range. Clear the Visible box to hide the data layer.

Data polling—Applies to point maps in DivePort 7.1(19) and later. Click to open the Data polling settings dialog box, which you can use to enable data polling and specify an interval. This option is used to provide real-time updates to the data points.

Colors—Applies to boundary, heat, line, and point maps. Click to open the Layer color settings dialog box, which you can use to specify colors used to define numeric data.

• Show legend—Applies to border and point maps. Select to include a legend on the map.

  

• Use gradient legend—Applies to border and point maps. Select to include a gradient legend on the map.

  

• Legend Bins—Applies to border and point maps with a legend. Select the number of bins (bars) on the map legend. The default is 12. Other options are 1 through 11.
• Low Color—The color at the low end of the scale. The default is blue.
• Mid Color—The color at the middle of the scale. The default is green.
• High Color—The color at the top of the scale. The default is red.
• Layer Opacity—The opaqueness of the layer. The default is 0.5. Lower numbers are more transparent.
• Scale Min—Specifies the low end of the scale.
• Scale Max—Specifies the high end of the scale.

Labels—Applies to boundary, line, and point maps. Click to open the Layer label settings dialog box, which you can use to add or customize the labels that appear on the map.

• Display region in label—Applies to boundary maps only. Select if you want the region location value to display on the map.
• Display summary in label—Applies to boundary maps only. Select if you want the numeric data to display on the map.
• Alternate Region Label—Enter a column to display its value in place of the region value.
• NOTE: The Alternate Region Label value is also used for the tooltip that appears on the map when the pointer is placed on a specific area or point.

• Label Format—Enter a format for the numeric data that appears in the label. The default, Automatic, uses the format specified in the marker. For more information, see Formatting Numeric Values.
• Min Zoom Level for Display—Applies to border maps only. Specifies the zoom level at which the data labels appear. When a user zooms in or out, the label layer displays when the current zoom level is greater than or equal to this setting.

Points (Advanced)—Applies to point maps only. Click to open the Advanced point settings dialog box, which you can use to customize the appearance of points.

• Point Size—Sets the data points to a constant size in pixels or scales the point size based on a scale from a specified data column. The default is 5 px.
• Min Size—Applies when the point size is set to a data column. Specifies the size of the smallest data points.
• Max Size—Applies when the point size is set to a data column. Specifies the size of the largest data points.
• Point Opacity—Set the opaqueness of the points. The default is 0.9. Lower numbers are more transparent. You can also specify a data column to scale the point opaqueness based on a scale from that column.
• Enable data points animation—Available if data polling is enabled. Uses animation to update the map.
• Destination—Specifies the longlat coordinates for the destination location.

Street Layer

Position—Click to open the Initial map position settings dialog box, which you can use to specify the initial map view.

• Click the dialog box map and use a drag operation to move the map until it shows the area that you want to display. The Initial Latitude and Initial Longitude boxes adjust automatically to identify the center of the map.
• On the upper left corner of the map, press + or – to zoom in or out. Alternatively, you can enter an integer in the Initial Zoom box. Higher zoom levels show higher resolution and a smaller area. Zoom level 0 shows a view of the earth.
• Select Preserve user position of data change If you want the map to retain user-selected position or zoom level values after a QuickView is applied.
• Click OK.

Extent—Click to open the Map extent settings dialog box, which you can use to restrict the users ability to change the map view.

Lock map to position—Select to disable the zoom and click-and-drag capability.

Zoom in on the map until the preview shows the maximum view that you want users to see. This automatically sets the minimum and maximum values for Latitude and Longitude and minimum Zoom. Along with maximum Zoom, these values can also be set manually.

Click Actions—Select to open the Click Actions dialog box, which you can use to add, edit or remove click actions on the portlet. For more information, see About Click Actions.