Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MapToolConfig

Hierarchy

Implemented by

Index

Properties

Properties

Optional closeTitle

closeTitle: string

Optional title for the close tool UI element. Defaults to "Deactivate Tool".

command

command: string

The command to execute after completing the tool.

drawMode

drawMode: string

The mode for drawing on the map.

Optional iconUri

iconUri: string

Optional URI of the icon to display with the status.

Optional isSticky

isSticky: boolean

Whether the tool is sticky. Defaults to false.

Optional keyboardStatusText

keyboardStatusText: string

Optional, alternate status text to display for keyboard users. Can be i18ned.

Optional libraryId

libraryId: string

Library to look up i18n string keys from. Required to display i18n strings.

name

name: string

The name of the tool.

Optional statusClass

statusClass: string

Optional CSS class for the status displayed for this tool.

Optional statusText

statusText: string

Optional status text to display while the tool is active. Can be i18ned.

Optional typeName

typeName: string

Optional type name for the tool being constructed. The default is MapTool.