Marker

Classe Marker

Classe google.maps.Marker

Cette classe étend MVCObject.

Pour y accéder, appelez const {Marker} = await google.maps.importLibrary("marker"). Consultez Bibliothèques dans 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	Z-index maximal par défaut que l'API attribuera à un repère. Vous pouvez définir un z-index plus élevé pour placer un repère au premier plan.

Méthodes
getAnimation	getAnimation() Paramètres:aucun Valeur renvoyée:  Animation|null|undefined Permet d'obtenir l'animation en cours d'exécution.
getClickable	getClickable() Paramètres:aucun Return Value (Valeur renvoyée) : boolean "True" si le repère est cliquable. Obtenez l'état cliquable de Marker.
getCursor	getCursor() Paramètres:aucun Valeur renvoyée:  string|null|undefined Affiche le type de curseur de la souris qui s'affiche lorsque l'utilisateur pointe sur l'élément.
getDraggable	getDraggable() Paramètres:aucun Return Value (Valeur renvoyée) : boolean "True" si le repère est déplaçable. Obtenez l'état déplaçable de Marker.
getIcon	getIcon() Paramètres:aucun Valeur renvoyée:  string|Icon|Symbol|null|undefined Obtenez l'icône Marker. Consultez les MarkerOptions.icon.
getLabel	getLabel() Paramètres:aucun Valeur renvoyée:  MarkerLabel|string|null|undefined Permet d'obtenir le libellé de Marker. Consultez les MarkerOptions.label.
getMap	getMap() Paramètres:aucun Valeur renvoyée:  Map|StreetViewPanorama Obtenez la carte ou le panaroama sur lequel le Marker est rendu.
getOpacity	getOpacity() Paramètres:aucun Return Value (Valeur renvoyée) : number|null|undefined (nombre compris entre 0,0 et 1,0). Permet d'obtenir l'opacité d'un élément 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 Permet d'obtenir la forme de l'élément Marker utilisé pour l'interaction. Voir MarkerOptions.shape et MarkerShape.
getTitle	getTitle() Paramètres:aucun Valeur renvoyée:  string|null|undefined Récupérez le titre de l'info-bulle Marker. Consultez les MarkerOptions.title.
getVisible	getVisible() Paramètres:aucun Return Value (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 animation à lire. Return Value (Valeur renvoyée) : aucune Lancez une animation. Toute animation en cours sera annulée. Les animations actuellement compatibles sont les suivantes: Animation.BOUNCE et Animation.DROP. La transmission de null entraînera l'arrêt de toute animation.
setClickable	setClickable(flag) Paramètres:  flag:  boolean Si la valeur est true, il est possible de cliquer sur le repère. Return Value (Valeur renvoyée) : aucune Définissez ce paramètre si l'élément Marker est cliquable.
setCursor	setCursor([cursor]) Paramètres:  cursor:  string optional type de curseur de la souris. Return Value (Valeur renvoyée) : aucune Définissez le type de curseur de la souris qui s'affiche lors du survol.
setDraggable	setDraggable(flag) Paramètres:  flag:  boolean optional Si la valeur est true, vous pouvez faire glisser le repère. Return Value (Valeur renvoyée) : aucune Définissez cette valeur si l'élément Marker est déplaçable.
setIcon	setIcon([icon]) Paramètres:  icon:  string|Icon|Symbol optional Return Value (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. Return Value (Valeur renvoyée) : aucune Définissez le libellé pour Marker. Consultez les MarkerOptions.label.
setMap	setMap(map) Paramètres:  map:  Map|StreetViewPanorama Return Value (Valeur renvoyée) : aucune Affiche le Marker sur la carte ou le panorama spécifié. 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). Return Value (Valeur renvoyée) : aucune Définissez l'opacité de votre Marker.
setOptions	setOptions(options) Paramètres:  options:  MarkerOptions Return Value (Valeur renvoyée) : aucune Définissez les options pour Marker.
setPosition	setPosition([latlng]) Paramètres:  latlng:  LatLng|LatLngLiteral optional nouvelle position. Return Value (Valeur renvoyée) : aucune Définissez la postition pour Marker.
setShape	setShape([shape]) Paramètres:  shape:  MarkerShape optional Return Value (Valeur renvoyée) : aucune Définissez la forme de l'élément Marker utilisé pour l'interaction. Voir MarkerOptions.shape et MarkerShape.
setTitle	setTitle([title]) Paramètres:  title:  string optional Return Value (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) Return Value (Valeur renvoyée) : aucune Définissez ce paramètre si Marker est visible.
setZIndex	setZIndex([zIndex]) Paramètres:  zIndex:  number optional Return Value (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é de l'animation Marker est modifiée.
click	function(event) Arguments:  event:  MapMouseEvent Cet événement se déclenche lorsqu'un utilisateur a cliqué sur l'icône Marker.
clickable_changed	function() Arguments:aucun Cet événement est déclenché lorsque la propriété cliquable Marker est modifiée.
contextmenu	function(event) Arguments:  event:  MapMouseEvent Cet événement se déclenche lorsque l'événement du menu contextuel DOM est déclenché sur Marker
cursor_changed	function() Arguments:aucun Cet événement est déclenché lorsque la propriété du curseur Marker est modifiée.
dblclick	function(event) Arguments:  event:  MapMouseEvent Cet événement est déclenché lorsque l'utilisateur a double-cliqué sur l'icône Marker.
drag	function(event) Arguments:  event:  MapMouseEvent Cet événement est déclenché plusieurs fois lorsque l'utilisateur fait glisser Marker.
dragend	function(event) Arguments:  event:  MapMouseEvent Cet événement est déclenché lorsque l'utilisateur cesse de faire glisser le Marker.
draggable_changed	function() Arguments:aucun Cet événement est déclenché lorsque la propriété déplaçable Marker est modifiée.
dragstart	function(event) Arguments:  event:  MapMouseEvent Cet événement est déclenché lorsque l'utilisateur commence à faire glisser Marker.
flat_changed	function() Arguments:aucun Cet événement est déclenché lorsque la propriété plat Marker est modifiée.
icon_changed	function() Arguments:aucun Cet événement est déclenché lorsque la propriété de l'icône Marker est modifiée.
mousedown	function(event) Arguments:  event:  MapMouseEvent Cet événement est déclenché lorsque le curseur de la souris s'affiche sur Marker.
mouseout	function(event) Arguments:  event:  MapMouseEvent Cet événement est déclenché lorsque le curseur de la souris quitte la zone de l'icône Marker.
mouseover	function(event) Arguments:  event:  MapMouseEvent Cet événement est déclenché lorsque l'utilisateur déplace la souris dans la zone de l'icône Marker.
mouseup	function(event) Arguments:  event:  MapMouseEvent Cet événement est déclenché lors du survol de la souris sur 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 est modifiée.
title_changed	function() Arguments:aucun Cet événement est déclenché lorsque la propriété de titre Marker est modifiée.
visible_changed	function() Arguments:aucun Cet événement est déclenché lorsque la propriété visible Marker change.
zindex_changed	function() Arguments:aucun Cet événement est déclenché lorsque la propriété zIndex Marker est modifiée.
rightclick	Obsolète:utilisez plutôt l'événement Marker.contextmenu pour accepter les modèles d'utilisation tels que le raccourci Ctrl-clic sur macOS. function(event) Arguments:  event:  MapMouseEvent Cet événement est déclenché lors d'un clic droit sur Marker.

MarkerOptions.

Interface google.maps.MarkerOptions

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 fenêtre d'informations ouverte avec le repère comme ancrage.
animation optional	Type:Animation optional Par défaut:null Animation à lancer lorsque le 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 AdvancedMarkerElement.collisionBehavior à la place. Avertissement:Disponible uniquement dans la version bêta. 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 est désactivée lorsque l'utilisateur la déplace.
cursor optional	Type:string optional Par défaut:pointer Type de curseur de la souris à afficher lorsque l'utilisateur pointe dessus.
draggable optional	Type:boolean optional Par défaut:false Si la valeur est true, vous pouvez faire glisser le repère.
icon optional	Type:string|Icon|Symbol optional Icône pour le premier plan. Si une chaîne est fournie, elle est traitée comme s'il s'agissait d'un Icon, avec la chaîne 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. L'étiquette peut être une chaîne ou un objet MarkerLabel. Si ce champ est fourni et que MarkerOptions.title n'est pas fourni, un texte d'accessibilité (par exemple, pour une utilisation avec les lecteurs d'écran) est 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 le repère doit être affiché. La carte est requise pour afficher le repère et peut être fournie avec Marker.setMap si elle n'est pas fournie au moment 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 améliore 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
position optional	Type:LatLng|LatLngLiteral optional Définit la position du repère. Un repère peut être construit, mais pas affiché tant que sa position n'est pas indiquée (par les actions ou les choix de l'utilisateur, par exemple). Une position de repère peut être fournie avec Marker.setPosition si elle n'est pas spécifiée au moment de la construction du repère.
shape optional	Type:MarkerShape optional Définition de la région de l'image cliquable utilisée pour le glisser-cliquer.
title optional	Type:string optional Par défaut:undefined Texte de roulement. S'il est fourni, un texte d'accessibilité (par exemple, à utiliser avec les lecteurs d'écran) 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 dans l'ordre de leur zIndex. Les valeurs plus élevées s'affichent devant les repères de valeurs plus faibles. Par défaut, les repères sont affichés en fonction de leur position verticale à l'écran. Les repères inférieurs s'affichent devant les repères plus haut sur l'écran.

Constantes CollisionBehavior

Constantes google.maps.CollisionBehavior

Pour y accéder, appelez const {CollisionBehavior} = await google.maps.importLibrary("marker"). Consultez Bibliothèques dans 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 dont le zIndex est le plus élevé s'affiche. 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	Afficher toujours le repère quelle que soit la collision. Masquez les repères ou libellés OPTIONAL_AND_HIDES_LOWER_PRIORITY qui risquent de chevaucher le repère.

Icon.

Interface google.maps.Icon

Structure représentant une 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 en fonction de l'emplacement du repère sur la carte. Par défaut, l'ancre est située le long du point central de la partie inférieure de l'image.
labelOrigin optional	Type:Point optional L'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 lutin, le cas échéant. Par défaut, l'origine est située dans l'angle supérieur 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 agrandir/rétrécir une image ou un lutin.
size optional	Type:Size optional Taille d'affichage du lutin ou de l'image. Lorsque vous utilisez des sprites, vous devez en spécifier leur taille. Si la taille n'est pas indiquée, elle sera définie lors du chargement de l'image.

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 caractère unique) qui apparaît à 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é (équivalent à 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 traductions 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é (équivalent à la propriété CSS "font-family")
fontSize optional	Type:string optional Par défaut:'14px' Taille de police du texte du libellé (équivalent à la propriété CSS font-size).
fontWeight optional	Type:string optional Épaisseur de police du texte du libellé (équivalent à la propriété CSS "font-weight").

MarkerShape.

Interface google.maps.MarkerShape

Cet objet définit la zone cliquable de l'image d'un repère. La forme est constituée de deux propriétés (type et coord) qui définissent la zone non transparente d'une image.

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

Interface Symbol

Interface google.maps.Symbol

Décrit un symbole, qui consiste en un tracé vectoriel avec un style. Un symbole peut servir d'icône pour un repère ou être placé sur une polyligne.

Propriétés
path	Type:SymbolPath|string Tracé du symbole, qui est un tracé 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 vers 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 couleur par défaut est le 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é de remplissage du symbole.
labelOrigin optional	Type:Point optional Par défaut:google.maps.Point(0,0) Origine du libellé par rapport au point de départ du tracé, si le libellé est fourni par le repère. Le point de départ est exprimé 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 une IconSequence où fixedRotation est false est pivoté par rapport à l'angle du bord sur lequel il s'appuie.
scale optional	Type:number optional Mesure selon laquelle le symbole est mis à l'échelle. Pour les repères de symboles, la valeur par défaut est 1. Après la mise à l'échelle, le symbole peut être de n'importe quelle taille. Pour les symboles sur une polyligne, la valeur par défaut est l'épaisseur du trait de la polyligne. Une fois la mise à l'échelle effectuée, le symbole doit se trouver 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 couleur par défaut est le 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 1. Pour les symboles sur une polyligne, la valeur par défaut correspond à 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

Constantes google.maps.SymbolPath

Chemins de symboles intégrés

Pour y accéder, appelez const {SymbolPath} = await google.maps.importLibrary("core"). Consultez Bibliothèques dans l'API Maps JavaScript.

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

Constantes d'animation

Constantes google.maps.Animation

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.

Pour y accéder, appelez const {Animation} = await google.maps.importLibrary("marker"). Consultez Bibliothèques dans 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 passe du haut de la carte à son emplacement final. L'animation s'arrête une fois que le repère est au repos et Marker.getAnimation renvoie null. Ce type d'animation est généralement spécifié lors de la création du repère.