Clase KmlLayer
google.maps.KmlLayer
class
extends MVCObject
library "maps"
const {KmlLayer} = await google.maps.importLibrary("maps");
Constructor | |
|---|---|
KmlLayer |
KmlLayer([opts])Parámetros:
Crea un objeto KmlLayer que renderiza el contenido del archivo KML/KMZ (https://developers.google.com/kml/documentation/kmlreference) o GeoRSS (http://www.georss.org) especificado. |
Métodos | |
|---|---|
getDefaultViewport |
getDefaultViewport()Parámetros: Ninguno
Valor de retorno:
LatLngBounds|nullObtener el viewport predeterminado para la capa que se muestra |
getMap |
getMap()Parámetros: Ninguno
Valor de retorno:
Map|nullObtiene el mapa en el que se renderiza la capa KML. |
getMetadata |
getMetadata()Parámetros: Ninguno
Valor de retorno:
KmlLayerMetadata|nullObtiene los metadatos asociados con esta capa, como se especifica en el lenguaje de marcado de la capa. |
getStatus |
getStatus()Parámetros: Ninguno
Valor de retorno:
KmlLayerStatus|nullObtiene 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
stringObtiene la URL del archivo KML que se muestra. |
getZIndex |
getZIndex()Parámetros: Ninguno
Valor que se devuelve:
number El índice Z.Obtiene el índice Z de la capa de KML. |
setMap |
setMap(map)Parámetros:
Valor de retorno: Ninguno
Renderiza la capa de KML en el mapa especificado. Si el mapa se establece en 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 de KML. |
Heredados:
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 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 KmlLayerOptions
Interfaz
google.maps.KmlLayerOptions
Este objeto define las propiedades que se pueden establecer en un objeto KmlLayer.
Propiedades | |
|---|---|
clickable
opcional |
Tipo:
boolean optionalLa configuración predeterminada es
true.Si es true, la capa recibe eventos del mouse. |
map
opcional |
Tipo:
Map optionalEs el mapa en el que se mostrará la capa. |
preserveViewport
opcional |
Tipo:
boolean optionalLa configuración predeterminada es
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 centra y se acerca al cuadro delimitador del contenido de la capa. |
screenOverlays
opcional |
Tipo:
boolean optionalLa configuración predeterminada es
true.Indica si se deben renderizar las superposiciones de pantalla. |
suppressInfoWindows
opcional |
Tipo:
boolean optionalSuprime la renderización de las ventanas de información cuando se hace clic en los elementos de la capa. |
url
opcional |
Tipo:
string optionalEs la URL del documento KML que se mostrará. |
zIndex
opcional |
Tipo:
number optionalEs el índice z de la capa. |
Interfaz KmlLayerMetadata
Interfaz
google.maps.KmlLayerMetadata
Son los metadatos de una sola capa de KML, en formato JSON.
Propiedades | |
|---|---|
description |
Tipo:
stringEl <description> de la capa, extraído del lenguaje de marcado de la capa |
hasScreenOverlays |
Tipo:
booleanIndica si la capa tiene superposiciones de pantalla. |
name |
Tipo:
stringEl <name> de la capa, extraído del lenguaje de marcado de la capa |
snippet |
Tipo:
stringEl <Snippet> de la capa, extraído del lenguaje de marcado de la capa |
author
opcional |
Tipo:
KmlAuthor optionalEl <atom:author> de la capa, extraído del lenguaje de marcado de la capa |
Constantes de KmlLayerStatus
google.maps.KmlLayerStatus
constantes
biblioteca
"maps"
Es el estado que devuelve KmlLayer cuando se completa la carga de un documento. Especifica estos valores por valor o con el nombre de la constante. Por ejemplo, 'OK' o google.maps.KmlLayerStatus.OK.
Estas constantes también se pueden usar como cadenas. En TypeScript, los literales de cadena se definen con el tipo KmlLayerStatusString.
const {KmlLayerStatus} = await google.maps.importLibrary("maps");
Constantes | |
|---|---|
DOCUMENT_NOT_FOUND |
No se pudo encontrar el documento. Lo más probable es 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 ni 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
google.maps.KmlMouseEvent
Son las propiedades de un evento de clic en un documento KML/KMZ o GeoRSS.
Propiedades | |
|---|---|
featureData |
Tipo:
KmlFeatureDataEs un objeto KmlFeatureData que contiene información sobre el componente en el que se hizo clic. |
latLng |
Tipo:
LatLngEs la posición en la que se fijará una ventana de información en el componente en el que se hizo clic. |
pixelOffset |
Tipo:
SizeEs el desplazamiento que se aplicará a una ventana de información fijada en el elemento en el que se hizo clic. |
Interfaz KmlFeatureData
Interfaz
google.maps.KmlFeatureData
Son los datos de un solo elemento de KML en formato JSON, que se devuelven cuando se hace clic en un elemento de KML. Los datos que contiene este objeto reflejan los que se asocian con el elemento en el lenguaje de marcado KML o GeoRSS en el que se declara.
Propiedades | |
|---|---|
author |
Tipo:
KmlAuthorEl <atom:author> del elemento, extraído del lenguaje de marcado de la capa (si se especifica) |
description |
Tipo:
stringEl <description> del elemento, extraído del lenguaje de marcado de la capa |
id |
Tipo:
stringEl <id> del elemento, extraído del lenguaje de marcado de la capa Si no se especificó ningún <id>, se generará un ID único para este atributo. |
infoWindowHtml |
Tipo:
stringEs el texto con estilo de globo del componente, si se estableció. |
name |
Tipo:
stringEl <name> del elemento, extraído del lenguaje de marcado de la capa |
snippet |
Tipo:
stringEl <Snippet> del elemento, extraído del lenguaje de marcado de la capa |
Interfaz KmlAuthor
Interfaz
google.maps.KmlAuthor
Contiene detalles del autor de un documento o un componente de KML.
Propiedades | |
|---|---|
email |
Tipo:
stringEs la dirección de correo electrónico del autor o una cadena vacía si no se especifica. |
name |
Tipo:
stringEs el nombre del autor o una cadena vacía si no se especifica. |
uri |
Tipo:
stringEs la página principal del autor o una cadena vacía si no se especifica. |