Map points are generated using data sourced from a Property, Data page, Clipboard page, or Report definition. Information for a specific location is shown in a pop-up when the corresponding map point is clicked or tapped. If you experience issues using the Geolocation functionality, see Troubleshooting Show User Location feature in browsers.

The Address Map control uses the Google Maps service when displaying locations and corresponding information. Refer to the Google Terms of Service for details regarding any region-based or usage restrictions.

Obtaining a Google API key

The Address Map control displays at run time only if you have first obtained a Google API key. For details, see Obtaining the Google API key and Configuring a dynamic system setting for the Map control.

Adding the Address Map control

1. In Dev Studio, pick a control from either the Basic or Advanced menu and drag it to the harness, section, or flow action.
2. Click the View properties icon for the control to display the Cell Properties panel.
3. Click the ChangeOther, and select the pxAddressMap from the autocomplete input field.
4. Configure the control in the fields provided on the General tab and click OK to save your changes.

Customizing map functionality

In the Cell Properties window, the General tab displays various settings for how the map is displayed.

Using the Markers Source section

For list-based sources, data in the Marker info section field runs in the current pin’s context. Additionally, the Applies to class of the Marker info section field must be the same for each record displayed as a pin on the map.

• In a report definition, the applies to class must be the same as the applies to class of a record definition.
• In a data page, the applies to class must be the applies to class of pxResults.
• In a clipboard page/group, the applies to class must be the applies to class of pxResults

The Type menu in the Markers Source section defaults to "None", but you can select one of the following options from the list:

It can either be hardcoded into the field by enclosing coordinates within double quotes, such as:

“42.366200, -71.076936”

or use a property reference, such as:

.OfficeLocation, SomePage.HomeAddress, EmployeeList.pxResults(1).Location

• After specifying the data page to use, the Property for location field must be filled using a list record or by pxResults.
• For data pages, the "Markers Source" section runs in the context of each row.

• The clipboard page can either be an Activity or a Data transform.
• After specifying the clipboard page to use, the Property for location field must be filled using a list record or by pxResults.
• For clipboard pages, the "Markers Source" section runs in the context of each row.

• After specifying the report definition to use, the Property for location field must be filled using a list record.
• For report definitions, the "Markers Source" section runs in the context of each row.

When the Address Map control is sourced from a report definition it can use a value to drive which marker icon to display - so that different locations on the control have different icons. See also Customizing map icons section below.

Optional: If authorized, you can provide a unique Test ID to better support automated testing of your application.

When creating a control that supports you can use a combination of numbers, letters, and underscores, or click the Generate ID button to create a unique ID. The attribute data-test-id is then generated for the selected element.

After the test ID has been generated, you can view your Test ID in HTML or display it in the Live UI panel. You also have the option to have all controls that support Test IDs in a ruleset updated in bulk.

The Test ID is available to access groups that include the PegaRULES:TestID privilege. To disable Test ID, remove the PegaRULES:TestID from the access group.

For instance, if a Text Input control is bound with the Address property and the map also drives its marker from the same property, then:

• when the Text Input value is changed by the user and
• the Text Input control is configured to 'Post value' on change

The Address Map control automatically, via changing tracking, updates the marker pin to display this new location without needing to perform a section refresh. In addition, if the Allow marker repositioning to change address value option is selected, any change in the marker pin by dragging it, triggers an update in the Text Input field automatically without any section refresh.

Customizing map size

In the Cell Properties window, the Presentation tab allows you to select a radio button that sets the height of the map either automatically or with a custom setting. The custom setting (as shown selected below) provides a text field to input a number, along with a menu to select px, em, or %.

Customizing map icons

A user can customize the Address Map control icons to make them consistent with the look and feel of the application and the map. Changing them affects marker icons globally. At design-time a user can also change default marker icons on individual address map instances. For example, it may be useful to show an airport location with an airplane icon and a coffee shop location with a cup icon on the same map displayed in the application.