Clase KmlLayer
Clase google.maps.KmlLayer
Un objeto KmlLayer
agrega marcas geográficas al mapa desde un archivo KML, KMZ o GeoRSS alojado en un servidor web accesible públicamente. Se proporciona un objeto KmlFeatureData
para cada elemento cuando se hace clic en él.
Esta clase extiende MVCObject
.
Llama al const {KmlLayer} = await google.maps.importLibrary("maps")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Constructor | |
---|---|
KmlLayer |
KmlLayer([opts]) Parámetros:
Crea un objeto KmlLayer que renderiza el contenido del archivo KML/KMZ especificado (https://developers.google.com/kml/documentation/kmlreference) o del archivo GeoRSS (http://www.georss.org). |
Métodos | |
---|---|
getDefaultViewport |
getDefaultViewport() Parámetros: Ninguno
Valor de devolución:
LatLngBounds Obtiene el viewport predeterminado para la capa que se muestra. |
getMap |
getMap() Parámetros: Ninguno
Valor de devolución:
Map Obtiene el mapa en el que se renderiza la capa KML. |
getMetadata |
getMetadata() Parámetros: Ninguno
Valor de devolución:
KmlLayerMetadata Obtiene los metadatos asociados a esta capa, como se especifica en el marcado de la capa. |
getStatus |
getStatus() Parámetros: Ninguno
Valor de devolución:
KmlLayerStatus Obtiene el estado de la capa, que se establece una vez que se carga el documento solicitado. |
getUrl |
getUrl() Parámetros: Ninguno
Valor de retorno: URL de
string Obtiene la URL del archivo KML que se muestra. |
getZIndex |
getZIndex() Parámetros: Ninguno
Valor de retorno:
number El índice Z.Obtiene el índice Z de la capa KML. |
setMap |
setMap(map) Parámetros:
Valor de retorno: 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 de retorno: Ninguno
|
setUrl |
setUrl(url) Parámetros:
Valor de retorno: Ninguno
Establece la URL del archivo KML que se mostrará. |
setZIndex |
setZIndex(zIndex) Parámetros:
Valor de retorno: 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 una entidad de la capa. |
defaultviewport_changed |
function() Argumentos: Ninguno
Este evento se activa cuando cambia la ventana gráfica predeterminada de las capas de KML. |
status_changed |
function() Argumentos: Ninguno
Este evento se activa cuando la capa de KML termina de cargarse. En este punto, es seguro leer la propiedad de estado para determinar si la capa se cargó correctamente. |
Interfaz de 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 Es el mapa en el que se mostrará la capa. |
preserveViewport optional |
Tipo:
boolean optional Predeterminado:
false Si esta opción está configurada como true o si nunca se configuraron el centro y el nivel de zoom del mapa, el mapa de entrada se centrará y se acercará al cuadro delimitador del contenido de la capa. |
screenOverlays optional |
Tipo:
boolean optional Predeterminado:
true Indica si se deben renderizar las superposiciones de pantalla. |
suppressInfoWindows optional |
Tipo:
boolean optional Suprime la renderización de ventanas de información cuando se hace clic en las entidades de la capa. |
url optional |
Tipo:
string optional Es la URL del documento KML que se mostrará. |
zIndex optional |
Tipo:
number optional Índice Z de la capa. |
Interfaz KmlLayerMetadata
Interfaz de google.maps.KmlLayerMetadata
Son los metadatos de una sola capa de KML, en formato JSON.
Propiedades | |
---|---|
description |
Tipo:
string Es el <description> de la capa, extraído del lenguaje de marcado de la capa. |
hasScreenOverlays |
Tipo:
boolean Indica si la capa tiene alguna superposición en pantalla. |
name |
Tipo:
string Es el <name> de la capa, extraído del lenguaje de marcado de la capa. |
snippet |
Tipo:
string El <Snippet> de la capa, extraído del marcado de la capa |
author optional |
Tipo:
KmlAuthor optional Es el <atom:author> de la capa, extraído del lenguaje de marcado de la capa. |
Constantes de KmlLayerStatus
Constantes de google.maps.KmlLayerStatus
Es el estado que devuelve KmlLayer
cuando se completa la carga de un documento. Puedes especificarlos por valor o con el nombre de la constante. Por ejemplo, 'OK'
o google.maps.KmlLayerStatus.OK
.
Llama al const {KmlLayerStatus} = await google.maps.importLibrary("maps")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Constantes | |
---|---|
DOCUMENT_NOT_FOUND |
No se encontró el documento. Es muy probable que la URL no sea 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 tiempo razonable. |
UNKNOWN |
No se pudo cargar el documento por un motivo desconocido. |
Interfaz 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 Es un objeto KmlFeatureData que contiene información sobre el elemento en el que se hizo clic. |
latLng |
Tipo:
LatLng Es la posición en la que se debe fijar una ventana de información en el componente en el que se hizo clic. |
pixelOffset |
Tipo:
Size Es 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 los datos de un solo elemento KML en formato JSON, que se muestran cuando se hace clic en un elemento KML. Los datos que contiene 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 Es el <atom:author> de la función, que se extrae del lenguaje de marcado de la capa (si se especifica). |
description |
Tipo:
string El <description> de la función, extraído del lenguaje de marcado de la capa. |
id |
Tipo:
string El <id> de la función, extraído del lenguaje de marcado de la capa. Si no se especificó ningún <id> , se generará un ID único para esta función. |
infoWindowHtml |
Tipo:
string Es el texto con estilo de globo de la función, si se configuró. |
name |
Tipo:
string El <name> de la función, extraído del lenguaje de marcado de la capa. |
snippet |
Tipo:
string El <Snippet> de la función, extraído del lenguaje de marcado de la capa. |
Interfaz de KmlAuthor
Interfaz de google.maps.KmlAuthor
Contiene detalles del autor de un documento o componente 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. |