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.

Map

Settings

Map includes the following configurable options when building apps in the IDE.

Content	GeoJSONGeoJSON Later StyleLatitudeLongitudePoints
Interaction	Event handlers
Appearance	Aspect ratioHiddenShow on desktopShow on mobileMaintain space when hiddenMap styleMarginAlways 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

number

The ratio of width-to-height (e.g., 1.3 to use 4:3 ratio).

events

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event

enum

The event type.

Values

0

A user changes the value.

1

A user clicks or taps the component.

2

A user submits the value.

3

A user selects the input field.

4

A user deselects the input field.

5

A user scans a barcode.

6

A user opens the component.

7

A user closes the component.

8

A user sets the value to true.

9

A user sets the value to false.

10

A user selects a value.

11

A user clears the value.

12

A user uploads a file.

13

An uploaded file is parsed.

14

A user changes the value of the input field.

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 true.
false	A user sets the value to false.
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

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

type

enum

The type of action to perform.

Values

0

Control query.

1

Control component.

2

Run script.

3

Set variable.

4

Set localStorage.

5

Perform utility action (e.g., Open URL or Confetti).

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

object

GeoJSON objects to display on the map, such as polygons.

geoJsonLayerStyle

object

Mapbox GeoJSON layer styles that override any other applied styling.

hidden

boolean

Whether the component is visible.

id

string

The name.

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

latitude

number

The latitudinal position.

longitude

number

The longitudinal position.

maintainSpaceWhenHidden

boolean

Whether the component takes up space on the canvas if hidden is true.

mapStyle

enum

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).

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

pluginType

string

The plugin type.

points

object[]

A list of map points to display.

Properties

color

string

The color with which to render.

id

string

The unique identifier for the point.

latitude

number

The latitudinal position.

longitude

number

The longitudinal position.

selectedPoint

object

The selected point.

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

style

object

Custom style options in use. Not all style options may be available for all components.

zoom

number

The zoom level for the map, from 0 (whole world) to 16.

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

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

block

enum

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

hidden

boolean

Whether the component is visible.

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 user clicks or presses a point of interest.