Classe KmlLayer
Classe google.maps.KmlLayer
Un élément KmlLayer
ajoute à la carte un balisage géographique à 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 vous cliquez dessus.
Cette classe étend MVCObject
.
Accédez-y en appelant const {KmlLayer} = await google.maps.importLibrary("maps")
. Consultez la section Bibliothèques de l'API Maps JavaScript.
Constructeur | |
---|---|
KmlLayer |
KmlLayer([opts]) Paramètres:
Crée un KmlLayer qui affiche le contenu du fichier KML/KMZ (https://developers.google.com/kml/documentation/kmlreference) ou GeoRSS (http://www.georss.org) spécifié. |
Méthodes | |
---|---|
getDefaultViewport |
getDefaultViewport() Paramètres:aucun
Valeur renvoyée:
LatLngBounds Obtenez la fenêtre d'affichage par défaut de la couche affichée. |
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 à cette couche, comme indiqué dans le balisage de la couche. |
getStatus |
getStatus() Paramètres:aucun
Valeur renvoyée:
KmlLayerStatus Obtenez l'état de la couche, défini une fois le document demandé 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 renvoyée:
number L'indice z.Récupère l'indice Z du calque KML. |
setMap |
setMap(map) Paramètres:
Valeur renvoyée: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 renvoyée:aucune
|
setUrl |
setUrl(url) Paramètres:
Valeur renvoyée:aucune
Définit l'URL du fichier KML à afficher. |
setZIndex |
setZIndex(zIndex) Paramètres:
Valeur renvoyée:aucune
Définit l'indice Z du calque KML. |
Hérité:
addListener ,
bindTo ,
get ,
notify ,
set ,
setValues ,
unbind ,
unbindAll
|
Événements | |
---|---|
click |
function(kmlClickEvent) Arguments:
Cet événement se déclenche lorsqu'un utilisateur clique sur un élément de la couche. |
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 calque KML a fini de se charger. À ce stade, vous pouvez lire la propriété d'état pour déterminer si le calque a bien été chargé. |
Interface KmlLayerOptions
Interface google.maps.KmlLayerOptions
Cet objet définit les propriétés pouvant être définies sur un objet KmlLayer
.
Propriétés | |
---|---|
clickable optional |
Type:
boolean optional Par défaut:
true Si la valeur est true , la couche reçoit des événements de souris. |
map optional |
Type:
Map optional Carte sur laquelle afficher le calque. |
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 agrandie pour correspondre au cadre de délimitation du contenu du calque. |
screenOverlays optional |
Type:
boolean optional Par défaut:
true Indique si les superpositions d'écran doivent être affichées. |
suppressInfoWindows optional |
Type:
boolean optional Supprimez l'affichage des fenêtres d'informations lorsque l'utilisateur clique sur des éléments du calque. |
url optional |
Type:
string optional URL du document KML à afficher. |
zIndex optional |
Type:
number optional Z-index de la couche. |
Interface KmlLayerMetadata
Interface google.maps.KmlLayerMetadata
Métadonnées d'une seule couche KML, au format JSON.
Propriétés | |
---|---|
description |
Type:
string <description> de la couche, extrait du balisage de la couche. |
hasScreenOverlays |
Type:
boolean Indique si la couche comporte des superpositions d'écran. |
name |
Type:
string <name> de la couche, extrait du balisage de la couche. |
snippet |
Type:
string <Snippet> du calque, extrait de la balise du calque |
author optional |
Type:
KmlAuthor optional <atom:author> de la couche, extrait du balisage de la couche. |
Constantes KmlLayerStatus
Constantes google.maps.KmlLayerStatus
État renvoyé par KmlLayer
une fois le chargement d'un document terminé. Spécifiez-les par valeur ou en utilisant le nom de la constante. (par exemple, 'OK'
ou google.maps.KmlLayerStatus.OK
).
Accédez-y en appelant const {KmlLayerStatus} = await google.maps.importLibrary("maps")
. Consultez la section Bibliothèques de l'API Maps JavaScript.
Constantes | |
---|---|
DOCUMENT_NOT_FOUND |
Le document est introuvable. Il s'agit probablement d'une URL non valide ou du fait que le document n'est pas accessible au public. |
DOCUMENT_TOO_LARGE |
Le document dépasse les limites de taille de fichier de KmlLayer. |
FETCH_ERROR |
Impossible de récupérer le document. |
INVALID_DOCUMENT |
Le document n'est pas un fichier KML, KMZ ou GeoRSS valide. |
INVALID_REQUEST |
Le KmlLayer n'est pas valide. |
LIMITS_EXCEEDED |
Le document dépasse les limites d'éléments de KmlLayer. |
OK |
La couche a bien été chargée. |
TIMED_OUT |
Le document n'a pas pu être chargé dans un délai raisonnable. |
UNKNOWN |
Le document n'a pas pu être chargé pour une raison inconnue. |
Interface KmlMouseEvent
Interface google.maps.KmlMouseEvent
Propriétés d'un événement de clic sur un document KML/KMZ ou GeoRSS.
Propriétés | |
---|---|
featureData |
Type:
KmlFeatureData 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 cartographique sur lequel l'utilisateur a cliqué. |
pixelOffset |
Type:
Size Décalage à appliquer à une fenêtre d'informations ancrée sur l'élément géographique sur lequel l'utilisateur a cliqué. |
Interface KmlFeatureData
Interface google.maps.KmlFeatureData
Données d'un seul élément géographique KML au format JSON, renvoyées lorsqu'un élément géographique KML est sélectionné. Les données contenues dans cet objet reflètent celles 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 <atom:author> de l'élément géographique, extrait de la balise de calque (si spécifié). |
description |
Type:
string <description> de l'élément géographique, extrait de la balise de calque. |
id |
Type:
string <id> de l'élément géographique, extrait de la balise de calque. Si aucun <id> n'a été spécifié, un ID unique sera généré pour cette fonctionnalité. |
infoWindowHtml |
Type:
string Texte de la fonctionnalité au format bulle, le cas échéant |
name |
Type:
string <name> de l'élément géographique, extrait de la balise de calque. |
snippet |
Type:
string <Snippet> de l'élément géographique, extrait de la balise de calque. |
Interface KmlAuthor
Interface google.maps.KmlAuthor
Inclut des informations sur l'auteur d'un document ou d'un élément géographique KML.
Propriétés | |
---|---|
email |
Type:
string Adresse e-mail de l'auteur ou chaîne vide si elle n'est pas spécifiée. |
name |
Type:
string Nom de l'auteur ou chaîne vide si non spécifié. |
uri |
Type:
string Page d'accueil de l'auteur ou chaîne vide si aucune valeur n'est spécifiée. |