Marker

Classe de Marker

Classe google.maps.Marker

Cette classe étend MVCObject.

Accédez au compte en appelant const {Marker} = await google.maps.importLibrary("marker"). Consultez Bibliothèques dans l'API Maps JavaScript.
Marker
Marker([opts])
Paramètres:
Crée un repère avec les options spécifiées. Si une carte est spécifiée, le repère est ajouté à la carte lors de sa construction. Notez que la position doit être définie pour que le repère s'affiche.
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
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
Permet d'afficher le type de curseur de souris associé à la souris.
getDraggable
getDraggable()
Paramètres:aucun
Return Value (Valeur de retour) : 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 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 la vue panoramique sur laquelle le rendu de Marker est effectué.
getOpacity
getOpacity()
Paramètres:aucun
Valeur renvoyée:number|null|undefined 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. Voir MarkerOptions.shape et 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
Return Value (Valeur de retour) : boolean est "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.
Permet d'obtenir le zIndex de Marker. Consultez les MarkerOptions.zIndex.
setAnimation
setAnimation([animation])
Paramètres:
  • animation:  Animation optional animation à lire.
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îne l'arrêt de toute animation.
setClickable
setClickable(flag)
Paramètres:
  • flag:  boolean si la valeur est true, vous pouvez cliquer sur le repère.
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 souris.
Valeur renvoyée:aucune
Définissez le type de curseur de la souris affiché en pointant.
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 ce paramètre si l'élément Marker est déplaçable.
setIcon
setIcon([icon])
Paramètres:
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:
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 est 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 la Marker.
setOptions
setOptions(options)
Paramètres:
Valeur renvoyée:aucune
Définissez les options de Marker.
setPosition
setPosition([latlng])
Paramètres:
Valeur renvoyée:aucune
Définissez la position de l'élément Marker.
setShape
setShape([shape])
Paramètres:
Valeur renvoyée:aucune
Définissez la forme du Marker utilisé pour l'interaction. Voir MarkerOptions.shape et 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éfinissez cette option 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
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.
animation_changed
function()
Arguments:aucun
Cet événement est déclenché lorsque la propriété d'animation Marker change.
click
function(event)
Arguments:
Cet événement est déclenché lorsque l'utilisateur clique sur l'icône Marker.
clickable_changed
function()
Arguments:aucun
Cet événement est déclenché lorsque la propriété cliquable Marker change.
contextmenu
function(event)
Arguments:
Cet événement se déclenche lorsque le menu contextuel 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:
Cet événement est déclenché lorsque l'utilisateur clique deux fois sur l'icône Marker.
drag
function(event)
Arguments:
Cet événement se déclenche de façon répétée lorsque l'utilisateur fait glisser le Marker.
dragend
function(event)
Arguments:
Cet événement est déclenché lorsque l'utilisateur arrête de faire glisser l'élément 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:
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é de l'icône Marker change.
mousedown
function(event)
Arguments:
Cet événement est déclenché pour un "mousedown" sur le Marker.
mouseout
function(event)
Arguments:
Cet événement est déclenché lorsque la souris quitte la zone de l'icône Marker.
mouseover
function(event)
Arguments:
Cet événement est déclenché lorsque la souris accède à la zone de l'icône Marker.
mouseup
function(event)
Arguments:
Cet événement est déclenché pour un "mouseup" 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 se déclenche lorsque la propriété visible Marker change.
zindex_changed
function()
Arguments:aucun
Cet événement est déclenché lorsque la propriété zIndex Marker change.
rightclick
function(event)
Arguments:
Cet événement est déclenché pour un clic droit sur le Marker.

Interface MarkerOptions

Interface google.maps.MarkerOptions

Objet MarkerOptions utilisé pour définir les propriétés pouvant être définies sur un repère.
anchorPoint optional
Type:Point optional
Décalage par rapport à la position du repère par rapport à l'extrémité d'une fenêtre d'informations qui a été ouverte avec le repère en tant qu'ancre.
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.
BetacollisionBehavior optional
Type:string|CollisionBehavior optional
Par défaut:null
Définissez un 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 apparaît sous le repère est désactivée lors du déplacement.
cursor optional
Type:string optional
Par défaut:pointer
Type du curseur de la souris à afficher lors du survol avec la souris.
draggable optional
Type:boolean optional
Par défaut:false
Si la valeur est true, le repère peut être déplacé.
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 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 aucune valeur n'est fournie, mais que MarkerOptions.title n'est pas spécifié, un texte d'accessibilité (par exemple, pour les lecteurs d'écran) est ajouté au repère avec le texte du libellé fourni. Notez 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 et peut être fournie avec Marker.setMap s'il n'est pas fourni lors de la construction du repère.
opacity optional
Type:number optional
Default:1
Nombre compris entre 0, transparent et 1, 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
position optional
Type:LatLng|LatLngLiteral optional
Définit la position du repère. Un repère peut être construit, mais pas affiché tant qu'il n'a pas été fourni (par exemple, en fonction des actions ou des choix de l'utilisateur). Une position de repère peut être fournie avec Marker.setPosition s'il n'est pas fourni lors de la construction du repère.
shape optional
Type:MarkerShape optional
Définition de la région du mappage d'images utilisée pour le glisser-cliquer.
title optional
Type:string optional
Par défaut:undefined
Texte de roulement. Si cette option est fournie, un texte d'accessibilité (par exemple, pour les lecteurs d'écran) est ajouté au repère avec la valeur fournie. Notez 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 s'affichent sur la carte par ordre de zIndex. Les valeurs les plus élevées s'affichent devant celles des valeurs inférieures. Par défaut, les repères s'affichent en fonction de leur position verticale à l'écran, les plus petits devant s'afficher plus haut sur l'écran.

Constantes CollisionBehavior

Constantes google.maps.CollisionBehavior

Accédez au compte en appelant const {CollisionBehavior} = await google.maps.importLibrary("marker"). Consultez Bibliothèques dans l'API Maps JavaScript.
OPTIONAL_AND_HIDES_LOWER_PRIORITY N'affichez le repère que s'il ne chevauche pas d'autres repères. Si deux repères de ce type se chevauchent, celui avec le zIndex 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 Affichez toujours le repère en cas de collision. Il s'agit du comportement par défaut.
REQUIRED_AND_HIDES_OPTIONAL Affichez toujours le repère en cas de collision et masquez les repères OPTIONAL_AND_HIDES_LOWER_PRIORITY ou ceux qui se superposent au repère.

Icon

Interface google.maps.Icon

Structure représentant une image d'icône de repère.
url
Type:string
URL de l'image ou de la feuille de sprites.
anchor optional
Type:Point optional
Position à laquelle ancrer une image en correspondance avec l'emplacement du repère sur la carte. Par défaut, l'ancre est située au centre du bas 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, le point de départ est situé au centre de l'image.
origin optional
Type:Point optional
Position de l'image dans un sprite, le cas échéant. Par défaut, le point de départ est situé dans l'angle supérieur gauche de l'image (0, 0).
scaledSize optional
Type:Size optional
Taille de l'image entière après la mise à l'échelle, le cas échéant. Utilisez cette propriété pour agrandir 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 indiquée, elle est définie lors du chargement de l'image.

Interface MarkerLabel

Interface google.maps.MarkerLabel

Ces options permettent de spécifier l'aspect d'un libellé de repère. Un libellé de repère est une chaîne (souvent un caractère) qui apparaît à l'intérieur du repère. Si vous l'utilisez avec un repère personnalisé, vous pouvez la repositionner avec la propriété labelOrigin dans la classe Icon.
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 de l'étiquette (équivalent à l'attribut de classe de l'élément). Vous pouvez ajouter plusieurs classes CSS séparées par un espace. 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 ou l'orientation du libellé (par exemple, à l'aide de traductions et de rotations) si vous utilisez également la gestion des conflits avec les 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 "family-family").
fontSize optional
Type:string optional
Par défaut:'14px'
Taille de police du texte du libellé (équivalent à la propriété de taille de police CSS).
fontWeight optional
Type:string optional
Épaisseur de texte du libellé (équivalent à la propriété de police de police CSS).

Interface MarkerShape

Interface google.maps.MarkerShape

Cet objet définit la zone cliquable d'une image de repère. La forme comprend deux propriétés (type et coord) qui définissent la zone non transparente d'une image.
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écifie la position des 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 correspond aux coordonnées du centre du cercle, et r est le rayon du cercle.
- poly: coordonnées est [x1,y1,x2,y2...xn,yn], où chaque paire x,y contient les coordonnées d'un sommet du polygone.
- rect: la valeur de coordonnées est [x1,y1,x2,y2], où x1,y1 correspond aux coordonnées de l'angle supérieur gauche du rectangle et x2,y2 correspond aux coordonnées du coin inférieur droit du rectangle.
type
Type:string
Décrit le type de la forme et peut être circle, poly ou rect.

Symbole

Interface google.maps.Symbol

Décrit un symbole, constitué d'un tracé vectoriel avec des styles. Un symbole peut être utilisé comme icône de repère ou placé sur une polyligne.
path
Type:SymbolPath|string
Chemin d'accès au symbole, qui est un chemin de symbole intégré, ou chemin personnalisé exprimé à l'aide du 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 est exprimée dans le même système de coordonnées que le tracé du symbole.
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". Pour les symboles sur des polylignes, la couleur du trait de la polyligne correspondante est utilisée par défaut.
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 au point de départ du tracé, 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 une IconSequence où fixedRotation est false fait pivoter par rapport à l'angle du bord sur lequel il se trouve.
scale optional
Type:number optional
Quantité avec 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 avoir n'importe quelle taille. Pour les symboles sur une polyligne, la valeur par défaut est celle de 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". Pour les symboles sur une polyligne, la couleur du trait de la polyligne est définie par défaut.
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 est l'opacité du trait de la polyligne.
strokeWeight optional
Type:number optional
Par défaut:Symbol.scale du symbole.
Épaisseur du trait du symbole.

Constantes SymbolPath

Constantes google.maps.SymbolPath

Chemins de symboles intégrés.

Accédez au compte en appelant const {SymbolPath} = await google.maps.importLibrary("core"). Consultez Bibliothèques dans l'API Maps JavaScript.
BACKWARD_CLOSED_ARROW Flèche fermée pour pointer vers l'arrière.
BACKWARD_OPEN_ARROW Flèche ouverte d'ouverture.
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

Constantes google.maps.Animation

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

Accédez au compte en appelant const {Animation} = await google.maps.importLibrary("marker"). Consultez Bibliothèques dans l'API Maps JavaScript.
BOUNCE Le repère rebondit jusqu'à ce que l'animation s'arrête en appelant Marker.setAnimation avec null.
DROP Le repère s'arrête du haut de la carte jusqu'à 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.