Classe KmlLayer
Classe google.maps.KmlLayer
KmlLayer
ajoute un balisage géographique à la carte à partir d'un fichier KML, KMZ ou GeoRSS hébergé sur un serveur Web accessible au public. Un objet KmlFeatureData
est fourni pour chaque élément géographique lorsque l'utilisateur clique dessus.
Cette classe étend MVCObject
.
Constructeur | |
---|---|
KmlLayer |
KmlLayer([opts]) Paramètres:
Crée un KmlLayer qui affiche le contenu du fichier KML/KMZ spécifié (https://developers.google.com/kml/documentation/kmlreference) ou du fichier GeoRSS (http://www.georss.org). |
Méthodes | |
---|---|
getDefaultViewport |
getDefaultViewport() Paramètres : aucun
Valeur renvoyée:
LatLngBounds Obtenez la vue par défaut du calque affiché. |
getMap |
getMap() Paramètres : aucun
Valeur renvoyée :
Map Obtenez la carte sur laquelle le calque KML est affiché. |
getMetadata |
getMetadata() Paramètres:aucun
Valeur renvoyée:
KmlLayerMetadata Récupérez les métadonnées associées à ce calque, comme spécifié dans le balisage du calque. |
getStatus |
getStatus() Paramètres : aucun
Valeur renvoyée:
KmlLayerStatus Obtenez l'état du calque défini une fois le document chargé. |
getUrl |
getUrl() Paramètres:aucun
Valeur renvoyée:URL
string Récupère l'URL du fichier KML affiché. |
getZIndex |
getZIndex() Paramètres:aucun
Valeur de retour :
number z-index.Récupère le z-index du calque KML. |
setMap |
setMap(map) Paramètres :
Valeur de retour:aucune
Affiche le calque KML sur la carte spécifiée. Si la carte est définie sur null , le calque est supprimé. |
setOptions |
setOptions(options) Paramètres:
Valeur de retour:aucune
|
setUrl |
setUrl(url) Paramètres:
Valeur de retour:aucune
Définit l'URL du fichier KML à afficher. |
setZIndex |
setZIndex(zIndex) Paramètres:
Valeur de retour:aucune
Définit la propriété z-index du calque KML. |
Hérité:
addListener ,
bindTo ,
get ,
notify ,
set ,
setValues ,
unbind ,
unbindAll
|
Événements | |
---|---|
click |
function(kmlClickEvent) Arguments:
Cet événement est déclenché lorsqu'un utilisateur clique sur un élément du calque. |
defaultviewport_changed |
function() Arguments : aucun
Cet événement est déclenché lorsque la fenêtre d'affichage par défaut des calques KML a changé. |
status_changed |
function() Arguments : aucun
Cet événement est déclenché lorsque le chargement du calque KML est terminé. À ce stade, vous pouvez lire la propriété d'état afin de déterminer si le calque a bien été chargé. |
Interface KmlLayerOptions
google.maps.KmlLayerOptions
interface
Cet objet définit les propriétés qui peuvent être définies sur un objet KmlLayer
.
Propriétés | |
---|---|
clickable optional |
Type :
boolean optional Par défaut:
true Si la valeur est true , le calque reçoit les événements de souris. |
map optional |
Type:
Map optional Carte sur laquelle le calque doit s'afficher. |
preserveViewport optional |
Type :
boolean optional Par défaut :
false Si cette option est définie sur true , ou si le centre et le zoom de la carte n'ont jamais été définis, la carte d'entrée est centrée et zoomée sur le cadre de délimitation du contenu du calque. |
screenOverlays optional |
Type:
boolean optional Par défaut :
true Indique s'il faut afficher les superpositions à l'écran. |
suppressInfoWindows optional |
Type :
boolean optional Empêcher l'affichage des fenêtres d'informations lorsque l'utilisateur clique sur les éléments géographiques du calque |
url optional |
Type:
string optional URL du document KML à afficher. |
zIndex optional |
Type :
number optional z-index du calque. |
Interface KmlLayerMetadata
google.maps.KmlLayerMetadata
interface
Métadonnées d'un seul calque KML, au format JSON.
Propriétés | |
---|---|
author |
Type:
KmlAuthor <atom:author> du calque, extraite du balisage du calque. |
description |
Type:
string <description> du calque, extraite du balisage du calque. |
hasScreenOverlays |
Type:
boolean Indique si le calque comporte des superpositions d'écran. |
name |
Type :
string <name> du calque, extraite du balisage du calque. |
snippet |
Type:
string Le <Snippet> du calque, extrait du balisage du calque |
Constantes KmlLayerStatus
constantes google.maps.KmlLayerStatus
État renvoyé par KmlLayer
à la fin du chargement d'un document. Spécifiez ces valeurs par valeur ou en utilisant le nom de la constante. Par exemple, 'OK'
ou google.maps.KmlLayerStatus.OK
.
Constantes | |
---|---|
DOCUMENT_NOT_FOUND |
Le document est introuvable. Il s'agit très probablement d'une URL non valide, ou le document n'est pas accessible au public. |
DOCUMENT_TOO_LARGE |
Le document dépasse la limite de taille de fichier de KmlLayer. |
FETCH_ERROR |
Impossible de récupérer le document. |
INVALID_DOCUMENT |
Le document n'est pas un document KML, KMZ ou GeoRSS valide. |
INVALID_REQUEST |
Le KmlLayer n'est pas valide. |
LIMITS_EXCEEDED |
Le document dépasse les limites de fonctionnalités de KmlLayer. |
OK |
Le calque a bien été chargé. |
TIMED_OUT |
Impossible de charger le document dans un délai raisonnable. |
UNKNOWN |
Échec du chargement du document pour une raison inconnue. |
Interface KmlMouseEvent
google.maps.KmlMouseEvent
interface
Propriétés d'un événement de clic sur un document KML/KMZ ou GeoRSS.
Propriétés | |
---|---|
featureData |
Type :
KmlFeatureData Un objet KmlFeatureData , contenant des informations sur l'élément géographique sur lequel l'utilisateur a cliqué |
latLng |
Type:
LatLng Position à laquelle ancrer une fenêtre d'informations sur l'élément géographique sur lequel l'utilisateur a cliqué |
pixelOffset |
Type:
Size Décalage à appliquer à une fenêtre d'informations ancrée sur la fonctionnalité sur laquelle l'utilisateur a cliqué. |
Interface KmlFeatureData
google.maps.KmlFeatureData
interface
Données pour un seul élément KML au format JSON, renvoyées lorsque l'utilisateur clique sur un élément KML. Les données contenues dans cet objet reflètent les données associées à l'élément géographique dans le balisage KML ou GeoRSS dans lequel il est déclaré.
Propriétés | |
---|---|
author |
Type:
KmlAuthor La valeur <atom:author> de l'élément géographique, extraite du balisage du calque (si spécifié). |
description |
Type:
string La valeur <description> de l'élément géographique, extraite du balisage du calque. |
id |
Type:
string La valeur <id> de l'élément géographique, extraite du balisage du calque. Si aucun <id> n'a été spécifié, un ID unique sera généré pour cet élément géographique. |
infoWindowHtml |
Type:
string Texte de style de l'info-bulle, s'il est défini. |
name |
Type:
string La valeur <name> de l'élément géographique, extraite du balisage du calque. |
snippet |
Type :
string La valeur <Snippet> de l'élément géographique, extraite du balisage du calque. |
Interface KmlAuthor
google.maps.KmlAuthor
interface
Contient des informations sur l'auteur d'un document ou d'un élément KML.
Propriétés | |
---|---|
email |
Type :
string Adresse e-mail de l'auteur ou chaîne vide si non spécifiée. |
name |
Type:
string Nom de l'auteur, ou chaîne vide si non spécifiée. |
uri |
Type :
string Page d'accueil de l'auteur ou chaîne vide si celle-ci n'est pas spécifiée. |