SMK / Configuration / Tools

Scale Tool

Adds a scale display to the bottom-right corner of the map. This display shows the current scale, and a ruler showing the real ground distance.

This is default configuration for the Scale tool (click on a property name for more information):

{ "tools": [ {
    "type":       "scale",
    "enabled":    false,
    "showFactor": true
    "showBar":    true
    "showZoom":   false
} ] }

Type Property

"type": String (Required)

The name of the type of this tool. Identifies the tool in the configuration, this is required.

Must be one of these values: "about", "basemaps", "bespoke", "coordinate", "directions", "identify", "layers", "legend", "list-menu", "location", "markup", "measure", "minimap", "pan", "query", "scale", "search", "select", "shortcut-menu", "toolbar", "version", or "zoom".

Enabled Property

"enabled": Boolean

If true then the tool will be available when the map starts. If false, then the tool will not be available.

ShowFactor Property

"showFactor": Boolean

If true, then the scale display shows the scale factor.

ShowBar Property

"showBar": Boolean

If true, then the scale display shows the distance ruler.

ShowZoom Property

"showZoom": Boolean

If true, then the scale display shows the zoom level.