Visualisation d'une page Webjax
GMap2
Cet exemple est propulsé par
Cette page présente la référence de la classe GMap2 .
A cette page est attachée sur ce site Webjax, une page GMap2 (demo) qui permet d'utiliser, via les interfaces de test
déployées sur ce site, les options, méthodes et fonctionnalités de le classe GMap2.
Ce fonctionnement de couple "page référence / page démonstration" est utilisé comme "pattern" pour la présentation de toutes les classes
de la librairie GMaps.
Donc pour rentrer dans le détails de la classe GMap2, on peut commencer par noter que l'on a affaire à 7 types de méthodes et 1 définition
d'évènements à partir desquels il est possible de "brancher" des fonctionnalités.
Méthode
Arguments
Description
GMap2 ( )
container : élément DOM dans lequel doit être créé la carte GMap2 .
options : objet GMapOptions (ndr : voir définition classe GMapOptions)
Constructeur qui permet de créer typiquement dans un élément 'div' une carte GMap2
avec des options et/ou contrôles d'affichages, etc...
Méthodes de configuration de carte
enableDragging()
aucun
Méthode permettant de rendre une carte déplaçable (ndr : déplacement activé par défaut).
disableDragging()
aucun
Méthode permettant de désactiver le déplacement d'une carte.
draggingEnabled()
aucun
Méthode qui retourne un Boolean (true) si le déplacement de la carte est activé.
enableInfoWindow()
aucun
Méthode qui permet d'activer l'affichage de fenêtres d'informations au sein de cartes GMap2 (ndr : par défaut, il est possible
d'afficher des fenêtres d'informations).
disableInfoWindow()
aucun
Méthode permettant de désactiver l'affichage de fenêtres d'informations au sein de cartes GMap2.
infoWindowEnabled()
aucun
Méthode qui retourne un Boolean (true) si la carte autorise l'affichage de fenêtres d'informations.
enableDoubleClickZoom ()
aucun
Méthode qui permet d'activer le zoom par double-click sur les cartes GMap2 (ndr : option désactivée par défaut).
disableDoubleClickZoom ()
aucun
Méthode permettant de désactiver le zoom par double-clik (ndr : option désactivée par défaut).
doubleClickZoomEnabled ()
aucun
Méthode qui retourne un Boolean (true) si la carte est zoomable par double-click (ndr : désactivé par défaut).
enableContinuousZoom ()
aucun
Méthode qui permet d'activer le zoom avec la molette souris sur une carte GMap2 (ndr : option désactivée par défaut).
disableContinuousZoom ()
aucun
Méthode qui permet de désactiver le zoom avec la molette de la souris sur une carte GMap2 .
continuousZoomEnabled ()
aucun
Méthode qui retourne un Boolean (true) si le zoom avec molette souris est activé.
Méthodes de contrôle d'affichage
addControl (control,position)
control : objet GControl à ajouter
position : objet GPosition à prendre en compte
Méthode permettant d'ajouter un contrôle d'affichage à la carte GMap2.
removeControl (control)
control : objet GControl à supprimer
Méthode permettant de supprimer un contrôle d'affichage.
getContainer ()
aucun
Méthode qui retourne l'élément DOM contenant la carte GMap2 .
Méthodes influant sur le type d'affichage
getMapTypes ()
aucun
Retourne un Array de GMapType définis dans la carte GMap2 .
getCurrentMapType ()
aucun
Méthode qui retourne un GMapType soit le type de carte affiché.
setMapType (type)
type :
Permet de changer le type de carte . Voir aussi addMapType (type)
addMapType (type)
type :
Méthode qui ajoute un nouveau type de carte.
removeMapType (type)
type :
Méthode qui supprime un type de carte.
Contrôle de l'état de la carte
isLoaded ()
aucun
Retourne Boolean (true) si la carte a été intialisée par setCenter() depuis sa création.
getCenter ()
aucun
Méthode qui retourne les coordonnées (lat,lng) du point central de la carte.
Le résultat est de type GLatLng
getBounds ()
aucun
Retourne les coordonnées du rectangle visible dans la carte courante.
Le résultat est de type GLatLngBounds
getBoundsZoomLevel (bounds)
bounds :
Retourne un résultat de type Number .
getSize ()
aucun
Retourne la taille de la carte en pixels.
Le résultat est de type GSize .
getZoom ()
aucun
Méthode qui retourne le niveau de zoom courant sous forme Number.
Méthodes permettant de modifier l'état d'une carte
setCenter (center, zoom , type )
center : GLatLng qui définit les coordonnées du centre de la carte.
zoom : Number qui définit le niveau de zoom.
type : GMapType qui définit le type de carte proposé.
Méthode permettant de fixer le point central d'une carte GMap2.
panTo (center)
center : GLatLng
Méthode permettant de naviguer d'un point à un autre via une animation dite "pan" ou disons de déplacement tranquille/survol.
panBy (distance)
distance : GSize qui définit une distance de déplacement
Cette méthode permet de se déplacer en fonction d'un objet GSize via l'effet de mouvement décrit dans la ligne
précédente de ce tableau.
panDirection (x,y)
x :
y :
setZoom (level)
level : Number, niveau de zoom
Méthode permettant de définir le niveau de zoom de la carte.
zoomIn ()
aucun
Méthode permettant de zoomer d'un cran sur la carte GMap2 .
zoomOut ()
aucun
Méthode permettant de dézoomer d'un cran la carte GMap2 .
savePosition ()
aucun
Permet de sauvegarder la position courante de la carte GMap2 pour un appel futur par
returnToSavedPosition () .
returnToSavedPosition ()
aucun
Méthode permettant de retourner à un point défini lors de l'appel de savePosition()
checkResize ()
aucun
Prévient la carte d'un changement de taille de son container.
L'appel de cette méthode lors du changement de taille de l'élément DOM
container de la carte permet d'ajuster la taille de celle ci en fonction du
redimensionnement appliqué.
Méthodes permettant de gérer les calques / overlays
addOverlay (overlay)
overlay : GOverlay
Ajouter un GOverlay à la carte GMap2 et déclenche l'évènement associé.
removeOverlay (overlay)
overlay : GOverlay à supprimer
Méthode permettant de supprimer un GOverlay de la carte GMap2 .
clearOverlays ()
aucun
Méthode permettant de supprimer tous les GOverlay d'une carte GMap2.
Déclenche l'évènement clearoverlays .
getPane (panel)
panel :
Gestion des fenêtres d'informations
openInfoWindow (point , node , opts )
point : GPoint
node : node de type texte
opts : GInfoWindowOptions
Méthode permettant d'ouvrir à partir d'un GPoint une fenêtre d'informations au format texte.
openInfoWindowHtml (point , html , opts )
point : GPoint
html : chaîne HTML
opts : GInfoWindowOptions
Méthode permettant d'ouvrir à partir d'un GPoint une fenêtre d'informations au format HTML.
openInfoWindowTabs (point , tabs , opts )
point : GPoint
tabs : GInfoWindowTabs
opts : GInfoWindowOptions
Méthode permettant d'ouvrir à partir d'un GPoint une fenêtre d'informations avec onglets (ndr : les onglets
sont définis dans l'objet GInfoWindowTabs transmis).
Le format de contenu est de type node texte.
openInfoWindowTabsHtml (point , tabs , opts )
point : GPoint
tabs : GInfoWindowTabs
opts : GInfoWindowOptions
Méthode permettant d'ouvrir à partir d'un GPoint une fenêtre d'informations avec onglets (ndr : les onglets
sont définis dans l'objet GInfoWindowTabs transmis).
Le format de contenu est de type chaîne HTML.
showMapBlowup (points , opts )
point : GPoint
opts : GInfoWindowOptions
Méthode permettant d'afficher une fenêtre d'informations contenant une vue "closeup" de la carte atour du GPoint précisé.
closeInfoWindow ()
aucun
Méthode permettant de fermer la fenêtre d'information courante dans la carte GMap2 .
getInfoWindow ()
aucun
30/01/2007 : mise à jour à faire
Evènements gérés par GMap2
addmaptype
type : GMapType
évènement déclenché quand un type de carte est ajouté.
removemaptype
type : GMapType
évènement déclenché lorsqu'un type de carte est supprimé.
click
overlay : GOverlay
point : GPoint
évènement déclenché lors d'un click sur la carte.
Si le click se produit sur un GMarker celui ci est transmis via l'argument overlay.
Si le click se produit sur la carte simplement les coordonées du click sont transmises via
un GPoint .
movestart
aucun
évènement déclenché lors du début de déplacement d'une carte.
Cet évènement peut être déclenché depuis un dragging "déplacement de la carte" ou bien
depuis des méthodes comme GMap2.panTo() permettant de déplacer une carte GMap2.
move
aucun
évènement déclenché tout au long d'un mouvement de carte
moveend
aucun
évènement déclenché lorsqu'un mouvement de carte se termine
zoomend
oldLevel : Number , ancien niveau zoom
newLevel : Number , nouveau niveau zoom
évènement déclenché lors de l'arrivée à un nouveau niveau de zoom sur une carte .
maptypechanged
aucun
évènement déclenché lors du changement de type de cartes
infowindowopen
aucun
évènement déclenché lors de l'ouverture d'une fenêtre d'informations.
infowindowclose
aucun
évènement déclenché lors de la fermeture d'une fenêtre d'informations.
addoverlay
overlay : GOverlay
évènement déclenché lorsqu'un GOverlay est ajouté via la méthode addOverlay() .
Le GOverlay ajouté est passé en argument .
removeoverlay
overlay
évènement déclenché lorsqu'un GOverlay est supprimé via la méthode removeOverlay() .
Le GOverlay est passé en argument.
clearoverlays
aucun
évènement déclenché lors de l'appel de la méthode clearOverlays()
mouseover
latlng : GLatLng
évènement déclenché lorsque la souris passe au dessus de la carte GMap2 .
mouseout
latlng : GLatLng
évènement déclenché lorsque le pointeur de la souris n'est plus au dessus de la carte .
mousemove
latlng : GLatLng
évènement déclenché lorsque le pointeur de la souris se déplace au dessus de la carte
dragstart
aucun
évènement déclenché au début du déplacement d'une carte
drag
aucun
évènement déclenché de façon répétée lors du déplacement ou 'drag' de la carte GMap2 .
dragend
aucun
évènement déclenché à la fin d'un déplacement ou 'drag' de la carte GMap2 .
load
aucun
évènement déclenché lorsque la méthode isLoaded() retournerait Boolean (true) c'est à dire que position, niveau de zoom et
type d'affichage/carte sont intialisés et que restent possiblement des imageries à charger.
Cette page présente la référence de la classe GMap2 .
A cette page est attachée sur ce site Webjax, une page GMap2 (demo) qui permet d'utiliser, via les interfaces de test déployées sur ce site, les options, méthodes et fonctionnalités de le classe GMap2.
Ce fonctionnement de couple "page référence / page démonstration" est utilisé comme "pattern" pour la présentation de toutes les classes de la librairie GMaps.
Donc pour rentrer dans le détails de la classe GMap2, on peut commencer par noter que l'on a affaire à 7 types de méthodes et 1 définition d'évènements à partir desquels il est possible de "brancher" des fonctionnalités.
| Méthode | Arguments | Description |
| GMap2 ( ) | container : élément DOM dans lequel doit être créé la carte GMap2 . options : objet GMapOptions (ndr : voir définition classe GMapOptions) | Constructeur qui permet de créer typiquement dans un élément 'div' une carte GMap2 avec des options et/ou contrôles d'affichages, etc... |
| Méthodes de configuration de carte | ||
| enableDragging() | aucun | Méthode permettant de rendre une carte déplaçable (ndr : déplacement activé par défaut). |
| disableDragging() | aucun | Méthode permettant de désactiver le déplacement d'une carte. |
| draggingEnabled() | aucun | Méthode qui retourne un Boolean (true) si le déplacement de la carte est activé. |
| enableInfoWindow() | aucun | Méthode qui permet d'activer l'affichage de fenêtres d'informations au sein de cartes GMap2 (ndr : par défaut, il est possible d'afficher des fenêtres d'informations). |
| disableInfoWindow() | aucun | Méthode permettant de désactiver l'affichage de fenêtres d'informations au sein de cartes GMap2. |
| infoWindowEnabled() | aucun | Méthode qui retourne un Boolean (true) si la carte autorise l'affichage de fenêtres d'informations. |
| enableDoubleClickZoom () | aucun | Méthode qui permet d'activer le zoom par double-click sur les cartes GMap2 (ndr : option désactivée par défaut). |
| disableDoubleClickZoom () | aucun | Méthode permettant de désactiver le zoom par double-clik (ndr : option désactivée par défaut). |
| doubleClickZoomEnabled () | aucun | Méthode qui retourne un Boolean (true) si la carte est zoomable par double-click (ndr : désactivé par défaut). |
| enableContinuousZoom () | aucun | Méthode qui permet d'activer le zoom avec la molette souris sur une carte GMap2 (ndr : option désactivée par défaut). |
| disableContinuousZoom () | aucun | Méthode qui permet de désactiver le zoom avec la molette de la souris sur une carte GMap2 . |
| continuousZoomEnabled () | aucun | Méthode qui retourne un Boolean (true) si le zoom avec molette souris est activé. |
| Méthodes de contrôle d'affichage | ||
| addControl (control,position) |
control : objet GControl à ajouter
position : objet GPosition à prendre en compte |
Méthode permettant d'ajouter un contrôle d'affichage à la carte GMap2. |
| removeControl (control) | control : objet GControl à supprimer | Méthode permettant de supprimer un contrôle d'affichage. |
| getContainer () | aucun | Méthode qui retourne l'élément DOM contenant la carte GMap2 . |
| Méthodes influant sur le type d'affichage | ||
| getMapTypes () | aucun | Retourne un Array de GMapType définis dans la carte GMap2 . |
| getCurrentMapType () | aucun | Méthode qui retourne un GMapType soit le type de carte affiché. |
| setMapType (type) | type : | Permet de changer le type de carte . Voir aussi addMapType (type) |
| addMapType (type) | type : | Méthode qui ajoute un nouveau type de carte. |
| removeMapType (type) | type : | Méthode qui supprime un type de carte. |
| Contrôle de l'état de la carte | ||
| isLoaded () | aucun | Retourne Boolean (true) si la carte a été intialisée par setCenter() depuis sa création. |
| getCenter () | aucun |
Méthode qui retourne les coordonnées (lat,lng) du point central de la carte.
Le résultat est de type GLatLng |
| getBounds () | aucun |
Retourne les coordonnées du rectangle visible dans la carte courante.
Le résultat est de type GLatLngBounds |
| getBoundsZoomLevel (bounds) | bounds : | Retourne un résultat de type Number . |
| getSize () | aucun |
Retourne la taille de la carte en pixels.
Le résultat est de type GSize . |
| getZoom () | aucun | Méthode qui retourne le niveau de zoom courant sous forme Number. |
| Méthodes permettant de modifier l'état d'une carte | ||
| setCenter (center, zoom , type ) |
center : GLatLng qui définit les coordonnées du centre de la carte.
zoom : Number qui définit le niveau de zoom. type : GMapType qui définit le type de carte proposé. |
Méthode permettant de fixer le point central d'une carte GMap2. |
| panTo (center) | center : GLatLng | Méthode permettant de naviguer d'un point à un autre via une animation dite "pan" ou disons de déplacement tranquille/survol. |
| panBy (distance) | distance : GSize qui définit une distance de déplacement | Cette méthode permet de se déplacer en fonction d'un objet GSize via l'effet de mouvement décrit dans la ligne précédente de ce tableau. |
| panDirection (x,y) |
x :
y : |
|
| setZoom (level) | level : Number, niveau de zoom | Méthode permettant de définir le niveau de zoom de la carte. |
| zoomIn () | aucun | Méthode permettant de zoomer d'un cran sur la carte GMap2 . |
| zoomOut () | aucun | Méthode permettant de dézoomer d'un cran la carte GMap2 . |
| savePosition () | aucun | Permet de sauvegarder la position courante de la carte GMap2 pour un appel futur par returnToSavedPosition () . |
| returnToSavedPosition () | aucun | Méthode permettant de retourner à un point défini lors de l'appel de savePosition() |
| checkResize () | aucun |
Prévient la carte d'un changement de taille de son container.
L'appel de cette méthode lors du changement de taille de l'élément DOM container de la carte permet d'ajuster la taille de celle ci en fonction du redimensionnement appliqué. |
| Méthodes permettant de gérer les calques / overlays | ||
| addOverlay (overlay) | overlay : GOverlay | Ajouter un GOverlay à la carte GMap2 et déclenche l'évènement associé. |
| removeOverlay (overlay) | overlay : GOverlay à supprimer | Méthode permettant de supprimer un GOverlay de la carte GMap2 . |
| clearOverlays () | aucun |
Méthode permettant de supprimer tous les GOverlay d'une carte GMap2.
Déclenche l'évènement clearoverlays . |
| getPane (panel) | panel : | |
| Gestion des fenêtres d'informations | ||
| openInfoWindow (point , node , opts ) |
point : GPoint
node : node de type texte opts : GInfoWindowOptions |
Méthode permettant d'ouvrir à partir d'un GPoint une fenêtre d'informations au format texte. |
| openInfoWindowHtml (point , html , opts ) |
point : GPoint
html : chaîne HTML opts : GInfoWindowOptions |
Méthode permettant d'ouvrir à partir d'un GPoint une fenêtre d'informations au format HTML. |
| openInfoWindowTabs (point , tabs , opts ) |
point : GPoint
tabs : GInfoWindowTabs opts : GInfoWindowOptions |
Méthode permettant d'ouvrir à partir d'un GPoint une fenêtre d'informations avec onglets (ndr : les onglets
sont définis dans l'objet GInfoWindowTabs transmis).
Le format de contenu est de type node texte. |
| openInfoWindowTabsHtml (point , tabs , opts ) |
point : GPoint
tabs : GInfoWindowTabs opts : GInfoWindowOptions |
Méthode permettant d'ouvrir à partir d'un GPoint une fenêtre d'informations avec onglets (ndr : les onglets
sont définis dans l'objet GInfoWindowTabs transmis).
Le format de contenu est de type chaîne HTML. |
| showMapBlowup (points , opts ) |
point : GPoint
opts : GInfoWindowOptions |
Méthode permettant d'afficher une fenêtre d'informations contenant une vue "closeup" de la carte atour du GPoint précisé. |
| closeInfoWindow () | aucun | Méthode permettant de fermer la fenêtre d'information courante dans la carte GMap2 . |
| getInfoWindow () | aucun | 30/01/2007 : mise à jour à faire |
| Evènements gérés par GMap2 | ||
| addmaptype | type : GMapType | évènement déclenché quand un type de carte est ajouté. |
| removemaptype | type : GMapType | évènement déclenché lorsqu'un type de carte est supprimé. |
| click |
overlay : GOverlay
point : GPoint |
évènement déclenché lors d'un click sur la carte.
Si le click se produit sur un GMarker celui ci est transmis via l'argument overlay. Si le click se produit sur la carte simplement les coordonées du click sont transmises via un GPoint . |
| movestart | aucun |
évènement déclenché lors du début de déplacement d'une carte.
Cet évènement peut être déclenché depuis un dragging "déplacement de la carte" ou bien depuis des méthodes comme GMap2.panTo() permettant de déplacer une carte GMap2. |
| move | aucun | évènement déclenché tout au long d'un mouvement de carte |
| moveend | aucun | évènement déclenché lorsqu'un mouvement de carte se termine |
| zoomend |
oldLevel : Number , ancien niveau zoom
newLevel : Number , nouveau niveau zoom |
évènement déclenché lors de l'arrivée à un nouveau niveau de zoom sur une carte . |
| maptypechanged | aucun | évènement déclenché lors du changement de type de cartes |
| infowindowopen | aucun | évènement déclenché lors de l'ouverture d'une fenêtre d'informations. |
| infowindowclose | aucun | évènement déclenché lors de la fermeture d'une fenêtre d'informations. |
| addoverlay | overlay : GOverlay |
évènement déclenché lorsqu'un GOverlay est ajouté via la méthode addOverlay() .
Le GOverlay ajouté est passé en argument . |
| removeoverlay | overlay |
évènement déclenché lorsqu'un GOverlay est supprimé via la méthode removeOverlay() .
Le GOverlay est passé en argument. |
| clearoverlays | aucun | évènement déclenché lors de l'appel de la méthode clearOverlays() |
| mouseover | latlng : GLatLng | évènement déclenché lorsque la souris passe au dessus de la carte GMap2 . |
| mouseout | latlng : GLatLng | évènement déclenché lorsque le pointeur de la souris n'est plus au dessus de la carte . |
| mousemove | latlng : GLatLng | évènement déclenché lorsque le pointeur de la souris se déplace au dessus de la carte |
| dragstart | aucun | évènement déclenché au début du déplacement d'une carte |
| drag | aucun | évènement déclenché de façon répétée lors du déplacement ou 'drag' de la carte GMap2 . |
| dragend | aucun | évènement déclenché à la fin d'un déplacement ou 'drag' de la carte GMap2 . |
| load | aucun | évènement déclenché lorsque la méthode isLoaded() retournerait Boolean (true) c'est à dire que position, niveau de zoom et type d'affichage/carte sont intialisés et que restent possiblement des imageries à charger. |

:

