Clase KmlLayer
Clase google.maps.KmlLayer
Un objeto KmlLayer
agrega lenguaje de marcado geográfico al mapa desde un archivo KML, KMZ o GeoRSS alojado en un servidor web de acceso público. Cuando se hace clic en él, se proporciona un objeto KmlFeatureData
para cada componente.
Esta clase extiende MVCObject
.
Para acceder, llama a const {KmlLayer} = await google.maps.importLibrary("maps")
. Consulta el artículo Bibliotecas de la API de Maps JavaScript.
Constructor | |
---|---|
KmlLayer |
KmlLayer([opts]) Parámetros:
Crea un objeto 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 devuelve:
LatLngBounds Obtén la ventana gráfica predeterminada de la capa que se muestra. |
getMap |
getMap() Parámetros: Ninguno
Valor que se devuelve:
Map Obtiene el mapa en el que se renderiza la capa KML. |
getMetadata |
getMetadata() Parámetros: Ninguno
Valor que se devuelve:
KmlLayerMetadata Obtiene los metadatos asociados a esta capa, como se especifica en el lenguaje de marcado de la capa. |
getStatus |
getStatus() Parámetros: Ninguno
Valor que se devuelve:
KmlLayerStatus Obtiene el estado de la capa, que se establece una vez que se haya cargado el documento solicitado. |
getUrl |
getUrl() Parámetros: Ninguno
Valor que se devuelve:
string URLObtiene la URL del archivo KML que se muestra. |
getZIndex |
getZIndex() Parámetros: Ninguno
Valor que se devuelve:
number Es el índice z.Obtiene el índice z de la capa KML. |
setMap |
setMap(map) Parámetros:
Valor que se devuelve: Ninguno
Renderiza la capa KML en el mapa especificado. Si el mapa se configura como null , se quita la capa. |
setOptions |
setOptions(options) Parámetros:
Valor que se devuelve: Ninguno
|
setUrl |
setUrl(url) Parámetros:
Valor que se devuelve: Ninguno
Establece la URL del archivo KML que se mostrará. |
setZIndex |
setZIndex(zIndex) Parámetros:
Valor que se devuelve: Ninguno
Establece el índice z de la capa KML. |
Heredado:
addListener ,
bindTo ,
get ,
notify ,
set ,
setValues ,
unbind ,
unbindAll
|
Eventos | |
---|---|
click |
function(kmlClickEvent) Argumentos:
Este evento se activa cuando se hace clic en un componente 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. |
KmlLayerOptions
Interfaz de google.maps.KmlLayerOptions
Este objeto define las propiedades que se pueden configurar en un objeto KmlLayer
.
Propiedades | |
---|---|
clickable optional |
Tipo:
boolean optional Valor predeterminado:
true Si es true , la capa recibe eventos del mouse. |
map optional |
Tipo:
Map optional Indica el mapa en el que se muestra la capa. |
preserveViewport optional |
Tipo:
boolean optional Valor predeterminado:
false Si esta opción se establece en true o si nunca se establecieron el centro y el zoom del mapa, el mapa de entrada se centrará y se aplicará de zoom al cuadro delimitador del contenido de la capa. |
screenOverlays optional |
Tipo:
boolean optional Valor predeterminado:
true Indica si se deben renderizar o no las superposiciones de pantalla. |
suppressInfoWindows optional |
Tipo:
boolean optional Impide la renderización de las ventanas de información cuando se hace clic en los componentes de capa. |
url optional |
Tipo:
string optional La URL del documento KML que se mostrará. |
zIndex optional |
Tipo:
number optional El índice z de la capa. |
KmlLayerMetadata.
Interfaz de google.maps.KmlLayerMetadata
Metadatos de una sola capa KML, en formato JSON.
Propiedades | |
---|---|
author |
Tipo:
KmlAuthor El <atom:author> de la capa, extraído del lenguaje de marcado de la capa. |
description |
Tipo:
string El <description> de la capa, extraído del lenguaje de marcado de la capa. |
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 la capa. |
snippet |
Tipo:
string El <Snippet> de la capa, extraído de la marca de capas |
Constantes KmlLayerStatus
Constantes google.maps.KmlLayerStatus
Es el estado que muestra KmlLayer
cuando se completa la carga de un documento. Especifícalas por valor o con el nombre de la constante. Por ejemplo, 'OK'
o google.maps.KmlLayerStatus.OK
.
Para acceder, llama a const {KmlLayerStatus} = await google.maps.importLibrary("maps")
. Consulta el artículo Bibliotecas de la API de Maps JavaScript.
Constantes | |
---|---|
DOCUMENT_NOT_FOUND |
No se pudo encontrar el documento. Lo más probable es que sea 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 recuperar 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 supera los límites de elementos de KmlLayer. |
OK |
La capa se cargó correctamente. |
TIMED_OUT |
No se pudo cargar el documento en un plazo razonable. |
UNKNOWN |
No se pudo cargar el documento por motivos desconocidos. |
KmlMouseEvent
Interfaz de google.maps.KmlMouseEvent
Son 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 el componente en el que se hizo clic. |
latLng |
Tipo:
LatLng Es la posición en la que se debe anclar una ventana de información al componente en el que se hace clic. |
pixelOffset |
Tipo:
Size El desplazamiento que se aplica a una ventana de información anclada en el componente en el que se hizo clic. |
Interfaz de KmlFeatureData
Interfaz de google.maps.KmlFeatureData
Son datos de un único componente KML en formato JSON, que se muestran cuando se hace clic en un componente KML. Los datos contenidos en este objeto reflejan los asociados con el elemento en el lenguaje de marcado KML o GeoRSS en el que se declara.
Propiedades | |
---|---|
author |
Tipo:
KmlAuthor El <atom:author> del componente, extraído del lenguaje de marcado de la capa (si se especifica). |
description |
Tipo:
string El <description> del componente, extraído del lenguaje de marcado de la capa. |
id |
Tipo:
string El <id> del componente, extraído del lenguaje de marcado de la capa. Si no se especificó ningún <id> , se generará un ID único para este elemento. |
infoWindowHtml |
Tipo:
string Texto con estilo de globo del componente, si está configurado. |
name |
Tipo:
string El <name> del componente, extraído del lenguaje de marcado de la capa. |
snippet |
Tipo:
string El <Snippet> del componente, extraído del lenguaje de marcado de la capa. |
KmlAuthor
Interfaz de google.maps.KmlAuthor
Contiene detalles sobre el autor de un documento o elemento KML.
Propiedades | |
---|---|
email |
Tipo:
string La dirección de correo electrónico del autor o una cadena vacía si no se especifica. |
name |
Tipo:
string El nombre del autor o una cadena vacía si no se especifica. |
uri |
Tipo:
string La página principal del autor o una cadena vacía si no se especifica. |