Marker (legacy)

Classe Marker

Classe google.maps.Marker

Obsolète : depuis le 21 février 2024, google.maps.Marker est obsolète. Veuillez plutôt utiliser la ou les colonnes "AdvancedMarkerElement". Pour le moment, l'arrêt de google.maps.Marker n'est pas prévu, mais AdvancedMarkerElement est recommandé à la place de google.maps.Marker. Bien que google.maps.Marker continue de recevoir des correctifs pour les régressions majeures, les bugs existants dans google.maps.Marker ne seront pas résolus. Vous recevrez une notification au moins 12 mois avant la fin de la prise en charge. Pour en savoir plus, consultez https://developers.google.com/maps/deprecations et https://developers.google.com/maps/documentation/javascript/advanced-markers/migration pour le guide de migration.

Cette classe étend MVCObject.

Accédez-y en appelant le const {Marker} = await google.maps.importLibrary("marker").
 Consultez Bibliothèques de l'API Maps JavaScript.

Constructeur
Marker	Marker([opts]) Paramètres : opts : MarkerOptions optional arguments facultatifs nommés Crée un repère avec les options spécifiées. Si une carte est spécifiée, le repère y est ajouté lors de la construction. Notez que la position doit être définie pour que le repère s'affiche.

Constantes
MAX_ZINDEX	Valeur maximale par défaut du z-index que l'API attribuera à un repère. Vous pouvez définir un z-index plus élevé pour faire passer un repère au premier plan.

Méthodes
getAnimation	getAnimation() Paramètres : aucun Valeur renvoyée : Animation|null|undefined Obtenez l'animation en cours d'exécution.
getClickable	getClickable() Paramètres : aucun Valeur renvoyée : boolean "True" si le repère est cliquable. Obtenez l'état cliquable du Marker.
getCursor	getCursor() Paramètres : aucun Valeur renvoyée : string|null|undefined Obtenez le type de curseur de la souris affiché au survol.
getDraggable	getDraggable() Paramètres : aucun Valeur renvoyée : boolean "True" si le repère est déplaçable. Obtenez l'état déplaçable du Marker.
getIcon	getIcon() Paramètres : aucun Valeur renvoyée : string|Icon|Symbol|null|undefined Obtenez l'icône de Marker. Consultez les MarkerOptions.icon.
getLabel	getLabel() Paramètres : aucun Valeur renvoyée : MarkerLabel|string|null|undefined Obtenez le libellé de Marker. Consultez les MarkerOptions.label.
getMap	getMap() Paramètres : aucun Valeur renvoyée : Map|StreetViewPanorama Obtenez la carte ou le panorama sur lequel le Marker est affiché.
getOpacity	getOpacity() Paramètres : aucun Valeur renvoyée : number|null|undefined, un nombre compris entre 0,0 et 1,0. Obtenez l'opacité de Marker.
getPosition	getPosition() Paramètres : aucun Valeur renvoyée : LatLng|null|undefined Obtenez la position de Marker.
getShape	getShape() Paramètres : aucun Valeur renvoyée : MarkerShape|null|undefined Obtenez la forme du Marker utilisé pour l'interaction. Consultez les MarkerOptions.shape et l'MarkerShape.
getTitle	getTitle() Paramètres : aucun Valeur renvoyée : string|null|undefined Obtenez le titre de l'info-bulle Marker. Consultez les MarkerOptions.title.
getVisible	getVisible() Paramètres : aucun Valeur renvoyée : boolean "True" si le repère est visible. Obtenez la visibilité de Marker.
getZIndex	getZIndex() Paramètres : aucun Valeur renvoyée : number|null|undefined zIndex du repère. Obtenez le zIndex de Marker. Consultez les MarkerOptions.zIndex.
setAnimation	setAnimation([animation]) Paramètres : animation : Animation optional L'animation à lire. Valeur renvoyée : aucune Lancez une animation. Toute animation en cours sera annulée. Les animations actuellement disponibles sont les suivantes : Animation.BOUNCE, Animation.DROP. Si vous transmettez null, toute animation s'arrête.
setClickable	setClickable(flag) Paramètres : flag : boolean Si la valeur est true, l'utilisateur peut cliquer sur le repère. Valeur renvoyée : aucune Indique si Marker est cliquable.
setCursor	setCursor([cursor]) Paramètres : cursor : type de curseur de la souris string optional. Valeur renvoyée : aucune Définissez le type de curseur de la souris affiché au passage de la souris.
setDraggable	setDraggable(flag) Paramètres : flag : boolean optional Si la valeur est true, le repère peut être déplacé. Valeur renvoyée : aucune Définissez si Marker est déplaçable.
setIcon	setIcon([icon]) Paramètres : icon : string|Icon|Symbol optional Valeur renvoyée : aucune Définissez l'icône pour Marker. Consultez les MarkerOptions.icon.
setLabel	setLabel([label]) Paramètres : label : string|MarkerLabel optional Le libellé peut être une chaîne de caractères ou un objet MarkerLabel. Valeur renvoyée : aucune Définissez le libellé pour Marker. Consultez les MarkerOptions.label.
setMap	setMap(map) Paramètres : map : Map|StreetViewPanorama Valeur renvoyée : aucune Affiche Marker sur la carte ou le panorama spécifiés. Si la carte est définie sur null, le repère sera supprimé.
setOpacity	setOpacity([opacity]) Paramètres : opacity : number optional nombre compris entre 0,0 (transparent) et 1,0 (opaque). Valeur renvoyée : aucune Définissez l'opacité de Marker.
setOptions	setOptions(options) Paramètres : options : MarkerOptions Valeur renvoyée : aucune Définissez les options pour Marker.
setPosition	setPosition([latlng]) Paramètres : latlng : LatLng|LatLngLiteral optional nouvelle position. Valeur renvoyée : aucune Définissez la position de Marker.
setShape	setShape([shape]) Paramètres : shape : MarkerShape optional Valeur renvoyée : aucune Définissez la forme du Marker utilisé pour l'interaction. Consultez les MarkerOptions.shape et l'MarkerShape.
setTitle	setTitle([title]) Paramètres : title : string optional Valeur renvoyée : aucune Définissez le titre de l'info-bulle Marker. Consultez les MarkerOptions.title.
setVisible	setVisible(visible) Paramètres : visible : boolean. Si la valeur est true, le repère est visible. Valeur renvoyée : aucune Défini si Marker est visible.
setZIndex	setZIndex([zIndex]) Paramètres : zIndex : number optional Valeur renvoyée : aucune Définissez le zIndex de Marker. Consultez les MarkerOptions.zIndex.
Hérité : addListener, bindTo, get, notify, set, setValues, unbind, unbindAll

Événements
animation_changed	function() Arguments : aucun Cet événement est déclenché lorsque la propriété d'animation Marker change.
click	function(event) Arguments :  event : MapMouseEvent Cet événement est déclenché lorsque l'icône Marker est sélectionnée.
clickable_changed	function() Arguments : aucun Cet événement est déclenché lorsque la propriété cliquable Marker change.
contextmenu	function(event) Arguments :  event : MapMouseEvent Cet événement est déclenché lorsque l'événement contextmenu du DOM est déclenché sur le Marker.
cursor_changed	function() Arguments : aucun Cet événement est déclenché lorsque la propriété de curseur Marker change.
dblclick	function(event) Arguments :  event : MapMouseEvent Cet événement est déclenché lorsque l'utilisateur double-clique sur l'icône Marker.
drag	function(event) Arguments :  event : MapMouseEvent Cet événement est déclenché à plusieurs reprises lorsque l'utilisateur fait glisser Marker.
dragend	function(event) Arguments :  event : MapMouseEvent Cet événement est déclenché lorsque l'utilisateur arrête de faire glisser le Marker.
draggable_changed	function() Arguments : aucun Cet événement est déclenché lorsque la propriété déplaçable Marker change.
dragstart	function(event) Arguments :  event : MapMouseEvent Cet événement est déclenché lorsque l'utilisateur commence à faire glisser le Marker.
flat_changed	function() Arguments : aucun Cet événement est déclenché lorsque la propriété plate Marker change.
icon_changed	function() Arguments : aucun Cet événement est déclenché lorsque la propriété d'icône Marker change.
mousedown	function(event) Arguments :  event : MapMouseEvent Cet événement est déclenché lorsqu'un clic gauche est effectué sur Marker.
mouseout	function(event) Arguments :  event : MapMouseEvent Cet événement est déclenché lorsque la souris quitte la zone de l'icône Marker.
mouseover	function(event) Arguments :  event : MapMouseEvent Cet événement est déclenché lorsque la souris entre dans la zone de l'icône Marker.
mouseup	function(event) Arguments :  event : MapMouseEvent Cet événement est déclenché lorsqu'un bouton de la souris est relâché sur le Marker.
position_changed	function() Arguments : aucun Cet événement est déclenché lorsque la propriété de position Marker change.
shape_changed	function() Arguments : aucun Cet événement est déclenché lorsque la propriété de forme Marker change.
title_changed	function() Arguments : aucun Cet événement est déclenché lorsque la propriété de titre Marker change.
visible_changed	function() Arguments : aucun Cet événement est déclenché lorsque la propriété visible de Marker change.
zindex_changed	function() Arguments : aucun Cet événement est déclenché lorsque la propriété zIndex de Marker change.
rightclick	Obsolète : utilisez l'événement Marker.contextmenu à la place pour prendre en charge les schémas d'utilisation tels que le contrôle-clic sur macOS. function(event) Arguments :  event : MapMouseEvent Cet événement est déclenché lorsqu'un utilisateur effectue un clic droit sur Marker.

Interface MarkerOptions

Interface google.maps.MarkerOptions

Obsolète : depuis le 21 février 2024, google.maps.Marker est obsolète. Veuillez plutôt utiliser google.maps.marker.AdvancedMarkerElement. Pour en savoir plus sur l'abandon, consultez https://developers.google.com/maps/deprecations. Pour obtenir le guide de migration, consultez https://developers.google.com/maps/documentation/javascript/advanced-markers/migration.

Objet MarkerOptions utilisé pour définir les propriétés pouvant être définies sur un repère.

Propriétés
anchorPoint optional	Type : Point optional Décalage entre la position du repère et l'extrémité d'une InfoWindow ouverte avec le repère comme point d'ancrage.
animation optional	Type : Animation optional Par défaut : null Animation à lire lorsqu'un repère est ajouté à une carte.
clickable optional	Type : boolean optional Par défaut : true Si la valeur est true, le repère reçoit les événements tactiles et de souris.
collisionBehavior optional	Obsolète : collisionBehavior est obsolète depuis juillet 2023. Utilisez plutôt AdvancedMarkerElement.collisionBehavior. Remarque : Disponible uniquement dans le canal v=beta. Type : string|CollisionBehavior optional Par défaut : null Définissez le comportement en cas de collision pour les repères sur les cartes vectorielles.
crossOnDrag optional	Type : boolean optional Par défaut : true Si la valeur est false, la croix qui s'affiche sous le repère lors du déplacement est désactivée.
cursor optional	Type : string optional Par défaut : pointer Type de curseur de la souris à afficher au pointage.
draggable optional	Type : boolean optional Par défaut : false Si la valeur est true, le repère peut être déplacé. Remarque : Si vous définissez ce paramètre sur true, le repère sera cliquable même si clickable est défini sur false.
icon optional	Type : string|Icon|Symbol optional Icône du premier plan. Si une chaîne est fournie, elle est traitée comme s'il s'agissait d'un Icon avec la chaîne comme url.
label optional	Type : string|MarkerLabel optional Par défaut : null Ajoute un libellé au repère. Un libellé de repère est une lettre ou un nombre affiché à l'intérieur d'un repère. Le libellé peut être une chaîne ou un objet MarkerLabel. Si ce champ est renseigné et que MarkerOptions.title ne l'est pas, un texte d'accessibilité (par exemple, pour les lecteurs d'écran) sera ajouté au repère avec le texte du libellé fourni. Veuillez noter que label n'est actuellement utilisé que pour le texte d'accessibilité des repères non optimisés.
map optional	Type : Map|StreetViewPanorama optional Carte sur laquelle afficher le repère. La carte est nécessaire pour afficher le repère. Elle peut être fournie avec Marker.setMap si elle ne l'a pas été lors de la construction du repère.
opacity optional	Type : number optional Par défaut : 1.0 Nombre compris entre 0.0 (transparent) et 1.0 (opaque).
optimized optional	Type : boolean optional L'optimisation permet d'améliorer les performances en affichant de nombreux repères sous la forme d'un seul élément statique. Cette fonctionnalité est utile lorsqu'un grand nombre de repères est requis. En savoir plus sur l'optimisation des repères Remarque : Cette optimisation n'a aucun effet sur les repères des cartes vectorielles.
position optional	Type : LatLng|LatLngLiteral optional Définit la position du repère. Un repère peut être construit, mais ne pas être affiché tant que sa position n'est pas fournie (par exemple, par les actions ou les choix d'un utilisateur). Une position de repère peut être fournie avec Marker.setPosition si elle n'est pas fournie lors de la construction du repère.
shape optional	Type : MarkerShape optional Définition de la région de la carte d'image utilisée pour le glisser-déposer/cliquer.
title optional	Type : string optional Par défaut : undefined Texte de roulement. Si un texte d'accessibilité (par exemple, à utiliser avec des lecteurs d'écran) est fourni, il sera ajouté au repère avec la valeur fournie. Veuillez noter que title n'est actuellement utilisé que pour le texte d'accessibilité des repères non optimisés.
visible optional	Type : boolean optional Par défaut : true Si la valeur est true, le repère est visible.
zIndex optional	Type : number optional Tous les repères sont affichés sur la carte par ordre de zIndex, les valeurs plus élevées s'affichant devant les repères ayant des valeurs plus faibles. Par défaut, les repères sont affichés en fonction de leur position verticale à l'écran. Les repères situés plus bas apparaissent devant ceux situés plus haut.

Constantes CollisionBehavior

google.maps.CollisionBehavior constantes

Accédez-y en appelant le const {CollisionBehavior} = await google.maps.importLibrary("marker").
 Consultez Bibliothèques de l'API Maps JavaScript.

Constantes
OPTIONAL_AND_HIDES_LOWER_PRIORITY	Le repère s'affiche uniquement s'il n'en chevauche pas d'autres. Si deux repères de ce type se chevauchent, celui avec le z-index le plus élevé est affiché. S'ils ont le même zIndex, celui dont la position verticale à l'écran est la plus basse est affiché.
REQUIRED	Le repère s'affiche toujours, quelle que soit la collision. Il s'agit du comportement par défaut.
REQUIRED_AND_HIDES_OPTIONAL	Toujours afficher le repère, quelle que soit la collision, et masquer les repères ou libellés OPTIONAL_AND_HIDES_LOWER_PRIORITY qui le chevauchent.

Interface Icône

Interface google.maps.Icon

Structure représentant une image d'icône de repère.

Propriétés
url	Type : string URL de l'image ou de la feuille de sprites.
anchor optional	Type : Point optional Position à laquelle ancrer une image par rapport à l'emplacement du repère sur la carte. Par défaut, l'ancrage se trouve au centre de la partie inférieure de l'image.
labelOrigin optional	Type : Point optional Origine du libellé par rapport à l'angle supérieur gauche de l'image de l'icône, si un libellé est fourni par le repère. Par défaut, l'origine est située au centre de l'image.
origin optional	Type : Point optional Position de l'image dans un sprite, le cas échéant. Par défaut, l'origine est située en haut à gauche de l'image (0, 0).
scaledSize optional	Type : Size optional Taille de l'image entière après mise à l'échelle, le cas échéant. Utilisez cette propriété pour étirer ou réduire une image ou un sprite.
size optional	Type : Size optional Taille d'affichage du sprite ou de l'image. Lorsque vous utilisez des sprites, vous devez spécifier leur taille. Si la taille n'est pas fournie, elle sera définie lors du chargement de l'image.

Interface MarkerLabel

Interface google.maps.MarkerLabel

Ces options spécifient l'apparence d'un libellé de repère. Un libellé de repère est une chaîne (souvent un seul caractère) qui s'affiche à l'intérieur du repère. Si vous l'utilisez avec un repère personnalisé, vous pouvez le repositionner avec la propriété labelOrigin dans la classe Icon.

Propriétés
text	Type : string Texte à afficher dans le libellé.
className optional	Type : string optional Par défaut : '' (chaîne vide) Propriété className de l'élément du libellé (équivalente à l'attribut class de l'élément). Vous pouvez ajouter plusieurs classes CSS séparées par des espaces. La couleur, la taille, l'épaisseur et la famille de la police ne peuvent être définies que via les autres propriétés de MarkerLabel. Les classes CSS ne doivent pas être utilisées pour modifier la position ni l'orientation du libellé (par exemple, à l'aide de translations et de rotations) si vous utilisez également la gestion des collisions de repères.
color optional	Type : string optional Par défaut : 'black' Couleur du texte du libellé.
fontFamily optional	Type : string optional Famille de polices du texte du libellé (équivalente à la propriété CSS "font-family").
fontSize optional	Type : string optional Par défaut : '14px' Taille de police du texte du libellé (équivalente à la propriété CSS font-size).
fontWeight optional	Type : string optional Épaisseur de police du texte du libellé (équivalente à la propriété CSS font-weight).

Interface MarkerShape

Interface google.maps.MarkerShape

Cet objet définit la région cliquable d'une image de repère. La forme se compose de deux propriétés (type et coord) qui définissent la région non transparente d'une image.

Propriétés
type	Type : string Décrit le type de forme et peut être circle, poly ou rect.
coords optional	Type : Array<number> optional Le format de cet attribut dépend de la valeur de type et suit la spécification w3 AREA coords disponible sur http://www.w3.org/TR/REC-html40/struct/objects.html#adef-coords. L'attribut coords est un tableau d'entiers qui spécifie la position en pixels de la forme par rapport au coin supérieur gauche de l'image cible. Les coordonnées dépendent de la valeur de type comme suit :   - circle : coords est [x1,y1,r] où x1,y2 sont les coordonnées du centre du cercle et r est le rayon du cercle.   - poly : coords est [x1,y1,x2,y2...xn,yn], où chaque paire x,y contient les coordonnées d'un sommet du polygone.   - rect : coords est [x1,y1,x2,y2], où x1,y1 sont les coordonnées de l'angle supérieur gauche du rectangle et x2,y2 sont les coordonnées de l'angle inférieur droit du rectangle.

Interface Symbol

Interface google.maps.Symbol

Décrit un symbole, qui se compose d'un tracé vectoriel avec un style. Un symbole peut être utilisé comme icône de repère ou placé sur une polyligne.

Propriétés
path	Type : SymbolPath|string Le tracé du symbole, qui est un tracé de symbole intégré ou un tracé personnalisé exprimé au format SVG. Obligatoire.
anchor optional	Type : Point optional Par défaut : google.maps.Point(0,0) Position du symbole par rapport au repère ou à la polyligne. Les coordonnées du tracé du symbole sont traduites vers la gauche et le haut par les coordonnées x et y de l'ancre, respectivement. La position du symbole est exprimée dans le même système de coordonnées que son tracé.
fillColor optional	Type : string optional Couleur de remplissage du symbole. Toutes les couleurs CSS3 sont compatibles, à l'exception des noms de couleurs étendus. Pour les repères de symboles, la valeur par défaut est "black" (noir). Pour les symboles sur des polylignes, la couleur par défaut est celle du trait de la polyligne correspondante.
fillOpacity optional	Type : number optional Par défaut : 0 Opacité du remplissage du symbole.
labelOrigin optional	Type : Point optional Par défaut : google.maps.Point(0,0) Origine du libellé par rapport à l'origine du chemin d'accès, si le libellé est fourni par le repère. L'origine est exprimée dans le même système de coordonnées que le tracé du symbole. Cette propriété n'est pas utilisée pour les symboles sur les polylignes.
rotation optional	Type : number optional Par défaut : 0 Angle de rotation du symbole, exprimé en degrés dans le sens des aiguilles d'une montre. Un symbole dans un IconSequence où fixedRotation est false est pivoté par rapport à l'angle du bord sur lequel il s'appuie.
scale optional	Type : number optional Quantité par laquelle la taille du symbole est ajustée. Pour les repères de symboles, la valeur par défaut est 1. Après l'ajustement, le symbole peut avoir n'importe quelle taille. Pour les symboles sur une polyligne, cette valeur correspond par défaut à l'épaisseur du trait de la polyligne. Après la mise à l'échelle, le symbole doit tenir dans un carré de 22 pixels centré sur l'ancre du symbole.
strokeColor optional	Type : string optional Couleur du trait du symbole. Toutes les couleurs CSS3 sont compatibles, à l'exception des noms de couleurs étendus. Pour les repères de symboles, la valeur par défaut est "black" (noir). Pour les symboles sur une polyligne, la couleur par défaut est celle du trait de la polyligne.
strokeOpacity optional	Type : number optional Opacité du trait du symbole. Pour les repères de symboles, la valeur par défaut est de 1. Pour les symboles sur une polyligne, la valeur par défaut est l'opacité du trait de la polyligne.
strokeWeight optional	Type : number optional Valeur par défaut : Symbol.scale du symbole. Épaisseur du trait du symbole.

Constantes SymbolPath

google.maps.SymbolPath constantes

Chemins de symboles intégrés.

Accédez-y en appelant le const {SymbolPath} = await google.maps.importLibrary("core").
 Consultez Bibliothèques de l'API Maps JavaScript.

Constantes
BACKWARD_CLOSED_ARROW	Flèche fermée pointant vers l'arrière
BACKWARD_OPEN_ARROW	Flèche ouverte pointant vers l'arrière
CIRCLE	Cercle
FORWARD_CLOSED_ARROW	Flèche fermée pointant vers l'avant.
FORWARD_OPEN_ARROW	Flèche ouverte pointant vers l'avant

Constantes Animation

google.maps.Animation constantes

Animations pouvant être lues sur un repère. Utilisez la méthode Marker.setAnimation sur Marker ou l'option MarkerOptions.animation pour lire une animation.

Accédez-y en appelant le const {Animation} = await google.maps.importLibrary("marker").
 Consultez Bibliothèques de l'API Maps JavaScript.

Constantes
BOUNCE	Le repère rebondit jusqu'à ce que l'animation soit arrêtée en appelant Marker.setAnimation avec null.
DROP	Le repère tombe du haut de la carte sur son lieu final. L'animation s'arrête une fois que le repère est au repos et Marker.getAnimation reprend la valeur null. Ce type d'animation est généralement spécifié à la création du repère.