Partager via


IconOptions interface

Options utilisées pour personnaliser les icônes dans un SymbolLayer

Extends

Propriétés

allowOverlap

Spécifie si l’icône de symbole peut superposition d’autres symboles sur la carte. Si true l’icône est visible même si elle se heurte à d’autres symboles dessinés précédemment. Conseil : Définissez cette valeur sur true si vous animez un symbole pour garantir un rendu lisse. Par défaut, false.

anchor

Spécifie quelle partie de l’icône est placée la plus proche de la position d’ancre des icônes sur la carte.

« Centre » : le centre de l’icône est placé le plus proche de l’ancre.

''left'': Le côté gauche de l’icône est placé le plus proche de l’ancre.

« droit » : le côté droit de l’icône est placé le plus proche de l’ancre.

« Top » : le haut de l’icône est placé le plus proche de l’ancre.

''bottom'': Le bas de l’icône est placé le plus proche de l’ancre.

« Haut à gauche » : le coin supérieur gauche de l’icône est placé le plus proche de l’ancre.

« Haut à droite » : le coin supérieur droit de l’icône est placé le plus proche de l’ancre.

' « inférieur gauche » : le coin inférieur gauche de l’icône est placé le plus proche de l’ancre.

' « bas à droite » : le coin inférieur droit de l’icône est placé le plus proche de l’ancre.

Valeur par défaut « bottom » (bas).
ignorePlacement

Spécifie si d’autres symboles peuvent chevaucher ce symbole. Si la valeur est true, d’autres symboles peuvent être visibles même s’ils se heurtent à l’icône. Par défaut, false.

image

Nom de l’image dans le sprite d’image de la carte à utiliser pour dessiner l’icône. Les images intégrées disponibles sont les suivantes : marker-black, , marker-blue, pin-bluepin-darkbluemarker-redmarker-darkbluepin-redpin-round-bluemarker-yellow, , . pin-round-redpin-round-darkblue Par défaut, "marker-blue".

offset

Spécifie une distance de décalage de l’icône à partir de son ancre en pixels. Les valeurs positives indiquent droite et bas, tandis que les valeurs négatives indiquent gauche et haut. Chaque composant est multiplié par la valeur de taille pour obtenir le décalage final en pixels. En cas de combinaison avec rotation, le décalage sera comme si la direction pivotée était vers le haut. Par défaut, [0, 0].

opacity

Nombre compris entre 0 et 1 qui indique l’opacité à laquelle l’icône sera dessinée. Par défaut, 1.

optional

Spécifie si une icône de symboles peut être masquée, mais que son texte s’affiche s’il se chevauche avec un autre symbole. Si la valeur est true, le texte s’affiche sans leurs icônes correspondantes lorsque l’icône entre en collision avec d’autres symboles et que le texte ne le fait pas. Par défaut, false.

padding

Taille de la zone supplémentaire autour de la zone englobante de l’icône utilisée pour détecter les collisions de symboles. Par défaut, 2.

pitchAlignment

Spécifie l’orientation de l’icône lorsque la carte est pitchée.

''auto'': correspond automatiquement à la valeur de 'rotationAlignment'.

« Map » : l’icône est alignée sur le plan de la carte.

'"viewport »: l’icône est alignée sur le plan de la fenêtre d’affichage

Valeur par défaut « auto »
rotation

Montant à faire pivoter l’icône dans le sens de l’horloge en degrés Par défaut 0.

rotationAlignment

En combinaison avec la propriété de placement d’un SymbolLayerOptions, cela détermine le comportement de rotation des icônes.

''auto'': lorsque le placement est « point » cela équivaut à « viewport ». Lorsque le placement est « ligne », cela équivaut à « map ».

'"map"' : lorsque le placement est « point » aligne les icônes est-ouest. Lorsque le placement est « ligne » aligne les axes x des icônes avec la ligne.

'"viewport"' : les axes x des icônes s’alignent sur l’axe x de la fenêtre d’affichage.

Valeur par défaut « auto ».
size

Met à l’échelle la taille d’origine de l’icône par le facteur fourni. Doit être supérieur ou égal à 0. Par défaut, 1.

Détails de la propriété

allowOverlap

Spécifie si l’icône de symbole peut superposition d’autres symboles sur la carte. Si true l’icône est visible même si elle se heurte à d’autres symboles dessinés précédemment. Conseil : Définissez cette valeur sur true si vous animez un symbole pour garantir un rendu lisse. Par défaut, false.

allowOverlap?: boolean

Valeur de propriété

boolean

anchor

Spécifie quelle partie de l’icône est placée la plus proche de la position d’ancre des icônes sur la carte.

« Centre » : le centre de l’icône est placé le plus proche de l’ancre.

''left'': Le côté gauche de l’icône est placé le plus proche de l’ancre.

« droit » : le côté droit de l’icône est placé le plus proche de l’ancre.

« Top » : le haut de l’icône est placé le plus proche de l’ancre.

''bottom'': Le bas de l’icône est placé le plus proche de l’ancre.

« Haut à gauche » : le coin supérieur gauche de l’icône est placé le plus proche de l’ancre.

« Haut à droite » : le coin supérieur droit de l’icône est placé le plus proche de l’ancre.

' « inférieur gauche » : le coin inférieur gauche de l’icône est placé le plus proche de l’ancre.

' « bas à droite » : le coin inférieur droit de l’icône est placé le plus proche de l’ancre.

Valeur par défaut « bottom » (bas).
anchor?: PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

Valeur de propriété

PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

ignorePlacement

Spécifie si d’autres symboles peuvent chevaucher ce symbole. Si la valeur est true, d’autres symboles peuvent être visibles même s’ils se heurtent à l’icône. Par défaut, false.

ignorePlacement?: boolean

Valeur de propriété

boolean

image

Nom de l’image dans le sprite d’image de la carte à utiliser pour dessiner l’icône. Les images intégrées disponibles sont les suivantes : marker-black, , marker-blue, pin-bluepin-darkbluemarker-redmarker-darkbluepin-redpin-round-bluemarker-yellow, , . pin-round-redpin-round-darkblue Par défaut, "marker-blue".

image?: string | DataDrivenPropertyValueSpecification<string>

Valeur de propriété

string | DataDrivenPropertyValueSpecification<string>

offset

Spécifie une distance de décalage de l’icône à partir de son ancre en pixels. Les valeurs positives indiquent droite et bas, tandis que les valeurs négatives indiquent gauche et haut. Chaque composant est multiplié par la valeur de taille pour obtenir le décalage final en pixels. En cas de combinaison avec rotation, le décalage sera comme si la direction pivotée était vers le haut. Par défaut, [0, 0].

offset?: Pixel | DataDrivenPropertyValueSpecification<Pixel>

Valeur de propriété

Pixel | DataDrivenPropertyValueSpecification<Pixel>

opacity

Nombre compris entre 0 et 1 qui indique l’opacité à laquelle l’icône sera dessinée. Par défaut, 1.

opacity?: number | DataDrivenPropertyValueSpecification<number>

Valeur de propriété

number | DataDrivenPropertyValueSpecification<number>

optional

Spécifie si une icône de symboles peut être masquée, mais que son texte s’affiche s’il se chevauche avec un autre symbole. Si la valeur est true, le texte s’affiche sans leurs icônes correspondantes lorsque l’icône entre en collision avec d’autres symboles et que le texte ne le fait pas. Par défaut, false.

optional?: boolean

Valeur de propriété

boolean

padding

Taille de la zone supplémentaire autour de la zone englobante de l’icône utilisée pour détecter les collisions de symboles. Par défaut, 2.

padding?: number | DataDrivenPropertyValueSpecification<number>

Valeur de propriété

number | DataDrivenPropertyValueSpecification<number>

pitchAlignment

Spécifie l’orientation de l’icône lorsque la carte est pitchée.

''auto'': correspond automatiquement à la valeur de 'rotationAlignment'.

« Map » : l’icône est alignée sur le plan de la carte.

'"viewport »: l’icône est alignée sur le plan de la fenêtre d’affichage

Valeur par défaut « auto »
pitchAlignment?: "auto" | "map" | "viewport"

Valeur de propriété

"auto" | "map" | "viewport"

rotation

Montant à faire pivoter l’icône dans le sens de l’horloge en degrés Par défaut 0.

rotation?: number | DataDrivenPropertyValueSpecification<number>

Valeur de propriété

number | DataDrivenPropertyValueSpecification<number>

rotationAlignment

En combinaison avec la propriété de placement d’un SymbolLayerOptions, cela détermine le comportement de rotation des icônes.

''auto'': lorsque le placement est « point » cela équivaut à « viewport ». Lorsque le placement est « ligne », cela équivaut à « map ».

'"map"' : lorsque le placement est « point » aligne les icônes est-ouest. Lorsque le placement est « ligne » aligne les axes x des icônes avec la ligne.

'"viewport"' : les axes x des icônes s’alignent sur l’axe x de la fenêtre d’affichage.

Valeur par défaut « auto ».
rotationAlignment?: "auto" | "map" | "viewport"

Valeur de propriété

"auto" | "map" | "viewport"

size

Met à l’échelle la taille d’origine de l’icône par le facteur fourni. Doit être supérieur ou égal à 0. Par défaut, 1.

size?: number | DataDrivenPropertyValueSpecification<number>

Valeur de propriété

number | DataDrivenPropertyValueSpecification<number>