interface ScaleView

Defines the properties for scale view.

Whenever the map is zoomed in or out, the scale appears and is visible until there are no interactions with the map for at least 5 seconds. The scale view also disappears when the map is tilted or when the scale is out of range.

Range for metric measurement system: 10m-1000km Range for imperial measurement system: 30ft-600mi

Important: This is a Public Preview API. It may be changed or removed at any time.


Link copied to clipboard
abstract var isVisible: Boolean

Defines if the scale should be visible and should react to map scale changes. If set to false, the scale will never appear on the map.

Link copied to clipboard
abstract var margin: Margin

Defines the margin of the view.

Link copied to clipboard
abstract var units: UnitSystem

Defines the scale units. Default value is UnitSystem.AUTO.