ScaleControl class
Um controlo para apresentar uma barra de dimensionamento no mapa.
- Extends
Construtores
Scale |
Constrói um ScaleControl. |
Métodos
on |
Método de inicialização para o controlo que é chamado quando adicionado ao mapa. |
on |
Método chamado quando o controlo é removido do mapa. Deve efetuar qualquer limpeza necessária para o controlo. |
set |
Definir a unidade da escala da distância |
Métodos Herdados
build |
Crie o contentor mais externo para o controlo, aplica estilo, incluindo quaisquer serviços de escuta 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 controlo.
Detalhes de Método
onAdd(Map, ControlOptions)
Método de inicialização para o controlo que é chamado quando adicionado ao mapa.
function onAdd(map: Map, options?: ControlOptions): HTMLElement
Parâmetros
- map
- Map
O mapa ao qual o controlo será adicionado.
- options
- ControlOptions
ControlOptions para este controlo.
Devoluções
HTMLElement
Um HTMLElement a ser colocado no mapa do controlo.
onRemove()
Método chamado quando o controlo é removido do mapa. Deve efetuar qualquer limpeza necessária para o controlo.
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 contentor mais externo para o controlo, aplica estilo, incluindo quaisquer serviços de escuta 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
Devoluções
HTMLElementTagNameMap[K]
Herdado deControlBase.buildContainer