Classe KmlLayer
class
google.maps.KmlLayer
extends MVCObject
library "maps"
const {KmlLayer} = await google.maps.importLibrary("maps");
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|nullObtenir la fenêtre d'affichage par défaut de la couche affichée. |
getMap |
getMap()Paramètres : aucun
Valeur renvoyée :
Map|nullRécupère la carte sur laquelle le calque KML est affiché. |
getMetadata |
getMetadata()Paramètres : aucun
Valeur renvoyée :
Obtenez les métadonnées associées à cette couche, comme spécifié dans le balisage de la couche. |
getStatus |
getStatus()Paramètres : aucun
Valeur renvoyée :
Obtenez l'état du calque, défini une fois le document demandé chargé. |
getUrl |
getUrl()Paramètres : aucun
Valeur renvoyée : URL
stringRécupère l'URL du fichier KML affiché. |
getZIndex |
getZIndex()Paramètres : aucun
Valeur renvoyée :
number Le z-index.Récupère 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 le z-index du calque KML. |
Héritées :
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 de la couche KML est terminé. À ce stade, vous pouvez lire la propriété d'état pour déterminer si le calque a bien été chargé. |
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
facultatif |
Type :
boolean optionalPar défaut :
trueSi la valeur est true, la couche reçoit les événements de souris. |
map
facultatif |
Type :
Map optionalCarte sur laquelle afficher le calque. |
preserveViewport
facultatif |
Type :
boolean optionalPar défaut :
falseSi 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
facultatif |
Type :
boolean optionalPar défaut :
trueIndique si les superpositions d'écran doivent être affichées. |
suppressInfoWindows
facultatif |
Type :
boolean optionalSupprime l'affichage des fenêtres d'informations lorsque l'utilisateur clique sur des éléments de calque. |
url
facultatif |
Type :
string optionalURL du document KML à afficher. |
zIndex
facultatif |
Type :
number optionalZ-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> du calque, extrait du balisage du calque. |
hasScreenOverlays |
Type :
booleanIndique 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 |
author
facultatif |
Type :
<atom:author> du calque, extrait du balisage du calque. |
KmlLayerStatus
google.maps.KmlLayerStatus
bibliothèque "maps"
É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.
Ces constantes peuvent également être utilisées comme des chaînes. En TypeScript, les littéraux de chaîne sont définis par le type KmlLayerStatusString.
const {KmlLayerStatus} = await google.maps.importLibrary("maps");
Constantes | |
|---|---|
DOCUMENT_NOT_FOUND |
Le document est introuvable. Il s'agit probablement d'une URL non valide ou le document n'est pas accessible publiquement. |
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 d'éléments 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 :
Objet KmlFeatureData contenant des informations sur l'élément géographique sur lequel l'utilisateur a cliqué. |
latLng |
Type :
LatLngPosition à laquelle ancrer une fenêtre d'informations sur l'élément géographique sur lequel l'utilisateur a cliqué. |
pixelOffset |
Type :
SizeDécalage à appliquer à une fenêtre d'informations ancrée sur l'élément géographique sélectionné. |
KmlFeatureData
interface
google.maps.KmlFeatureData
Données d'un seul élément géographique KML au format JSON, renvoyées lorsque l'utilisateur clique sur un élément géographique KML. Les données contenues dans cet objet reflètent celles associées à l'élément cartographique dans le balisage KML ou GeoRSS dans lequel il est déclaré.
Propriétés | |
|---|---|
author |
Type :
<atom:author> de l'élément géographique, extrait du balisage de la couche (si spécifié). |
description |
Type :
string<description> de l'élément géographique, extrait du balisage de la couche. |
id |
Type :
string<id> de l'élément géographique, extrait du balisage de la couche. Si aucun <id> n'a été spécifié, un identifiant unique sera généré pour cette caractéristique. |
infoWindowHtml |
Type :
stringTexte de style info-bulle de l'élément géographique, s'il est défini. |
name |
Type :
string<name> de l'élément géographique, extrait du balisage de la couche. |
snippet |
Type :
string<Snippet> de l'élément géographique, 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 géographique KML.
Propriétés | |
|---|---|
email |
Type :
stringAdresse e-mail de l'auteur ou chaîne vide si elle n'est pas spécifiée. |
name |
Type :
stringNom de l'auteur, ou chaîne vide si aucun nom n'est spécifié. |
uri |
Type :
stringPage d'accueil de l'auteur, ou chaîne vide si elle n'est pas spécifiée. |