Classe KmlLayer
Classe google.maps.KmlLayer
Un KmlLayer
ajoute un balisage géographique à la carte à partir d'un fichier KML, KMZ ou GeoRSS hébergé sur un serveur Web accessible publiquement. Un objet KmlFeatureData
est fourni pour chaque fonctionnalité lorsque l'utilisateur clique dessus.
Cette classe étend MVCObject
.
Accédez-y en appelant le const {KmlLayer} = await google.maps.importLibrary("maps")
.
Consultez 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 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 fenêtre d'affichage par défaut pour le 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 Obtenez les métadonnées associées à ce calque, telles qu'elles sont spécifiées 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 demandé chargé. |
getUrl |
getUrl() Paramètres : aucun
Valeur renvoyée : URL
string Obtient l'URL du fichier KML affiché. |
getZIndex |
getZIndex() Paramètres : aucun
Valeur renvoyée :
number , l'index Z.Obtient le z-index 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'index Z 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 une entité 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 pour déterminer si le calque a été chargé correctement. |
Interface KmlLayerOptions
Interface google.maps.KmlLayerOptions
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 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 niveau de 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 si les superpositions d'écran doivent être affichées. |
suppressInfoWindows optional |
Type :
boolean optional Supprime l'affichage des fenêtres d'informations lorsque l'utilisateur clique sur les entités 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 le calque 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 du balisage du calque |
author optional |
Type :
KmlAuthor optional <atom:author> de la couche, extrait du balisage de la couche. |
Constantes KmlLayerStatus
google.maps.KmlLayerStatus
constantes
État renvoyé par KmlLayer
à la fin du chargement d'un document. 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 le const {KmlLayerStatus} = await google.maps.importLibrary("maps")
.
Consultez Bibliothèques de l'API Maps JavaScript.
Constantes | |
---|---|
DOCUMENT_NOT_FOUND |
Le document est introuvable. Il s'agit très probablement d'une URL non valide ou d'un document non accessible au public. |
DOCUMENT_TOO_LARGE |
La taille du fichier dépasse la limite autorisée pour 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 |
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 sur lequel l'utilisateur a cliqué. |
latLng |
Type :
LatLng Position à laquelle ancrer une fenêtre d'informations sur l'élément sur lequel l'utilisateur a cliqué. |
pixelOffset |
Type :
Size Décalage à appliquer à une fenêtre d'informations ancrée sur l'élément sur lequel l'utilisateur a cliqué. |
Interface KmlFeatureData
Interface google.maps.KmlFeatureData
Données d'un seul élément KML au format JSON, renvoyées lorsqu'un élément KML est sélectionné. Les données contenues dans cet objet reflètent celles associées à l'élément dans le balisage KML ou GeoRSS dans lequel il est déclaré.
Propriétés | |
---|---|
author |
Type :
KmlAuthor <atom:author> de la fonctionnalité, extrait du balisage de la couche (le cas échéant). |
description |
Type :
string <description> de la fonctionnalité, extrait du balisage de la couche. |
id |
Type :
string <id> de la fonctionnalité, extrait du balisage de la couche. Si aucun <id> n'a été spécifié, un ID unique sera généré pour cette fonctionnalité. |
infoWindowHtml |
Type :
string Texte de style bulle de la fonctionnalité, le cas échéant. |
name |
Type :
string <name> de la fonctionnalité, extrait du balisage de la couche. |
snippet |
Type :
string <Snippet> de la fonctionnalité, extrait du balisage de la couche. |
Interface KmlAuthor
Interface google.maps.KmlAuthor
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 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 elle n'est pas spécifiée. |