ImageSpriteManager interface
Gestionnaire du sprite d’image du contrôle de carte. Exposé par le biais de la propriété imageSprite de l’atlas. Classe Map. Impossible d’instancier l’utilisateur.
Méthodes
add(string, string | HTMLImage |
Ajoutez une image d’icône au sprite d’image de la carte à utiliser avec des symboles et des modèles. |
clear() | Supprime toutes les images ajoutées par l’utilisateur. |
create |
Crée et ajoute une image au sprite d’image de mappage. Indiquez le nom du modèle intégré à utiliser et une couleur à appliquer. Si vous le souhaitez, spécifiez une couleur secondaire si le modèle en prend en charge un. Une échelle peut également être spécifiée. Cela permet au SVG d’être mis à l’échelle avant qu’il ne soit converti en image et donc beaucoup mieux lorsqu’il est mis à l’échelle. Retourne une promesse. Référencez-le dans la couche Polygone ou Symbole. |
get |
Obtient une liste de tous les ID d’image qui ont été ajoutés au sprite d’image de mappage. |
has |
Vérifie si une image est déjà chargée dans le sprite d’image de mappage. |
remove(string) | Supprime une image du sprite d’image de la carte. |
Détails de la méthode
add(string, string | HTMLImageElement | ImageData, StyleImageMetadata)
Ajoutez une image d’icône au sprite d’image de la carte à utiliser avec des symboles et des modèles.
function add(id: string, icon: string | HTMLImageElement | ImageData, meta?: StyleImageMetadata): Promise<void>
Paramètres
- id
-
string
ID de l’image. Si l’ID spécifié correspond à l’ID d’une image précédemment ajoutée, la nouvelle image est ignorée.
- icon
-
string | HTMLImageElement | ImageData
Image à ajouter au sprite de la carte. Il peut s’agir d’un URI de données, d’un SVG inline ou d’une URL d’image.
- meta
- StyleImageMetadata
Options supplémentaires qui décrivent l’image
Retours
Promise<void>
clear()
Supprime toutes les images ajoutées par l’utilisateur.
function clear()
createFromTemplate(string, string, string, string, number)
Crée et ajoute une image au sprite d’image de mappage. Indiquez le nom du modèle intégré à utiliser et une couleur à appliquer. Si vous le souhaitez, spécifiez une couleur secondaire si le modèle en prend en charge un. Une échelle peut également être spécifiée. Cela permet au SVG d’être mis à l’échelle avant qu’il ne soit converti en image et donc beaucoup mieux lorsqu’il est mis à l’échelle. Retourne une promesse. Référencez-le dans la couche Polygone ou Symbole.
function createFromTemplate(id: string, templateName: string, color?: string, secondaryColor?: string, scale?: number): Promise<void>
Paramètres
- id
-
string
ID de l’image. Si l’ID spécifié correspond à l’ID d’une image précédemment ajoutée, la nouvelle image est ignorée.
- templateName
-
string
Nom du modèle à utiliser.
- color
-
string
Valeur de couleur principale. Valeur par défaut : #1A73AA
- secondaryColor
-
string
Valeur de couleur secondaire. Valeur par défaut : blanc
- scale
-
number
Spécifie la quantité à mettre à l’échelle le modèle. Pour obtenir de meilleurs résultats, mettez à l’échelle l’icône à la taille maximale que vous souhaitez afficher sur la carte, puis utilisez l’option de taille d’icône de couches de symboles pour effectuer un scale-down si nécessaire. Cela réduira le flou en raison de la mise à l’échelle. Valeur par défaut : 1
Retours
Promise<void>
getImageIds()
Obtient une liste de tous les ID d’image qui ont été ajoutés au sprite d’image de mappage.
function getImageIds(): string[]
Retours
string[]
hasImage(string)
Vérifie si une image est déjà chargée dans le sprite d’image de mappage.
function hasImage(id: string): boolean
Paramètres
- id
-
string
ID pour lequel vérifier le sprite d’image de la carte.
Retours
boolean
remove(string)
Supprime une image du sprite d’image de la carte.
function remove(id: string)
Paramètres
- id
-
string
ID de l’image à supprimer.