SMK / Configuration / Tools

BaseMaps Tool

Add a button to the toolbar, that shows a panel which lets the user choose which base map they want the map to use. A list of base maps to choose from is also displayed. If there is a need to restrict the set of base maps the user can choose from, then set the choices property.

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

{ "tools": [ {
    "type":     "baseMaps",
    "title":    "Base Maps",
    "showTitle":false,
    "enabled":  false,
    "icon":     "map",
    "order":    3,
    "position": [ "shortcut-menu", "list-menu", "toolbar" ],
    "mapStyle": { width: '110px', height: '110px' },
    "choices":  null,
} ] }

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

Title Property

"title": String

The title of this tool. Tools that display a panel will use this as the title of the panel. The toolbar button for this tool will use this as the tooltip. Tools have a default title, and setting this property will override the default title with one of the author’s choosing.

ShowTitle Property

"showTitle": Boolean

If true, then the title of the tool is shown beside the button in the toolbar. Defaults to false.

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.

Icon Property

"icon": String

If the tool adds a button to a toolbar, this property gives the name of the icon to display on the button. The icon set used is the Material Design Icons.

Order Property

"order": Integer

If the tool adds a button to a toolbar, this property controls the order in which the tools are added to the toolbar. The default value is 1, but some tools have other values as their default. The tools are added left-to-right in ascending order.

Position Property

"position": String

Some tools show a button that activates the tool, and that button must be positioned in one of the tool button containers. The tool button containers are: toolbar, list-menu, and shortcut-menu. This property’s value is the name of the container, or null to prevent button from appearing. The tool button container must itself be enabled.

MapStyle Property

"mapStyle": Object

This is an object containing CSS properties, which is used to style the map sample tiles in the base map chooser panel.

Choices Property

"choices": Array

The list of base maps to let the user choose from. If the list is empty, all base maps will be available.