SMK / Configuration / Tools

Search Tool

Add a search input field to the toolbar. The text entered in the input field is used to perform a location search. The results are marked on the map, and displayed in a panel.

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

{ "tools": [ {
    "type":         "search",
    "title":        "Search for Location",
    "showTitle":    false,
    "showPanel":    true,
    "showLocation": true,
    "enabled":      true,
    "icon":         "search",
    "order":        2,
    "position":     "toolbar",
    "command": {
        "identify":   true,
        "measure":    true,
        "directions": true
    }
} ] }

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.

ShowPanel Property

"showPanel": Boolean

If true, then the tool panel will be shown. If false, then the tool panel will not be shown when the tool is active.

ShowLocation Property

"showLocation": Boolean

If true, then the selected search result will be shown as a location panel.

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.

Command Property

"command": Object

Determines which controls are visible on the panels for this tool.

Identify Sub-Property

"command": { "identify": Boolean }

If true, shows a button to do identify at the current search result.

Measure Sub-Property

"command": { "measure": Boolean }

If true, shows a button to start a measurement at the current search result.

Directions Sub-Property

"command": { "directions": Boolean }

If true, shows a button to start a route plan at the current search result.