Classe KmlLayer
Classe
google.maps.KmlLayer
Um KmlLayer adiciona marcação geográfica ao mapa de um arquivo KML, KMZ ou GeoRSS hospedado em um servidor da Web acessível publicamente. Um objeto KmlFeatureData é fornecido para cada recurso quando clicado.
Essa classe estende
MVCObject.
Acesse ligando para const {KmlLayer} = await google.maps.importLibrary("maps").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
KmlLayer |
KmlLayer([opts])Parâmetros:
Cria um KmlLayer que renderiza o conteúdo do arquivo KML/KMZ especificado (https://developers.google.com/kml/documentation/kmlreference) ou GeoRSS (http://www.georss.org). |
Métodos | |
|---|---|
getDefaultViewport |
getDefaultViewport()Parâmetros:nenhum
Valor de retorno:
LatLngBoundsObtenha a janela de visualização padrão da camada sendo exibida. |
getMap |
getMap()Parâmetros:nenhum
Valor de retorno:
MapObtém o mapa no qual a camada KML está sendo renderizada. |
getMetadata |
getMetadata()Parâmetros:nenhum
Valor de retorno:
KmlLayerMetadataObtém os metadados associados a esta camada, como especificado na marcação da camada. |
getStatus |
getStatus()Parâmetros:nenhum
Valor de retorno:
KmlLayerStatusRecebe o status da camada, definido quando o documento solicitado é carregado. |
getUrl |
getUrl()Parâmetros:nenhum
Valor de retorno:URL
stringRecebe o URL do arquivo KML que está sendo mostrado. |
getZIndex |
getZIndex()Parâmetros:nenhum
Valor de retorno:
number o z-index.Recebe o z-index da camada KML. |
setMap |
setMap(map)Parâmetros:
Valor de retorno:nenhum
Renderiza a camada KML no mapa especificado. Se o mapa estiver definido como null, a camada será removida. |
setOptions |
setOptions(options)Parâmetros:
Valor de retorno:nenhum
|
setUrl |
setUrl(url)Parâmetros:
Valor de retorno:nenhum
Define o URL do arquivo KML a ser mostrado. |
setZIndex |
setZIndex(zIndex)Parâmetros:
Valor de retorno:nenhum
Define o z-index da camada KML. |
Herdado:addListener,
bindTo,
get,
notify,
set,
setValues,
unbind,
unbindAll
| |
Eventos | |
|---|---|
click |
function(kmlClickEvent)Argumentos:
Este evento é disparado quando um elemento na camada é clicado. |
defaultviewport_changed |
function()Argumentos: nenhum
Este evento é disparado quando a janela de visualização padrão de camadas KML é alterada. |
status_changed |
function()Argumentos: nenhum
Esse evento é acionado quando a camada KML termina de carregar. Neste ponto, é seguro ler a propriedade de status para determinar se a camada foi carregada. |
Interface KmlLayerOptions
Interface google.maps.KmlLayerOptions
Esse objeto define as propriedades que podem ser definidas em um objeto KmlLayer.
Propriedades | |
|---|---|
clickable optional |
Tipo:
boolean optionalPadrão:
trueSe true, a camada vai receber eventos de mouse. |
map optional |
Tipo:
Map optionalO mapa no qual exibir a camada. |
preserveViewport optional |
Tipo:
boolean optionalPadrão:
falseSe essa opção estiver definida como true ou se o centro e o zoom do mapa nunca tiverem sido definidos, o mapa de entrada será centralizado e ampliado para a caixa delimitadora do conteúdo da camada. |
screenOverlays optional |
Tipo:
boolean optionalPadrão:
trueSe as sobreposições de tela serão renderizadas. |
suppressInfoWindows optional |
Tipo:
boolean optionalRemove a renderização de janelas de informações quando elementos da camada são clicados. |
url optional |
Tipo:
string optionalO URL do documento KML a ser mostrado. |
zIndex optional |
Tipo:
number optionalO z-index da camada. |
Interface KmlLayerMetadata
Interface google.maps.KmlLayerMetadata
Metadados para uma única camada KML, no formato JSON.
Propriedades | |
|---|---|
description |
Tipo:
stringO <description> da camada, extraído da marcação dela. |
hasScreenOverlays |
Tipo:
booleanSe a camada tem sobreposições de tela. |
name |
Tipo:
stringO <name> da camada, extraído da marcação dela. |
snippet |
Tipo:
stringO <Snippet> da camada, extraído da marcação da camada |
author optional |
Tipo:
KmlAuthor optionalO <atom:author> da camada, extraído da marcação dela. |
Constantes KmlLayerStatus
Constantes de google.maps.KmlLayerStatus
O status retornado por KmlLayer ao concluir o carregamento de um documento. Especifique-os por valor ou usando o nome da constante. Por exemplo, 'OK' ou google.maps.KmlLayerStatus.OK.
Acesse ligando para const {KmlLayerStatus} = await google.maps.importLibrary("maps").
Consulte Bibliotecas na API Maps JavaScript.
Constantes | |
|---|---|
DOCUMENT_NOT_FOUND |
Não foi possível encontrar o documento. Provavelmente, o URL é inválido ou o documento não está disponível publicamente. |
DOCUMENT_TOO_LARGE |
O documento excede os limites de tamanho de arquivo do KmlLayer. |
FETCH_ERROR |
Não foi possível buscar o documento. |
INVALID_DOCUMENT |
O documento não é um KML, KMZ ou GeoRSS válido. |
INVALID_REQUEST |
O KmlLayer é inválido. |
LIMITS_EXCEEDED |
O documento excede os limites de recursos de KmlLayer. |
OK |
A camada foi carregada. |
TIMED_OUT |
O documento não foi carregado em um período razoável de tempo. |
UNKNOWN |
O documento não foi carregado por um motivo desconhecido. |
Interface KmlMouseEvent
Interface google.maps.KmlMouseEvent
As propriedades de um evento de clique em um documento KML/KMZ ou GeoRSS.
Propriedades | |
|---|---|
featureData |
Tipo:
KmlFeatureDataUm objeto KmlFeatureData que contém informações sobre o recurso clicado. |
latLng |
Tipo:
LatLngA posição à qual ancorar uma janela de informações no elemento clicado. |
pixelOffset |
Tipo:
SizeO deslocamento a ser aplicado a uma janela de informações ancorada no elemento clicado. |
Interface KmlFeatureData
Interface google.maps.KmlFeatureData
Dados para um único elemento KML no formato JSON, retornados quando um elemento KML é clicado. Os dados contidos neste objeto refletem os dados associados ao elemento na marcação KML ou GeoRSS na qual o objeto é declarado.
Propriedades | |
|---|---|
author |
Tipo:
KmlAuthorO <atom:author> do recurso, extraído da marcação da camada (se especificado). |
description |
Tipo:
stringO <description> do recurso, extraído da marcação da camada. |
id |
Tipo:
stringO <id> do recurso, extraído da marcação da camada. Se nenhum <id> for especificado, um ID exclusivo será gerado para esse recurso. |
infoWindowHtml |
Tipo:
stringO texto do elemento no estilo de balão, se estiver definido. |
name |
Tipo:
stringO <name> do recurso, extraído da marcação da camada. |
snippet |
Tipo:
stringO <Snippet> do recurso, extraído da marcação da camada. |
Interface KmlAuthor
Interface google.maps.KmlAuthor
Contém detalhes do autor de um documento ou elemento KML.
Propriedades | |
|---|---|
email |
Tipo:
stringO endereço de e-mail do autor ou uma string vazia se o endereço não tiver sido especificado. |
name |
Tipo:
stringO nome do autor ou uma string vazia se o nome não tiver sido especificado. |
uri |
Tipo:
stringA página inicial do autor ou uma string vazia se a página inicial não tiver sido especificada. |