ScaleControl class

Paquet:

azure-maps-control

Contrôle permettant d’afficher une barre d’échelle sur la carte.

Extends

ControlBase

Constructeurs

ScaleControl(ScaleControlOptions)

Construit un ScaleControl.

Méthodes

onAdd(Map, ControlOptions)	Méthode d’initialisation pour le contrôle appelé lorsqu’il est ajouté à la carte.
onRemove()	Méthode appelée lorsque le contrôle est supprimé de la carte. Doit effectuer tout nettoyage nécessaire pour le contrôle.
setUnit("imperial" | "metric" | "nautical")	Définir l’unité de l’échelle de la distance

Méthodes héritées

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

Créez le conteneur le plus externe pour le contrôle, applique un style, y compris tous les écouteurs pour le style automatique.

Détails du constructeur

ScaleControl(ScaleControlOptions)

Construit un ScaleControl.

new ScaleControl(options?: ScaleControlOptions)

Paramètres

options

ScaleControlOptions

Options du contrôle.

Détails de la méthode

onAdd(Map, ControlOptions)

Méthode d’initialisation pour le contrôle appelé lorsqu’il est ajouté à la carte.

function onAdd(map: Map, options?: ControlOptions): HTMLElement

Paramètres

map

Map

Carte à laquelle le contrôle sera ajouté.

options

ControlOptions

ControlOptions pour ce contrôle.

Retours

HTMLElement

Élément HTMLElement à placer sur la carte pour le contrôle.

onRemove()

Méthode appelée lorsque le contrôle est supprimé de la carte. Doit effectuer tout nettoyage nécessaire pour le contrôle.

function onRemove()

setUnit("imperial" | "metric" | "nautical")

Définir l’unité de l’échelle de la distance

function setUnit(unit: "imperial" | "metric" | "nautical")

Paramètres

unit

"imperial" | "metric" | "nautical"

Unité de la distance ('imperial', 'metric' ou 'nautical').

Détails de la méthode héritée

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

Créez le conteneur le plus externe pour le contrôle, applique un style, y compris tous les écouteurs pour le style automatique.

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

Paramètres

map

Map

style

ControlStyle

ariaLabel

string

tagName

K

Retours

HTMLElementTagNameMap[K]

Hérité deControlBase.buildContainer