Edit

Share via

DrawingToolbarOptions interface

  • Reference
Package:
azure-maps-drawing-tools

Options for the DrawingToolbar control.

Properties

buttons

An array of buttons to display in the toolbar. The order of this array will match the order of the buttons in the toolbar. Valid values are any drawing mode except "idle". Default is all drawing modes except "idle".
containerId

The id of a HTML element in which the toolbar should be added to. If not specified, the toolbar will be added to the map.
numColumns

The number of columns to display the buttons with. If the number of columns is greater than or equal to the number of buttons the toolbar will be a single horizontal row. If only one column is used the toolbar will be a single vertical column. Default is Infinity.
position

If the toolbar is added to the map, this value will specify where on the map the toolbar control will be added. Default is atlas.ControlPosition.NonFixed
style

The style of the DrawingToolbar. Possible values are: "light" or "dark". Default is "light".
visible

Specifies if the toolbar is visible or not. Default true.

Property Details

buttons

An array of buttons to display in the toolbar. The order of this array will match the order of the buttons in the toolbar. Valid values are any drawing mode except "idle". Default is all drawing modes except "idle".

buttons?: string[]

Property Value

string[]

containerId

The id of a HTML element in which the toolbar should be added to. If not specified, the toolbar will be added to the map.

containerId?: string

Property Value

string

numColumns

The number of columns to display the buttons with. If the number of columns is greater than or equal to the number of buttons the toolbar will be a single horizontal row. If only one column is used the toolbar will be a single vertical column. Default is Infinity.

numColumns?: number

Property Value

number

position

If the toolbar is added to the map, this value will specify where on the map the toolbar control will be added. Default is atlas.ControlPosition.NonFixed

position?: string

Property Value

string

style

The style of the DrawingToolbar. Possible values are: "light" or "dark". Default is "light".

style?: string

Property Value

string

visible

Specifies if the toolbar is visible or not. Default true.

visible?: boolean

Property Value

boolean