Map V2 Component

Overview

The Map V2 component is a Charts & Graphs component for displaying a visual map in Express View. Creators can use a Data Reference Key containing an address string to move the map view to the address location and pin it. You can also enable other map features, like Satellite View and Street View.

A Google Map API key is required when using this component. Visit the Google Maps Platform website to obtain a key: https://developers.google.com/maps/documentation/javascript/get-api-key.

The Map V2 component uses a Google Maps API key to access Google's Maps Javascript API and Geocoding APIs. Each API serves a different function:

Maps Javascript API: Displays a map that includes imagery and local data from the same source as Google Maps.

To learn more about the Maps Javascript API, visit the Google APIs Marketplace: https://console.cloud.google.com/marketplace/product/google/maps-backend.googleapis.com.

Geocoding API: Converts an address to a geographic coordinate. The Maps V2 component uses this API when referencing the address in the Data Reference Key field.

To learn more about the Geocoding API, visit the Google APIs Marketplace: https://console.cloud.google.com/marketplace/product/google/geocoding-backend.googleapis.com.

You'll find the Map V2 component in the Charts & Graphs group to the left side of the Module Builder.

About the Configuration Window

To learn more about general component settings, view our General Component Settings article.

Display Settings

Field Text

Setting	Description
Label Text	Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. User-friendly labels make your module more accessible. Keep labels short and descriptive (a word or two) using title case. For longer entries, use sentence case.

Setting

Description

Label Text

Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.

User-friendly labels make your module more accessible. Keep labels short and descriptive (a word or two) using title case. For longer entries, use sentence case.

Default State Options

Setting	Description
Read-Only View	Prevents the map from accepting a Data Reference Key, and prevents end-users from adjusting the map view. Enabling this setting disables the following settings: Make Map Draggable Allow Map Zoom Allow Satelite View Allow Fullscreen View Allow Street View
Hide Field	Displays or hides the component from view. Setting Hide Field to (ON) hides the component in Express View. Setting it to (OFF) displays the component. The component is always visible in the Module Builder. By default, Hide Field is set to (OFF). Reveal a hidden component by using a logic component's Outputs table with the Type set to visible.

Setting

Description

Read-Only View

Prevents the map from accepting a Data Reference Key, and prevents end-users from adjusting the map view.

Enabling this setting disables the following settings:

Make Map Draggable
Allow Map Zoom
Allow Satelite View
Allow Fullscreen View
Allow Street View

Hide Field

Displays or hides the component from view. Setting Hide Field to (ON) hides the component in Express View. Setting it to (OFF) displays the component. The component is always visible in the Module Builder.

By default, Hide Field is set to (OFF).

Reveal a hidden component by using a logic component's Outputs table with the Type set to visible.

Formatting

Setting	Description
Make Map Draggable	Set to (ON) to let end-users adjust the map view when clicking and dragging inside the map view port.
Allow Map Zoom	Set to (checked) to let end-users zoom in or out using ⌘ (Apple Key) + Mousewheel Scroll or ⊞ (Windows Key) + Mousewheel Scroll.
Allow Satelite View	Set to (checked) to insert a two-dimensional map and Satellite imagery buttons to the map view in Express View.
Allow Fullscreen View	Set to (checked) to display a Full Screen button in the top-right corner of the map view in Express View. When end-users click the Full Screen button, the map expands to full-screen view.
Allow Street View	Set to (checked) to insert the (Street View) icon into the bottom-right corner of the map view in Express View. End-Users can click and drag the (Street View) icon onto the map, placing them in the ground-level Street View. Learn more about street view here: https://www.google.com/streetview/.
Multiple Values	Enter a formatted address string for the map to begin on.
Table View	Displays the value in the table view of the submission data.

Setting	Description
Store in Database	The Store Data in Database setting affects how data persists through your application. When set to (ON), Unqork stores values entered into the field to the database (server-side submission). This occurs in three scenarios: Navigating between Panels in a Navigation component. On navigation between pages (Panels), the component’s value saves to the database. Triggering a module save event using a Button component with an Action Type of Save. Navigating between screens of a workflow. On navigation between screens, the component’s value saves to the database. By default, workflows persist data from all fields in the client-side submission when navigating between screens. However, only values from fields with Store Data in Database enabled store in the server-side submission. Set the toggle to (OFF) when you don’t want to store the values from this field in the database. When using a Plug-In to remote execute a module, ensure data moving between modules is persistent. You can optionally enable Store Data in Database for components in the source module. But any components in the API module whose values are included in an API response must have Store Data in Database enabled. When a component’s data is not persistent, the data isn't included in an API call's response. So, Plug-Ins or external services requesting data from the API module can't receive non-persistent data in the response. Store Data in Database also affects what data is tracked using Unqork’s built-in tracker. When the Enable Tracker and Track Value toggles are set to (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked.

Setting	Description
Data Reference Key	Enter the Property ID of the component that contains a formatted address string. If a valid address exists, moves the map view to the address location and places a pin on it. To retrieve an address from an Address Search component, use a Data Workflow Get operator to extract the formatted address.
Google Key	Enter an API key to access Google's Maps API. *This field is required to use the Map V2 component. Acquire an API key here: https://developers.google.com/maps/documentation/javascript/get-api-key. The API Key in this field is hard-coded and cannot be dynamically changed.

Setting	Description
Required	Set to (ON) to make this component required. However, this component does not receive user input and no validation occurs.

Setting	Description
Debounce the Calls After	The number of milliseconds that pass before this component calls the Google Maps API using the Data Reference Key value. If your Data Reference Key dynamically updates, increase the value to reduce the call frequency to the Google Maps API. The default value is 600 ms.

Setting	Description
The Default Location on Browser Load	Enter a formatted address string for the map to begin on.
Default Zoom Level	The map's zoom level based on the location set in The Default Location on Browser Load field. Set a value between 1 (World Map) and 22 (Street Level). The default value is 8.
Point Zoom Level	The level of zoom after Set a value between 1 (World Map) and 22 (Street Level). The default for this setting is 15.
Height of Map, In Pixels or %	Set the height of the map view port in pixels (px). The default value is 400px. This setting accepts only pixel (px) values at this time.
Width of Map, In Pixels or %	Set the width of the map view port in pixels (px) or percentage (%). The default value is 100%.

Setting	Description
Custom CSS Class	Enter a Custom CSS Class to apply to your component. Custom CSS lets you maintain a consistent look and feel when the field or element is part of a template or multiple modules. Updated CSS styling applies to all components that reference this custom class name.

Adding a Map V2 Component

For this example, create a module that lets end-users search for map locations by entering an address into an Address Search component. You need a Google Map API key to configure this module. Visit the Google Maps Platform website to obtain a key: https://developers.google.com/maps/documentation/javascript/get-api-key.

Configure the Address Search Component

First, add an Address Search component, so end-users can enter an address that stores in the Map V2 component.

In the Module Builder, drag and drop an Address Search icon

Address Search component onto the canvas.

In the Property ID field, enter address.

In the Label Text field, enter Address Search.

Under Formatting, set the Show Street, Show City, Show State, and Show Zip toggles to (ON).

Navigate to the Data settings.

From the Select API drop-down, select an available . If you are in the Unqork Training environment, select .

To learn more about Address Search APIs, view our Enabling Address Search Using Address Services article.

Click Save Component.

Configure the Decisions Component

Configure a Decisions component to make the Map V2 component visible and trigger a Data Workflow component to get the address from the Address Search component.

Drag and drop a Decisions Component icon

Decisions component onto the canvas, placing it below the address Address Search icon

Address Search component.

In the Property ID field, enter ruleMap.

In the Label Text field, enter ruleMap.

In the Inputs table, enter the following:

	Source	Alias	Type	Required	Silent
1	address		contains	(checked)	☐ (unchecked)

In the Outputs table, enter the following:

	Property ID	Type
1	dwfFormatAddress	trigger
2	mapAddress	visible

You'll add components configured with the dwfFormatAddress and mapAddress Property IDs in the following steps.

Below the Conditionals table, click New Row.

In the Conditionals table, enter the following:

	address	dwfFormatAddress_trigger	mapAddress_visible
1		yes	yes

Click Save Component.

Configure the Data Workflow Component

The Data Workflow component retrieves the formatted address from the Address Search component. Then, it sends it to a Hidden component, so the Map V2 component can reference it.

Drag and drop a Data Workflow onto the canvas, placing it below the ruleMap Decisions Component icon

Decisions component.

In the Property ID field, enter dwfFormatAddress.

In the Label Text field, enter dwfFormatAddress.

Configure the Input Operator

The Input operator brings the data from the address Address Search icon Address Search component into the Data Workflow.

Drag and drop an Input operator onto your Data Workflow canvas.

Configure the Input operator's Info window as follows:

Info
category	Input
Component	address
required	Yes
source	Default

Configure the Get Operator

The Get operator selects the formatted key from the address Address Search icon Address Search component. The formatted key is an address in a string format.

Drag and drop an Get operator onto your Data Workflow canvas.

Configure the Get operator's Info window as follows:

Info
category	Get
label	formatted
Preserve Argument Type	☐ (unchecked)
Path	formatted

Connect the output port (right) of the address Input operator to the input port (left) of the formatted Get operator.

Configure the Output Operator

The Output operator sends the data to the hiddenAddress icon Hidden component to store it.

Drag and drop an Output operator onto your Data Workflow canvas.

Configure the Output operator's Info window as follows:

Info
category	Output
Component	hiddenAddress
action	value

Connect the output port (right) of the formatted Get operator to the input port (left) of the hiddenAddress Output operator.

Click Save Component.

Your completed Data Workflow looks like the following:

Configure the Hidden Component

The Hidden component stores the formatted address retrieved from the Data Workflow component. The Map V2 component uses the Hidden component as its Data Reference Key for placing a pin on the map view.

Drag and drop a icon

Hidden component onto the canvas, placing it below the dwfFormatAddress Data Workflow component.

In the Property ID field, enter hiddenAddress.

In the Label Text field, enter hiddenAddress.

Click Save Component.

Configure the Map V2 Component

Lastly, configure a Map V2 component for end-users to visualize the address they searched. You'll configure the component to be hidden, using the Decisions component from earlier to make it visible when an end-user enters an address.

Drag and drop a Map V2 component onto the canvas, placing it below the hiddenAddress icon

Hidden component.

In the Property ID field, enter mapAddress.

In the Label field, enter Address.

Set Hide Field to (ON). This setting hides the map view until the end-user enters an address.

In the Data Reference Key field, enter hiddenAddress.

In the Google Key field, enter your Google Maps API key. You can obtain one here: https://developers.google.com/maps/documentation/javascript/get-api-key.

Click Save Component.

Save your module.

Preview your module in Express View. You'll see the following functionality:

Structure of a Map V2 Component's Data

When using a Data Reference Key, the Map V2 component stores the address string in a key and the coordinates in an array. From the previous example, you'll see the following see in Express View and in the DevTools Console:

Here's how a Map V2 component looks in the component configuration view:

Here's how the same Map V2 component looks in the DevTools Console:

Setting	Description
Make Map Draggable	Set to (ON) so end-users can adjust the map view when clicking and dragging inside the map view port.
Allow Map Zoom	Set to (checked) so end-users can zoom in or out using ⌘ (Apple Key) + Mousewheel Scroll or ⊞ (Windows Key) + Mousewheel Scroll.
Allow Satelite View	Set to (checked) to insert a two-dimensional map and Satellite imagery buttons to the map view in Express View.
Allow Fullscreen View	Set to (checked) to display a Full Screen button in the top-right corner of the map view in Express View. When end-users click the Full Screen button, the map expands to full-screen view.
Allow Street View	Set to (checked) to insert the (Street View) icon into the bottom-right corner of the map view in Express View. End-Users can click and drag the (Street View) icon onto the map, placing them in the ground-level Street View. Learn more about street view here: https://www.google.com/streetview/.

Map V2 Component

Overview

About the Configuration Window