map.md

id	title
map	Map

The map component enables users to display a map on the app. It can be used to display or choose a single location or multiple locations on the map. The map component can be used to display the location of a business, a store, or a restaurant. It can also be used to display the location of a user on the map. It allows users to interact with the map interface and pick specific points of interest.

:::tip Using Self-hosted If you are utilizing the self-hosted version of ToolJet, it is necessary to configure the Google Maps API key as an environment variable. Please refer to the environment variable setup documentation. :::

Properties

Properties	Description	Expected value
Initial location	default location when the app is loaded initially.	An object containing the latitude and langitude as key value pairs. ex: {{ {"lat": 40.7128, "lng": -73.935242} }}
Default Markers	Number of markers that should be shown on the map	An array of objects containing the coordinates. ex: {{ [{"lat": 40.7128, "lng": -73.935242}, {"lat": 40.7128, "lng": -73.935242}] }}
Polygon points	Create a polygon on the map using the given coordinates.	An array of objects containing the coordinates. ex: {{ [{"lat": 40.7128, "lng": -73.935242}, {"lat": 40.7128, "lng": -73.935242}] }}
Add new markers	On clicking the map, a new marker will be added to the map.	By default, it's set to On. Toggle off to disable adding new markers on the map. Click Fx to set {{true}} or {{false}} programmatically.
Search for places	Enable to show the search box on the map.	By default, it's set to On. Toggle off to disable the search box on the map. Click Fx to set {{true}} or {{false}} programmatically.

Events

Event Name	Description
On bounds change	Triggers when the bounding area is modified. This event occurs after the bounds variable changes.
On create marker	Triggers when a new marker is added to the map.
On marker click	Triggers when the user clicks on any of the markers on the map.
On polygon click	Triggers when the user clicks on the polygon on the map.

:::info For detailed information about all the available Actions, please refer to the Action Reference documentation. :::

General

Tooltip

A Tooltip is often used to specify the extra information when the user hovers the mouse pointer over the component. Once a value is set for Tooltip, hovering over the element will display the specified string as the tooltip text.

Layout

Properties	Description	Expected value
Show on desktop	Toggle on or off to display the component in desktop view. You can programmatically determine the value by clicking on Fx to set the value {{true}} or {{false}}.
Show on mobile	Toggle on or off to display the component in mobile view. You can programmatically determine the value by clicking on Fx to set the value {{true}} or {{false}}.

Styles

Properties	Description	Expected value
Visibility	Toggle on or off to control the visibility of the component.	You can programmatically change its value by clicking on the Fx button next to it. If {{false}} the component will not be visible after the app is release. By default, it's set to {{true}}.
Disable	This is off by default, toggle on the switch to lock the component and make it non-functional.	You can also programmatically set the value by clicking on the Fx button next to it. If set to {{true}}, the component will be locked and becomes non-functional. By default, its value is set to {{false}}.
Box shadow	Add a shadow effect to the component by providing values to X, Y, Blur, Spread and Color.	You can also programmatically set the value by clicking on the Fx button next to it. Ex: {{"x": 0, "y": 0, "blur": 0, "spread": 0, "color": "#000000"}}

Exposed Variables

Exposed variables can be used to get data from the component.

Variables	Description
center	This variable will hold the latitude, longitude and the google map url value.
center.lat	This variable holds the latitude value of the marker on the map component. You can access the value dynamically using JS: {{components.map1.center.lat}}
center.lng	This variable gets updated with RGB color code whenever a user selects a color from the color picker. You can access the value dynamically using JS: {{components.map1.center.lng}}
center.googleMapUrl	This variable holds the URL of the location where the center marker is placed on the map component. You can access the value dynamically using JS: {{components.map1.center.googleMapUrl}}
markers	The markers variable will hold the value only if add new markers is enabled from the map properties. Each marker is an object and will have lat and lng keys. Values can be accessed dynamically using {{components.map1.markers[1].lat}}
selectedMarker	Object with the marker selected by the user
bounds	It constructs a rectangle from the points at its south-west and north-east corners
bounds.northEast	It holds the latitude and longitude of the north-east corner of the rectangle. You can access the value dynamically using JS: {{components.map1.bounds.northEast.lat}} or {{components.map1.bounds.northEast.lng}}
bounds.southWest	It holds the latitude and longitude of the south-west corner of the rectangle. You can access the value dynamically using JS: {{components.map1.bounds.southWest.lat}} or {{components.map1.bounds.southWest.lng}}

Component specific actions (CSA)

Following actions of map component can be controlled using the component specific actions(CSA):

Actions	Description
setLocation	Set the marker's location on map using latitude and longitude values as parameteres via a component-specific action within any event handler. Additionally, you have the option to employ a RunJS query to execute component-specific actions such as: component.map1.setLocation(40.7128, -73.935242)