The Map component for Retool Mobile
An embedded map with custom locations.
An embedded map using MapBox to display latitude and longitude coordinates as points of interest. It supports default coordinates and can trigger queries when selecting a point.
Properties
All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
aspectRatio
The ratio of width-to-height (e.g., 1.3 to use 4:3 ratio).
| Type | number |
| Format | Float |
| Configurability | Inspector |
| Default | null |
Examples
1.3
events
A list of configured event handlers that trigger actions or queries.
| Type | array |
| Array values | object |
| Configurability | Inspector > Interaction > Event handlers |
| Default | null |
Array Object Properties
event
The event that triggers the action. Refer to the events section for details of available events for this object.
| Type | string |
| Configurability | Inspector > Interaction > Event handlers > Event |
| Default | null |
method
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
| Type | string |
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Run script actions |
| Default | null |
type
The type of action to perform.
| Type | string | ||||||||||||||
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Action | ||||||||||||||
| Allowed Values |
| ||||||||||||||
| Default | null |
geoJson
GeoJSON objects to display on the map, such as polygons.
| Type | object |
| Configurability | Inspector |
| Default | null |
geoJsonLayerStyle
Mapbox GeoJSON layer styles that override any other applied styling.
| Type | object |
| Configurability | Inspector |
| Default | null |
hidden
Whether this object is hidden from view.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Hidden |
| Default | false |
Examples
true
mapStyle
The Mapbox style to use.
| Type | string | ||||||||||||||||
| Configurability | Inspector | ||||||||||||||||
| Allowed Values |
| ||||||||||||||||
| Default | null |
points
A list of map points to display.
| Type | array |
| Array values | object |
| Configurability | Inspector |
| Default | null |
Array Object Properties
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
map.scrollIntoView()
Scrolls the canvas or parent container so that the selected component appears in the visible area.
map.scrollIntoView(options)
Parameters
Object Properties
behavior
The scroll behavior.
| Type | string | ||||||
| Allowed Values |
|
block
The scroll position relative to the component.
| Type | string | ||||||||||
| Allowed Values |
|
Examples
Scroll the minimum amount to immediately bring map into view.
map.scrollIntoView({behavior: 'auto', block: 'nearest'});
map.setHidden()
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
map.setHidden(hidden)
Parameters
Examples
true
Examples
Hide map.
map.setHidden(true);
Unhide map.
map.setHidden(false);
Events
Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.
| Event | Description |
|---|---|
| Point Pressed | A point of interest is clicked or pressed or pressed. |