Map

The map object displays a map with markers.

Attributes

Common

ID

Sets the object's ID.

The ID identifies the object and is used to reference it in UISet actions, allowing to change its attributes dynamically.

The ID is not unique, it can be shared among multiple objects to quickly change a common attribute.

IDs can't be changed with a UISet action, but they can have a Value Binding assigned to them. Value Bindings on IDs allow an object to be dynamically attached to a set of attribute values.

E.g. the following Value Binding switches the ID of the object between mybutton1 and mybutton2 based on the value of the UISet button.address:

Value binding:

"mybutton" + ui('button', 'address')

UISet:

UISet('button', 'address', '1') switches the ID to mybutton1

UISet('button', 'address', '2') switches the ID to mybutton2

Position and Size

Position

Sets the object's position.

Attribute Values

Value	Description	Example
x<left>y<top>	Specify left/top coordinates in pixels.	x10y20

This attribute is available when parent's layout is neither "flex" nor "grid".

When parent's layout is neither "flex" nor "grid", this attribute defaults to x0y0.

Flex Grow

Specifies if the objects should grow to fill the available space.

Attribute Values

Value	Description
false	Default value. Objects do not grow to fill the available space.
true	Objects expand to fill the available space.

This attribute is available when parent's layout is "flex".

The default value is: false.

Flex Shrink

Specifies if the objects should shrink to fit the available space.

Attribute Values

Value	Description
false	Default value. Objects do not shrink to fit the available space.
true	Objects shrink to fit the available space.

This attribute is available when parent's layout is "flex".

The default value is: false.

Column

Specifies the starting column of the object inside a grid container.

Minimum value is 1.

Attribute Values

Value	Description
<int>	Column index starting from 1.

This attribute is available when parent's layout is "grid".

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Column Span

Specifies how many grid columns the object spans.

Minimum value is 1.

Attribute Values

Value	Description
<int>	Column span starting from 1.

This attribute is available when parent's layout is "grid".

When parent's layout is "grid", this attribute defaults to 1.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Row

Specifies the starting row of the object inside a grid container.

Minimum value is 1.

Attribute Values

Value	Description
[empty]	Auto placement by the grid.
<int>	Row index starting from 1.

This attribute is available when parent's layout is "grid".

When parent's layout is "grid", this attribute defaults to auto.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Row Span

Specifies how many grid rows the object spans.

Minimum value is 1.

Attribute Values

Value	Description
<int>	Row span starting from 1.

This attribute is available when parent's layout is "grid".

When parent's layout is "grid", this attribute defaults to 1.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Width

Sets the object's width in pixels.

Minimum value is 120.

Height

Sets the object's height in pixels.

Minimum value is 80.

Data

Data Mode

Specifies the mode used to populate the markers.

Attribute Values

Value	Description
items	Default value. Markers are set with the Markers attribute.
datasource	Markers are set by a linked datasource.

The default value is: items.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Markers

Specifies the marker items.

Attribute Values

Value	Description
<JSON Array>	Marker items.

This attribute is available when datamode is "items".

Datasource ID

Specifies the datasource ID used to populate markers.

Attribute Values

Value	Description
<string>	ID of the datasource.

This attribute is available when datamode is "datasource".

Data Map

Specifies how to map datasource columns to marker properties.

This attribute is available when datamode is "datasource".

View

Center

Specifies the map center in lat,lng format.

Attribute Values

Value	Description	Example
<string>	Center coordinates.	45.07,7.69

Zoom

Specifies the map zoom level.

Attribute Values

Value	Description	Example
<int>	Zoom level.	6

Pitch

Specifies the map pitch (0-85) for tilted/3D view.

Attribute Values

Value	Description	Example
<int>	Pitch angle.	45

The default value is: 0.

Zoom Enabled

Enables zoom interaction controls.

Attribute Values

Value	Description
true	Default value. Zoom enabled.
false	Zoom disabled.

The default value is: true.

Map Options

Pan Enabled

Enables map panning.

Attribute Values

Value	Description
true	Default value. Pan enabled.
false	Pan disabled.

The default value is: true.

Auto Fit

Automatically fits the map to the markers.

Attribute Values

Value	Description
true	Auto fit enabled.
false	Default value. Auto fit disabled.

The default value is: false.

Style

Style Preset

Specifies the MapLibre style preset.

Attribute Values

Value	Description
theme	Default value. Theme Adaptive (project colors).
light	Shortbread Light.
dark	Shortbread Dark.
contrast	Shortbread High Contrast.
blueprint	Shortbread Blueprint.
custom	Custom MapLibre style URL.

The default value is: theme.

Labels Enabled

Shows or hides map labels (streets, places, boundaries, water).

Attribute Values

Value	Description
true	Default value. Labels enabled.
false	Labels disabled.

This attribute is available when stylepreset is not "custom".

When stylepreset is not "custom", this attribute defaults to true.

Label Language

Selects the label language when available.

Attribute Values

Value	Description
local	Default value. Local labels.
en	English labels.

This attribute is available when stylepreset is not "custom" and labelsenabled is "true".

When stylepreset is not "custom" and labelsenabled is "true", this attribute defaults to local.

Road Names Enabled

Shows or hides street name labels.

Attribute Values

Value	Description
true	Default value. Road names enabled.
false	Road names disabled.

This attribute is available when stylepreset is not "custom" and labelsenabled is "true".

When stylepreset is not "custom" and labelsenabled is "true", this attribute defaults to true.

Addresses Enabled

Shows or hides address number labels.

Attribute Values

Value	Description
true	Addresses enabled.
false	Default value. Addresses disabled.

This attribute is available when stylepreset is not "custom" and labelsenabled is "true".

When stylepreset is not "custom" and labelsenabled is "true", this attribute defaults to false.

Roads Enabled

Shows or hides road geometry.

Attribute Values

Value	Description
true	Default value. Roads enabled.
false	Roads disabled.

This attribute is available when stylepreset is not "custom".

When stylepreset is not "custom", this attribute defaults to true.

Railways Enabled

Shows or hides railway geometry.

Attribute Values

Value	Description
true	Default value. Railways enabled.
false	Railways disabled.

This attribute is available when stylepreset is not "custom".

When stylepreset is not "custom", this attribute defaults to true.

Water Enabled

Shows or hides seas, lakes, rivers, and water lines.

Attribute Values

Value	Description
true	Default value. Water enabled.
false	Water disabled.

This attribute is available when stylepreset is not "custom".

When stylepreset is not "custom", this attribute defaults to true.

Nature Enabled

Shows or hides parks and natural areas.

Attribute Values

Value	Description
true	Default value. Nature enabled.
false	Nature disabled.

This attribute is available when stylepreset is not "custom".

When stylepreset is not "custom", this attribute defaults to true.

Buildings Enabled

Shows or hides building footprints.

Attribute Values

Value	Description
true	Default value. Buildings enabled.
false	Buildings disabled.

This attribute is available when stylepreset is not "custom".

When stylepreset is not "custom", this attribute defaults to true.

Buildings 3D Enabled

Shows or hides 3D building extrusion.

Attribute Values

Value	Description
true	3D buildings enabled.
false	Default value. 3D buildings disabled.

This attribute is available when stylepreset is not "custom" and buildingsenabled is "true".

When stylepreset is not "custom" and buildingsenabled is "true", this attribute defaults to false.

POI Enabled

Shows or hides points of interest.

Attribute Values

Value	Description
true	POI enabled.
false	Default value. POI disabled.

This attribute is available when stylepreset is not "custom".

When stylepreset is not "custom", this attribute defaults to false.

Transit Enabled

Shows or hides transit-related geometry and markers.

Attribute Values

Value	Description
true	Transit enabled.
false	Default value. Transit disabled.

This attribute is available when stylepreset is not "custom".

When stylepreset is not "custom", this attribute defaults to false.

Boundaries Enabled

Shows or hides administrative boundaries.

Attribute Values

Value	Description
true	Default value. Boundaries enabled.
false	Boundaries disabled.

This attribute is available when stylepreset is not "custom".

When stylepreset is not "custom", this attribute defaults to true.

Style URL

Specifies a custom MapLibre style URL (style.json).

Attribute Values

Value	Description	Example
<string>	Style URL.	https://example.com/style.json

This attribute is available when stylepreset is "custom".

Panel

Panel

Shows a panel that frames the object. Its style can be modified.

Attribute Values

Value	Description
true	Default value. Shows the panel.
false	Hides the panel.

The default value is: true.

View

Visible

Sets the object's visibility.

Attribute Values

Value	Description
true	Default value. Visible.
false	Hidden.

The default value is: true.

Enabled

Specifies if the object is enabled or disabled. A disabled object appears as grayed out and can't be interacted with.

Attribute Values

Value	Description
true	Default value. Enabled.
false	Disabled.

The default value is: true.

Blink

Blinks the object at the specified speed.

Attribute Values

Value	Description
false	Default value. Not blinking.
slow	Blinks slowly.
fast	Blinks fast.

The default value is: false.

Transition

Specifies the transition effect when the object is shown or hidden.

Attribute Values

Value	Description
none	Default value. No transition.
fade	Fade in/out.
fade-left	Slide from left and fade in/out.
fade-right	Slide from right and fade in/out.
fade-up	Slide from top and fade in/out.
fade-down	Slide from bottom and fade in/out.
slide-left	Slide from left.
slide-right	Slide from right.
slide-up	Slide from top.
slide-down	Slide from bottom.
zoom-in	Zoom in.
zoom-out	Zoom out.
3d-flip-left	3D flip from left.
3d-flip-right	3D flip from right.

The default value is: none.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Transition Duration

Specifies the transition duration in milliseconds.

Attribute Values

Value	Description
<integer>	Duration in milliseconds.

This attribute is available when transition is not "none".

When transition is not "none", this attribute defaults to 300.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Transition Delay

Specifies the transition delay in milliseconds.

Attribute Values

Value	Description
<integer>	Delay in milliseconds.

This attribute is available when transition is not "none".

When transition is not "none", this attribute defaults to 0.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Opacity

Sets the object's opacity. Opacity is the degree to which content behind an object is hidden.

Attribute Values

Value	Description
0	The object is fully transparent.
>0.0, <1.0	The object is translucent (content behind the element can be seen).
1.0	Default value. The object is fully opaque.

The default value is: 1.0.

Rotation

Specifies the degrees by which the object is rotated. A positive number rotates it clockwise, while a negative value rotates it counter-clockwise.

The default value is: 0.

CSS Class

Specifies a CSS Class that applies to the object, useful to customize its appearance. Custom CSS Classes are specified within the custom.css file.

Margin

Specifies the margin of the object. The margin is the space outside the object's border.

Attribute Values

Value	Description	Example
<int>	Specify the margin in pixels for all sides of the object.
<top> <right> <bottom> <left>	Specify the margin in pixels for each side of the object.	10 20 30 40

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

View Scale

Specifies the scale of the object. The scale is the ratio between the object's size and the size of the view it is contained in.

Attribute Values

Value	Description
<float>	Specify the scale for both width and height of the object.

The default value is: 1.0.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Meta

Comment

Specifies a comment, visible only in the Project Editor. It can be used to add a note or a tag to the object. The filter in the object's SELECT panel applies to the comment as well.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Exclude

Excludes the object from the UI. Useful to temporarily hide an object without deleting it. Different from the "Visible" attribute, which hides the object in the UI but keeps it in the project, allowing it to be shown again with a UISet.

Attribute Values

Value	Description
false	Default value. Object is included in the UI.
true	Object is excluded from the UI.

The default value is: false.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.