VIAMICHELIN JAVASCRIPT API


Marker

Marker est en charge des marqueurs affichés sur la carte. Elle est instanciée par new et hérite de Layer.

Layer est la classe de base des objets graphiques affichés sur la carte. Elle n'est pas instanciée directement.

Objet de paramétrage MarkerConfig

Propriétés

Type

Description

Défaut

coords

GeoPoint

Coordonnées géographiques du marqueur.

N/A

icon

{url: string, offset: Point , size:Size}

Image de représentation du marqueur avec son décalage par rapport au coin haut-gauche.

icône interne 

shadowIcon

{url: string, offset: Point, size:Size}

Image de représentation de l'ombre marqueur avec son décalage par rapport au coin haut-gauche de l'image du marqueur.

autoOpen

boolean

Indique si la fenêtre d'info-bulle doit s'ouvrir automatiquement lors de l'affichage du marqueur.

false

htm

string

Contenu HTML à présenter dans l'info-bulle.

''

title

string

Titre du marqueur présenté au survol de la souris.

-

zIndex

int

Valeur de la variable CSS z-index du marqueur.

2

visibility

boolean

Indique si le marqueur doit-être affiché ou pas lors de son ajout à la carte.

true

overlayText

{text: string, offset: Point, style: object}

Texte en surimpression de l'icône et positionné par rapport à son coin supérieur gauche.style permet de définir du paramétrage CSS (en notation JavaScript) complémentaire appliqué au texte.

-

shapeCoords

[[x:int, y:int],...]

Coordonnées définissant le polygone de la zone active du marqueur.

 

Méthodes

MéthodesValeur retournéeDescription
getZindex() int Retourne la valeur du CSS z-index du marqueur.
setZindex(z-index: int) - Positionne la valeur du CSS z-index du marqueur.
getVisibility() boolean Indique si le marqueur est visible ou pas (peut-être true même si le marqueur n'est pas associée à une carte et donc non visible).
setVisibility(visibility: boolean) - Change la visibilité du marqueur.
getOverlayText() string Retourne le texte courant affiché au dessus du marqueur.
setOverlayText(text: string) - Change le texte affiché au dessus du marqueur.
getIcon() string Retourne l'URL courante de l'icône du marqueur.
setIcon(url: string) - Change l'URL de l'icône du marqueur.
getPosition() GeoPoint Retourne la position courante du marqueur.
setPosition(GeoPoint) - Change la position courante du marqueur.
setBubbleContent(htm: string) - Change le contenu HTML présenté dans l'info-bulle.

 

Evènements

EvènementsArgumentsDescription
onClick GeoPoint Renvoyé lorsque l'utilisateur clique sur le marqueur.
onExpandOpen - Renvoyé lorsque l'info-bulle du marqueur s'ouvre.
onExpandClose - Renvoyé lorsque l'info-bulle du marqueur se ferme.
onMouseover - Renvoyé lorsque la souris commence un survol du marqueur.
onMouseout - Renvoyé lorsque la souris termine un survol du marqueur.

 

 

 

Propriétés

Type

Description

Défaut

coords

GeoPoint

Coordonnées géographiques du marqueur.

N/A

icon

{url: string, offset: Point , size:Size}

Image de représentation du marqueur avec son décalage par rapport au coin haut-gauche.

icône interne 

shadowIcon

{url: string, offset: Point, size:Size}

Image de représentation de l'ombre marqueur avec son décalage par rapport au coin haut-gauche de l'image du marqueur.

autoOpen

boolean

Indique si la fenêtre d'info-bulle doit s'ouvrir automatiquement lors de l'affichage du marqueur.

false

htm

string

Contenu HTML à présenter dans l'info-bulle.

''

title

string

Titre du marqueur présenté au survol de la souris.

-

zIndex

int

Valeur de la variable CSS z-index du marqueur.

2

visibility

boolean

Indique si le marqueur doit-être affiché ou pas lors de son ajout à la carte.

true

overlayText

{text: string, offset: Point, style: object}

Texte en surimpression de l'icône et positionné par rapport à son coin supérieur gauche.style permet de définir du paramétrage CSS (en notation JavaScript) complémentaire appliqué au texte.

-

shapeCoords

[[x:int, y:int],...]

Coordonnées définissant le polygone de la zone active du marqueur.

 

Retour haut de page