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 élément géographique lorsque l'utilisateur clique dessus.
Cette classe étend MVCObject
.
Pour y accéder, appelez const {KmlLayer} = await google.maps.importLibrary("maps")
. Consultez Bibliothèques dans 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 Permet d'obtenir la fenêtre d'affichage par défaut du calque affiché. |
getMap |
getMap() Paramètres:aucun
Valeur renvoyée:
Map Permet d'obtenir 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, comme indiqué dans le balisage du calque. |
getStatus |
getStatus() Paramètres:aucun
Valeur renvoyée:
KmlLayerStatus Permet d'obtenir l'état du calque, 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 : z-index.Récupère le z-index du calque KML. |
setMap |
setMap(map) Paramètres:
Return Value (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:
Return Value (Valeur renvoyée) : aucune
|
setUrl |
setUrl(url) Paramètres:
Return Value (Valeur renvoyée) : aucune
Définit l'URL du fichier KML à afficher. |
setZIndex |
setZIndex(zIndex) Paramètres:
Return Value (Valeur renvoyée) : aucune
Définit le 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 géographique 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 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 , 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 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 Supprimer l'affichage des fenêtres d'informations lorsque l'utilisateur clique sur des é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
Interface google.maps.KmlLayerMetadata
Métadonnées d'un seul calque KML, au format JSON.
Propriétés | |
---|---|
author |
Type:
KmlAuthor <atom:author> du calque, extrait du balisage du calque. |
description |
Type:
string <description> du calque, extrait du balisage du calque. |
hasScreenOverlays |
Type:
boolean Indique si le calque comporte des superpositions d'écran. |
name |
Type:
string <name> du calque, extrait du balisage du calque. |
snippet |
Type:
string <Snippet> du calque, extrait du balisage du calque. |
Constantes KmlLayerStatus
Constantes google.maps.KmlLayerStatus
État renvoyé par KmlLayer
une fois le chargement d'un document terminé. Spécifiez-les à l'aide d'une valeur ou du nom de la constante. (par exemple, 'OK'
ou google.maps.KmlLayerStatus.OK
).
Pour y accéder, appelez const {KmlLayerStatus} = await google.maps.importLibrary("maps")
. Consultez Bibliothèques dans l'API Maps JavaScript.
Constantes | |
---|---|
DOCUMENT_NOT_FOUND |
Le document est introuvable. Il s'agit probablement d'une URL non valide ou 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 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 |
Échec du chargement du document 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 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 l'élément géographique sur lequel l'utilisateur a cliqué. |
Interface KmlFeatureData
Interface google.maps.KmlFeatureData
Données pour un seul élément géographique KML au format JSON, renvoyées lorsqu'un utilisateur clique sur un élément géographique KML. 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 du balisage du calque (le cas échéant). |
description |
Type:
string <description> de l'élément géographique, extrait du balisage du calque. |
id |
Type:
string <id> de l'élément géographique, extrait du balisage du calque. Si aucun <id> n'a été spécifié, un identifiant unique sera généré pour cet élément géographique. |
infoWindowHtml |
Type:
string Texte stylisé par infobulle de l'élément, s'il est défini. |
name |
Type:
string <name> de l'élément géographique, extrait du balisage du calque. |
snippet |
Type:
string <Snippet> de l'élément géographique, extrait du balisage du calque. |
Interface KmlAuthor
Interface google.maps.KmlAuthor
Contient 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 elle n'est pas spécifiée. |