ZoomControl 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 for changing the zoom of the map.

Extends

ControlBase

Constructors

ZoomControl(ZoomControlOptions)

Constructs a ZoomControl.

Methods

buildContainer<K>(Map, ControlStyle, string, K)	Build the outermost container for the control, applies styling including any listeners for auto styling.
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

ZoomControl(ZoomControlOptions)

Constructs a ZoomControl.

new ZoomControl(options?: ZoomControlOptions)

Parameters

options

ZoomControlOptions

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]

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()