The Map mobile component
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.
Settings
Map includes the following configurable options when building apps in the IDE.
| Aspect ratioEvent handlersGeoJSONGeoJSON Later StyleShow on desktopShow on mobileLatitudeLongitudeMaintain space when hiddenMap styleMarginPointsAlways show in edit modeStylesZoom |
Properties
All properties for Map 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).
Properties
event
The event type.
Values
change | A user changes the value. |
click | A user clicks or taps the component. |
submit | A user submits the value. |
focus | A user selects the input field. |
blur | A user deselects the input field. |
scan | A user scans a barcode. |
open | A user opens the component. |
close | A user closes the component. |
true | A user sets the value to |
false | A user sets the value to |
select | A user selects a value. |
clear | A user clears the value. |
upload | A user uploads a file. |
parse | An uploaded file is parsed. |
inputValueChange | A user changes the value of the input field. |
method
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
Values
datasource | Control query. |
widget | Control component. |
script | Run script. |
state | Set variable. |
localStorage | Set localStorage. |
util | Perform utility action (e.g., Open URL or Confetti). |
GeoJSON objects to display on the map, such as polygons.
geoJsonLayerStyle
Mapbox GeoJSON layer styles that override any other applied styling.
global
Whether the object is globally scoped for use in all app pages.
id
The unique identifier.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden is true.
The Mapbox style to use.
Values
mapbox://styles/mapbox/streets-v12 | Streets. |
mapbox://styles/mapbox/satellite-v9 | Satellite + Streets. |
mapbox://styles/mapbox/outdoors-v12 | Outdoors. |
mapbox://styles/mapbox/light-v11 | Light. |
mapbox://styles/mapbox/dark-v11 | Dark. |
mapbox://styles/mapbox/navigation-day-v1 | Navigation (Day). |
mapbox://styles/mapbox/navigation-night-v1 | Navigation (Night). |
pluginType
The plugin type.
selectedPoint
The selected point.
showInEditor
Whether to remain visible in the editor if hidden is true.
Methods
JavaScript API methods for interacting with Map. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
scrollIntoView
Scrolls the canvas or parent container so that the selected component appears in the visible area.
map.scrollIntoView(scrollIntoViewOptions)
Parameters
scrollIntoViewOptions
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
The scroll position relative to the component.
Values
nearest | Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view. |
start | Scrolls to position the component at the top of the visible area. |
center | Scrolls to position the component in the middle of the visible area. |
end | Scrolls to position the component at the bottom of the visible area. |
setHidden
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
map.setHidden(hidden)
Parameters
Events
Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.
pointPressed
A point of interest is clicked or pressed.