KmlLayer
Clase google.maps.KmlLayer
Un objeto KmlLayer
agrega lenguaje de marcado geográfico al mapa desde un archivo KML, KMZ o GeoRSS que se aloja en un servidor web de acceso público. Se proporciona un objeto KmlFeatureData
para cada elemento cuando se hace clic en él.
Esta clase extiende MVCObject
.
Cuando se usa v=beta
, se puede acceder a él llamando a const {KmlLayer} = await google.map.importLibrary("maps")
. Consulta Bibliotecas en la API de Maps JavaScript.
Constructor | |
---|---|
KmlLayer |
KmlLayer([opts]) Parámetros:
Crea un elemento KmlLayer que procesa el contenido del archivo KML/KMZ especificado (https://developers.google.com/kml/documentation/kmlreference) o el archivo GeoRSS (http://www.georss.org). |
Métodos | |
---|---|
getDefaultViewport |
getDefaultViewport() Parámetros: ninguno
Valor que se muestra:
LatLngBounds Obtenga el viewport predeterminado para la capa que se muestra. |
getMap |
getMap() Parámetros: ninguno
Valor que se muestra:
Map Obtén el mapa en el que se representa la capa KML. |
getMetadata |
getMetadata() Parámetros: ninguno
Valor que se muestra:
KmlLayerMetadata Obtén los metadatos asociados con esta capa, como se especifica en el lenguaje de marcado de capas. |
getStatus |
getStatus() Parámetros: ninguno
Valor que se muestra:
KmlLayerStatus Obtiene el estado de la capa y configúralo una vez que se cargue el documento solicitado. |
getUrl |
getUrl() Parámetros: ninguno
Valor que se muestra:
string URLObtiene la URL del archivo KML que se muestra. |
getZIndex |
getZIndex() Parámetros: ninguno
Valor que se muestra:
number El índice z.Obtiene el índice z de la capa KML. |
setMap |
setMap(map) Parámetros:
Valor que se muestra: Ninguno
Renderiza la capa KML en el mapa especificado. Si el mapa se establece en null , se quita la capa. |
setOptions |
setOptions(options) Parámetros:
Valor que se muestra: Ninguno
|
setUrl |
setUrl(url) Parámetros:
Valor que se muestra: Ninguno
Establece la dirección URL del archivo KML que se mostrará. |
setZIndex |
setZIndex(zIndex) Parámetros:
Valor que se muestra: Ninguno
Establece el índice Z de la capa KML. |
Heredada:
addListener ,
bindTo ,
get ,
notify ,
set ,
setValues ,
unbind ,
unbindAll
|
Eventos | |
---|---|
click |
function(kmlClickEvent) Argumentos:
Este evento se activa cuando se hace clic en un elemento de la capa. |
defaultviewport_changed |
function() Argumentos: Ninguno
Este evento se activa cuando cambia el viewport predeterminado de las capas KML. |
status_changed |
function() Argumentos: Ninguno
Este evento se activa cuando la capa KML termina de cargarse. En este punto, es seguro leer la propiedad de estado para determinar si la capa se cargó correctamente. |
Interfaz KmlLayerOptions
Interfaz de google.maps.KmlLayerOptions
Este objeto define las propiedades que se pueden establecer en un objeto KmlLayer
.
Propiedades | |
---|---|
clickable optional |
Tipo:
boolean optional Predeterminado:
true Si es true , la capa recibe eventos del mouse. |
map optional |
Tipo:
Map optional El mapa en el que se mostrará la capa. |
preserveViewport optional |
Tipo:
boolean optional Predeterminado:
false Si esta opción se establece en true , o si el centro y el zoom del mapa nunca se configuraron, el mapa de entrada se centra y se aplica zoom al cuadro de límite del contenido de la capa. |
screenOverlays optional |
Tipo:
boolean optional Predeterminado:
true Indica si se deben procesar las superposiciones de pantalla. |
suppressInfoWindows optional |
Tipo:
boolean optional Elimina la representación de las ventanas de información cuando se hace clic en los elementos de las capas. |
url optional |
Tipo:
string optional URL del documento KML que se mostrará. |
zIndex optional |
Tipo:
number optional El índice Z de la capa. |
Interfaz KmlLayerMetadata
Interfaz de google.maps.KmlLayerMetadata
Metadatos para una sola capa KML, en formato JSON.
Propiedades | |
---|---|
author |
Tipo:
KmlAuthor El <atom:author> de la capa, extraído del lenguaje de marcado de capas. |
description |
Tipo:
string El <description> de la capa, extraído del lenguaje de marcado de capas. |
hasScreenOverlays |
Tipo:
boolean Indica si la capa tiene superposiciones de pantalla. |
name |
Tipo:
string El <name> de la capa, extraído del lenguaje de marcado de capas. |
snippet |
Tipo:
string El <Snippet> de la capa, extraído del lenguaje de marcado de capas |
Constantes de KmlLayerStatus
google.maps.KmlLayerStatus
constantes
El estado que muestra KmlLayer
cuando se carga un documento. Especifícalos por valor o usa el nombre de la constante. Por ejemplo, 'OK'
o google.maps.KmlLayerStatus.OK
.
Cuando se usa v=beta
, se puede acceder a él llamando a const {KmlLayerStatus} = await google.map.importLibrary("maps")
. Consulta Bibliotecas en la API de Maps JavaScript.
Constantes | |
---|---|
DOCUMENT_NOT_FOUND |
No se pudo encontrar el documento. Lo más probable es que se trate de una URL no válida o que el documento no esté disponible públicamente. |
DOCUMENT_TOO_LARGE |
El documento supera los límites de tamaño de archivo de KmlLayer. |
FETCH_ERROR |
No se pudo obtener el documento. |
INVALID_DOCUMENT |
El documento no es un documento KML, KMZ o GeoRSS válido. |
INVALID_REQUEST |
El KmlLayer no es válido. |
LIMITS_EXCEEDED |
El documento excede los límites de las funciones de KmlLayer. |
OK |
La capa se cargó correctamente. |
TIMED_OUT |
No se pudo cargar el documento en un período razonable. |
UNKNOWN |
No se pudo cargar el documento por una razón desconocida. |
Interfaz KmlMouseEvent
Interfaz de google.maps.KmlMouseEvent
Las propiedades de un evento de clic en un documento KML/KMZ o GeoRSS.
Propiedades | |
---|---|
featureData |
Tipo:
KmlFeatureData Un objeto KmlFeatureData , que contiene información sobre la función en la que se hizo clic. |
latLng |
Tipo:
LatLng Es la posición en la que se va a anclar una ventana de información en la función en la que se hace clic. |
pixelOffset |
Tipo:
Size El desplazamiento que se aplicará a una ventana de información fija en el atributo en el que se hizo clic. |
Interfaz KmlFeatureData
Interfaz de google.maps.KmlFeatureData
Datos para una sola función KML en formato JSON, que se muestran cuando se hace clic en una función KML Los datos que contiene este objeto reflejan los elementos asociados con el elemento en el lenguaje de marcado KML o GeoRSS en el que se declaran.
Propiedades | |
---|---|
author |
Tipo:
KmlAuthor El <atom:author> del elemento, extraído del lenguaje de marcado de capas (si se especifica). |
description |
Tipo:
string El elemento <description> , extraído del lenguaje de marcado de capas. |
id |
Tipo:
string El elemento <id> , extraído del lenguaje de marcado de capas. Si no se especificó un <id> , se generará un ID único para esta función. |
infoWindowHtml |
Tipo:
string Texto con estilo de globo (si se establece) |
name |
Tipo:
string El elemento <name> , extraído del lenguaje de marcado de capas. |
snippet |
Tipo:
string El elemento <Snippet> , extraído del lenguaje de marcado de capas. |
Interfaz KmlAuthor
Interfaz de google.maps.KmlAuthor
Contiene detalles del autor de un documento o elemento KML.
Propiedades | |
---|---|
email |
Tipo:
string Dirección de correo electrónico del autor o una cadena vacía si no se especifica. |
name |
Tipo:
string Nombre del autor o una cadena vacía si no se especifica. |
uri |
Tipo:
string Página principal del autor o una cadena vacía si no se especifica. |