TrafficControl class

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Package:

azure-maps-control

A control to display the traffic information of the map.

Extends

ControlBase

Constructors

TrafficControl(TrafficControlOptions)

Constructs a TrafficControl

Methods

buildContainer<K>(Map, ControlStyle, string, K)	Build the outermost container for the control, applies styling including any listeners for auto styling.
getOptions()	Get the TrafficControlOptions
onAdd(Map)	Initialization method for the control which is called when added to the map.
onRemove()	Method that is called when the control is removed from the map. Should perform any necessary cleanup for the control.

Constructor Details

TrafficControl(TrafficControlOptions)

Constructs a TrafficControl

new TrafficControl(options?: TrafficControlOptions)

Parameters

options

TrafficControlOptions

The options for the control.

Method Details

buildContainer<K>(Map, ControlStyle, string, K)

Build the outermost container for the control, applies styling including any listeners for auto styling.

function buildContainer<K>(map: Map, style: ControlStyle, ariaLabel?: string, tagName?: K)

Parameters

map

Map

style

ControlStyle

ariaLabel

string

tagName

K

Returns

HTMLElementTagNameMap[K]

getOptions()

Get the TrafficControlOptions

function getOptions()

Returns

TrafficControlOptions

onAdd(Map)

Initialization method for the control which is called when added to the map.

function onAdd(map: Map)

Parameters

map

Map

The map that the control will be added to.

Returns

HTMLElement

An HTMLElement to be placed on the map for the control.

onRemove()

Method that is called when the control is removed from the map. Should perform any necessary cleanup for the control.

function onRemove()