KML

Classe KmlLayer

google.maps.KmlLayer classe
estende MVCObject
biblioteca "maps"

Descontinuado: a partir da versão 3.65, o google.maps.KmlLayer foi descontinuado. Para conhecer métodos alternativos de exibição de dados KML no mapa, acesse https://developers.devsite.corp.google.com/maps/deprecations#kml_layer_deprecated_as_of_april_30_2026.

const {KmlLayer} = await google.maps.importLibrary("maps");

Construtor
KmlLayer	KmlLayer([opts]) Parâmetros: opts: opções de KmlLayerOptions optional para essa camada. Cria um KmlLayer que renderiza o conteúdo do arquivo KML/KMZ (https://developers.google.com/kml/documentation/kmlreference) ou GeoRSS (http://www.georss.org) especificado.

Métodos
getDefaultViewport	getDefaultViewport() Parâmetros: nenhum Valor de retorno: LatLngBounds|null Obtenha a janela de visualização padrão da camada sendo exibida.
getMap	getMap() Parâmetros: nenhum Valor de retorno: Map|null Obtém o mapa no qual a camada KML está sendo renderizada.
getMetadata	getMetadata() Parâmetros: nenhum Valor de retorno: KmlLayerMetadata|null Obtém os metadados associados a esta camada, como especificado na marcação da camada.
getStatus	getStatus() Parâmetros: nenhum Valor de retorno: KmlLayerStatus|null Recebe o status da camada, definido depois que o documento solicitado é carregado.
getUrl	getUrl() Parâmetros: nenhum Valor de retorno: URL de 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: map: Map optional 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: options: KmlLayerOptions optional Valor de retorno: nenhum
setUrl	setUrl(url) Parâmetros: url: string Valor de retorno: nenhum Define o URL do arquivo KML que será exibido.
setZIndex	setZIndex(zIndex) Parâmetros: zIndex: number o z-index a ser definido. Valor de retorno: nenhum Define o índice z da camada KML.
Herdado: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll

Eventos
click	function(kmlClickEvent) Argumentos: kmlClickEvent: KmlMouseEvent 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 opcional	Tipo: boolean optional Padrão: true Se for true, a camada vai receber eventos de mouse.
map opcional	Tipo: Map optional O mapa no qual exibir a camada.
preserveViewport opcional	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 opcional	Tipo: boolean optional Padrão: true Define se as sobreposições de tela serão renderizadas.
suppressInfoWindows opcional	Tipo: boolean optional Remove a renderização de janelas de informações quando elementos da camada são clicados.
url opcional	Tipo: string optional O URL do documento KML a ser exibido.
zIndex opcional	Tipo: number optional O z-index 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 dela.
hasScreenOverlays	Tipo: boolean Se a camada tem sobreposições de tela.
name	Tipo: string O <name> da camada, extraído da marcação dela.
snippet	Tipo: string O <Snippet> da camada, extraído da marcação dela.
author opcional	Tipo: KmlAuthor optional O <atom:author> da camada, extraído da marcação dela.

Constantes KmlLayerStatus

google.maps.KmlLayerStatus biblioteca de constantes
"maps"

O status retornado por KmlLayer após a conclusão do carregamento de um documento. Especifique-os por valor ou usando o nome da constante. Por exemplo, 'OK' ou google.maps.KmlLayerStatus.OK.

Essas constantes também podem ser usadas como strings. No TypeScript, os literais de string são definidos pelo tipo KmlLayerStatusString.

const {KmlLayerStatus} = await google.maps.importLibrary("maps");

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 de 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	Não foi possível carregar o documento em um período razoável.
UNKNOWN	Não foi possível carregar o documento 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 elemento 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 da camada.
id	Tipo: string O <id> do elemento, extraído da marcação da 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 da camada.
snippet	Tipo: string O <Snippet> do elemento, 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: 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.