ScaleControl class

Пакет:

azure-maps-control

Элемент управления для отображения шкалы на карте.

Extends

ControlBase

Конструкторы

ScaleControl(ScaleControlOptions)

Создает элемент ScaleControl.

Методы

onAdd(Map, ControlOptions)	Метод инициализации для элемента управления, который вызывается при добавлении на карту.
onRemove()	Метод, вызываемый при удалении элемента управления из карты. Должен выполнить необходимую очистку для элемента управления .
setUnit("imperial" | "metric" | "nautical")	Установка единицы шкалы расстояния

Наследуемые методы

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

Создайте внешний контейнер для элемента управления и применит стили, включая прослушиватели для автоматического стиля.

Сведения о конструкторе

ScaleControl(ScaleControlOptions)

Создает элемент ScaleControl.

new ScaleControl(options?: ScaleControlOptions)

Параметры

options

ScaleControlOptions

Параметры элемента управления.

Сведения о методе

onAdd(Map, ControlOptions)

Метод инициализации для элемента управления, который вызывается при добавлении на карту.

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

Параметры

map

Map

Карта, в которую будет добавлен элемент управления.

options

ControlOptions

ControlOptions для этого элемента управления.

Возвращаемое значение

HTMLElement

Элемент HTMLElement, размещающийся на карте элемента управления .

onRemove()

Метод, вызываемый при удалении элемента управления из карты. Должен выполнить необходимую очистку для элемента управления .

function onRemove()

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

Установка единицы шкалы расстояния

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

Параметры

unit

"imperial" | "metric" | "nautical"

Единица расстояния ('imperial'или 'metric''nautical').

Сведения о наследуемом методе

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

Создайте внешний контейнер для элемента управления и применит стили, включая прослушиватели для автоматического стиля.

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

Параметры

map

Map

style

ControlStyle

ariaLabel

string

tagName

K

Возвращаемое значение

HTMLElementTagNameMap[K]

Наследуется отControlBase.buildContainer