ScaleControl class

  • Referência
Pacote:
azure-maps-control

Um controle para exibir uma barra de escala no mapa.

Extends
ControlBase

Construtores

ScaleControl(ScaleControlOptions)

Constrói um ScaleControl.

Métodos

onAdd(Map, ControlOptions)

Método de inicialização para o controle que é chamado quando adicionado ao mapa.
onRemove()

Método chamado quando o controle é removido do mapa. Deve executar qualquer limpeza necessária para o controle.
setUnit("imperial" | "metric" | "nautical")

Definir a unidade da escala da distância

Métodos herdados

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

Crie o contêiner mais externo para o controle, aplica o estilo, incluindo todos os ouvintes para estilo automático.

Detalhes do construtor

ScaleControl(ScaleControlOptions)

Constrói um ScaleControl.

new ScaleControl(options?: ScaleControlOptions)

Parâmetros

options
ScaleControlOptions

As opções para o controle.

Detalhes do método

onAdd(Map, ControlOptions)

Método de inicialização para o controle que é chamado quando adicionado ao mapa.

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

Parâmetros

map
Map

O mapa ao qual o controle será adicionado.

options
ControlOptions

As ControlOptions para esse controle.

Retornos

HTMLElement

Um HTMLElement a ser colocado no mapa do controle.

onRemove()

Método chamado quando o controle é removido do mapa. Deve executar qualquer limpeza necessária para o controle.

function onRemove()

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

Definir a unidade da escala da distância

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

Parâmetros

unit

"imperial" | "metric" | "nautical"

Unidade da distância ('imperial'ou 'metric''nautical').

Detalhes do método herdado

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

Crie o contêiner mais externo para o controle, aplica o estilo, incluindo todos os ouvintes para estilo automático.

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

Parâmetros

map
Map
style
ControlStyle
ariaLabel

string

tagName

K

Retornos

HTMLElementTagNameMap[K]

Herdado deControlBase.buildContainer