StyleControl class

Pacote:

azure-maps-control

Um controle para alterar o estilo do mapa.

Extends

ControlBase<StyleControlEvents>

Construtores

StyleControl(StyleControlOptions)

Constrói um StyleControl.

Métodos

disableStyle(string)	Definir estilo em um estado desabilitado
enableStyle(string)	Estilo habilitado que foi desabilitado anteriormente
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.
setSelectedStyle(string)	Defina o estilo que precisa ser exibido como selecionado no momento. O estilo será selecionado automaticamente se StyleControlOptions.autoSelectionMode for true

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

StyleControl(StyleControlOptions)

Constrói um StyleControl.

new StyleControl(options?: StyleControlOptions)

Parâmetros

options

StyleControlOptions

As opções para o controle.

Detalhes do método

disableStyle(string)

Definir estilo em um estado desabilitado

function disableStyle(styleName: string)

Parâmetros

styleName

string

Estilo a ser desabilitado

enableStyle(string)

Estilo habilitado que foi desabilitado anteriormente

function enableStyle(styleName: string)

Parâmetros

styleName

string

Estilo a ser desabilitado

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

setSelectedStyle(string)

Defina o estilo que precisa ser exibido como selecionado no momento. O estilo será selecionado automaticamente se StyleControlOptions.autoSelectionMode for true

function setSelectedStyle(styleName: string)

Parâmetros

styleName

string

Nome do estilo que precisa ser desabilitado como selecionado no momento

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