UiControlsOptions

---

Properties

showLegend?

optional showLegend: boolean

Whether or not the legend is shown.

Default Value

true

---

cooperativeGestures?

optional cooperativeGestures: boolean

When co-operative gestures are enabled, the pan and zoom gestures are adjusted to work better when the map is embedded in another page.

Remarks

On mobile devices, enabling co-operative gestures will allow the user to pan past the embedded map with a single finger drag. To pan the map, they must use two fingers.

On desktop devices, enabling co-operative gestures allows the user to scroll past the embedded map using their scroll wheel or trackpad. To zoom the map, they must hold the Ctrl (Windows) or Command key (Mac) while scrolling.

Default Value

true

---

fullScreenButton?

optional fullScreenButton: boolean

Whether or not the full screen button is shown in an embedded map.

Remarks

When clicked, this will open the map in a new tab or window.

Default Value

true

---

geolocation?

optional geolocation: boolean

Whether or not the geolocation button is shown in an embedded map.

Remarks

The geolocation feature will plot your position on the map. If you click the button again, it will start tracking your position.

Default Value

false

---

zoomControls?

optional zoomControls: boolean

Whether or not the zoom controls are shown in an embedded map.

Remarks

This does not affect whether or not the map can be zoomed, just the display of the zoom controls in the bottom right corner of the map.

Default Value

true

---

scaleBar?

optional scaleBar: boolean

Whether or not the scale bar is shown in an embedded map.

Default Value

true