Share via


StyleControl class

Contrôle permettant de modifier le style de la carte.

Extends

Constructeurs

StyleControl(StyleControlOptions)

Construit un StyleControl.

Méthodes

disableStyle(string)

Définir le style dans un état désactivé

enableStyle(string)

Style activé précédemment désactivé

onAdd(Map, ControlOptions)

Méthode d’initialisation pour le contrôle appelé lors de l’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.

setSelectedStyle(string)

Définissez le style qui doit être affiché comme actuellement sélectionné. Le style est automatiquement sélectionné si StyleControlOptions.autoSelectionMode est true

Méthodes héritées

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

Générez le conteneur le plus externe pour le contrôle, applique le style, y compris tous les écouteurs pour le style automatique.

Détails du constructeur

StyleControl(StyleControlOptions)

Construit un StyleControl.

new StyleControl(options?: StyleControlOptions)

Paramètres

options
StyleControlOptions

Options du contrôle.

Détails de la méthode

disableStyle(string)

Définir le style dans un état désactivé

function disableStyle(styleName: string)

Paramètres

styleName

string

Style à désactiver

enableStyle(string)

Style activé précédemment désactivé

function enableStyle(styleName: string)

Paramètres

styleName

string

Style à désactiver

onAdd(Map, ControlOptions)

Méthode d’initialisation pour le contrôle appelé lors de l’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

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

setSelectedStyle(string)

Définissez le style qui doit être affiché comme actuellement sélectionné. Le style est automatiquement sélectionné si StyleControlOptions.autoSelectionMode est true

function setSelectedStyle(styleName: string)

Paramètres

styleName

string

Nom de style qui doit être désactivé comme actuellement sélectionné

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

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

Générez le conteneur le plus externe pour le contrôle, applique le 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