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 elemento quando clicado.
Essa classe estende MVCObject
.
Acesse chamando 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 do arquivo GeoRSS (http://www.georss.org). |
Métodos | |
---|---|
getDefaultViewport | getDefaultViewport() Parâmetros:nenhum Valor de retorno: LatLngBounds Obtenha a janela de visualização padrão da camada sendo exibida. |
getMap | getMap() Parâmetros:nenhum Valor de retorno: Map Obtém o mapa no qual a camada KML está sendo renderizada. |
getMetadata | getMetadata() Parâmetros:nenhum Valor de retorno: KmlLayerMetadata Obtém os metadados associados a esta camada, como especificado na marcação da camada. |
getStatus | getStatus() Parâmetros:nenhum Valor de retorno: KmlLayerStatus Receber o status da camada, definido quando o documento solicitado é carregado. |
getUrl | getUrl() Parâmetros:nenhum Valor de retorno:URL string Recebe o URL do arquivo KML que está sendo exibido. |
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 for 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. Nesse 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 optional Padrão: true Se true , a camada recebe eventos de mouse. |
map optional | Tipo: Map optional O mapa no qual exibir a camada. |
preserveViewport optional | Tipo: boolean optional Padrão: false Se essa opção for 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 optional Padrão: true Se as sobreposições de tela serão renderizadas. |
suppressInfoWindows optional | Tipo: boolean optional Remove a renderização de janelas de informações quando elementos da camada são clicados. |
url optional | Tipo: string optional O URL do documento KML a ser mostrado. |
zIndex optional | Tipo: number optional O índice Z da camada. |
Interface KmlLayerMetadata
Interface google.maps.KmlLayerMetadata
Metadados para uma única camada KML, no formato JSON.
Propriedades | |
---|---|
description | Tipo: string O <description> da camada, extraído da marcação da camada. |
hasScreenOverlays | Tipo: boolean Se a camada tem sobreposições de tela. |
name | Tipo: string O <name> da camada, extraído da marcação da camada. |
snippet | Tipo: string O <Snippet> da camada, extraído da marcação da camada |
author optional | Tipo: KmlAuthor optional O <atom:author> da camada, extraído da marcação da camada. |
Constantes KmlLayerStatus
Constantes google.maps.KmlLayerStatus
O status retornado por KmlLayer
ao concluir o carregamento de um documento. Especifique esses valores pelo valor ou usando o nome da constante. Por exemplo, 'OK'
ou google.maps.KmlLayerStatus.OK
.
Acesse chamando 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. É provável que o URL seja inválido ou que o documento não esteja disponível publicamente. |
DOCUMENT_TOO_LARGE | O documento excede os limites de tamanho de arquivo da 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 elementos da KmlLayer. |
OK | A camada foi carregada. |
TIMED_OUT | Não foi possível carregar o documento em um período razoável. |
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: KmlFeatureData Um objeto KmlFeatureData que contém informações sobre o recurso clicado. |
latLng | Tipo: LatLng A posição à qual ancorar uma janela de informações no elemento clicado. |
pixelOffset | Tipo: Size O 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: KmlAuthor O <atom:author> do elemento, extraído da marcação da camada (se especificado). |
description | Tipo: string O <description> do elemento, extraído da marcação de camada. |
id | Tipo: string O <id> do elemento, extraído da marcação de camada. Se nenhum <id> tiver sido especificado, um ID exclusivo será gerado para esse recurso. |
infoWindowHtml | Tipo: string O texto do elemento no estilo de balão, se estiver definido. |
name | Tipo: string O <name> do elemento, extraído da marcação de camada. |
snippet | Tipo: string O <Snippet> do elemento, extraído da marcação de camada. |
Interface KmlAuthor
Interface google.maps.KmlAuthor
Contém detalhes do autor de um documento ou elemento KML.
Propriedades | |
---|---|
email | Tipo: string O endereço de e-mail do autor ou uma string vazia se o endereço não tiver sido especificado. |
name | Tipo: string O nome do autor ou uma string vazia se o nome não tiver sido especificado. |
uri | Tipo: string A página inicial do autor ou uma string vazia se a página inicial não tiver sido especificada. |