My favorites | Português | Sign in

Referência da API do Google Maps

A API do Google Maps agora está integrada com o Carregador da API AJAX do Google, que cria um namespace em comum para o carregamento e uso de várias APIs AJAX do Google. Essa estrutura permite usar um espaço para nome google.maps.* opcional para todas as classes, métodos e propriedades usadas atualmente na API do Google Maps, substituindo o prefixo usual G por esse espaço para nome. Não se preocupe: o espaço para nome G existente continuará a ser aceito.


Por exemplo, o objeto GMap2 dentro da API do Google Maps também pode ser definido como google.maps.Map2.


Esta documentação de referência aborda apenas o espaço para nome G existente.

Se você deseja usar o mapa somente para exibir seu conteúdo, precisará conhecer estas classes, tipos e funções:

Para estender a funcionalidade da API de mapas por meio da implementação dos seus próprios controles, sobreposições ou tipos de mapas, você precisa conhecer também estas classes e tipos:

classe GMap2

Instancie a classe GMap2 para criar um mapa. Esta é a classe central da API. Todo o restante serve apenas para auxílio.

Construtor

Construtor Descrição
GMap2(container:Node, opts?:GMapOptions) Cria um novo mapa dentro do recipiente de HTML especificado, geralmente um elemento DIV. Se nenhum conjunto de tipos de mapas for especificado no argumento opts.mapTypes opcional, o conjunto padrão G_DEFAULT_MAP_TYPES será usado. Se nenhum tamanho for especificado no argumento opts.size opcional, o tamanho do container será usado. Se opts.size for especificado, o elemento recipiente do mapa será redimensionado conforme o apropriado. Consulte class GMapOptions. Observação: Um Mapa precisa ser centralizado para que você possa usá-lo. Você deve chamar GMap2.setCenter() imediatamente para inicializar um mapa criado com este construtor.

Métodos

Configuração

Método Valor de retorno Descrição
enableDragging() None Permite que o mapa seja arrastado (ativado por padrão).
disableDragging() None Impede que o mapa seja arrastado.
draggingEnabled() Boolean Retorna true se o recurso para arrastar o mapa estiver ativado.
enableInfoWindow() None Permite operações na janela de informações do mapa (ativado por padrão).
disableInfoWindow() None Fecha a janela de informações, se estiver aberta, e desativa a abertura de uma nova janela de informações.
infoWindowEnabled() Boolean Retorna true se a janela de informações estiver ativada.
enableDoubleClickZoom() None Ativa o aumento ou a diminuição de zoom por meio do clique duplo (ativado por padrão).

(Desde a versão 2.58)

disableDoubleClickZoom() None Desativa o aumento ou a diminuição de zoom através do clique duplo.

(Desde a versão 2.58)

doubleClickZoomEnabled() Boolean Retorna true se o zoom por meio de clique duplo estiver ativado.

(Desde a versão 2.58)

enableContinuousZoom() None Ativa o zoom suave contínuo para navegadores selecionados (desativado por padrão).

(Desde a versão 2.58)

disableContinuousZoom() None Desativa o zoom suave contínuo.

(Desde a versão 2.58)

continuousZoomEnabled() Boolean Retorna true se o zoom suave contínuo estiver ativado.

(Desde a versão 2.58)

enableGoogleBar() None Ativa o GoogleBar (um controle de pesquisa integrado) no mapa. Quando ativado, esse controle ocupa a posição do logotipo padrão Powered by Google. Mas ele não é ativado por padrão.

(Desde a versão 2.92)

disableGoogleBar() None Desativa o controle de pesquisa integrado GoogleBar. Quando está desativado, o logotipo padrão Powered by Google ocupa a posição anteriormente ocupada por esse controle. Esse controle já está desativado por padrão.

(Desde a versão 2.92)

enableScrollWheelZoom() None Ativa o zoom através da roda de rolagem do mouse. Observação: O zoom pela roda de rolagem está desativado por padrão.

(Desde a versão 2.78)

disableScrollWheelZoom() None Desativa o zoom através da roda de rolagem do mouse. Observação: O zoom pela roda de rolagem está desativado por padrão.

(Desde a versão 2.78)

scrollWheelZoomEnabled() Boolean Retorna um valor Boleano que indica se o zoom por meio da roda de rolagem está ativado.

(Desde a versão 2.78)

Controles

Método Valor de retorno Descrição
addControl(control:GControl, position?:GControlPosition) None Adiciona o controle ao mapa. A posição no mapa é determinada pelo argumento position opcional. Se esse argumento for omitido, será usada a posição padrão do controle, conforme determinada pelo método GControl.getDefaultPosition(). Não adicione a instância do controle mais de uma vez ao mapa.
removeControl(control:GControl) None Remove o controle do mapa. Não terá nenhum efeito se o controle não tiver sido adicionado ao mapa.
getContainer() Node Retorna o objeto DOM que contém o mapa. Usado por GControl.initialize().

Tipos de mapa

Método Valor de retorno Descrição
getMapTypes() GMapType[] Retorna a matriz dos tipos de mapa registrados neste mapa.
getCurrentMapType() GMapType Retorna o tipo de mapa selecionado no momento.
setMapType(type:GMapType) None Seleciona o novo tipo de mapa fornecido. O tipo deve ser conhecido pelo mapa. Consulte o construtor e o método addMapType().
addMapType(type:GMapType) None Adiciona um novo tipo de mapa ao mapa. Consulte a seção GMapType para saber como definir os tipos de mapa personalizados.
removeMapType(type:GMapType) None Remove o tipo de mapa do mapa. Atualiza o conjunto de botões exibidos por GMapTypeControl ou GHierarchicalMapTypeControl e dispara o evento removemaptype.

Estado do mapa

Método Valor de retorno Descrição
isLoaded() Boolean Retorna true se o mapa tiver sido inicializado por setCenter() desde que foi criado.
getCenter() GLatLng Retorna as coordenadas geográficas do ponto central da visualização do mapa.
getBounds() GLatLngBounds Retorna a região retangular visível da visualização do mapa em coordenadas geográficas.
getBoundsZoomLevel(bounds:GLatLngBounds) Number Retorna o nível de zoom em que uma determinada região retangular se ajusta à visualização do mapa. O nível de zoom é calculado para o tipo de mapa selecionado no momento. Se nenhum tipo de mapa estiver selecionado, será usado a primeira opção da lista de tipos de mapa.
getSize() GSize Retorna o tamanho da visualização do mapa em pixels.
getZoom() Number Retorna o nível de zoom atual.
getDragObject() GDraggableObject Retorna o objeto arrastável usado por este mapa.

(Desde a versão 2.93)

getEarthInstance(callback:Function(instance: GEPlugin)) None Recupera a instância do Plug-in do navegador do Google Earth anexado a este mapa. Além disso, chama a função de retorno de chamada informada assim que a instância estiver pronta para receber comandos, passando a instância da Terra (um objeto GEPlugin) como parâmetro.

Esta função de retorno de chamada pode ser disparada imediatamente se a instância da Terra tiver sido instanciada anteriormente pela configuração do tipo de mapa do Google Earth por GMap2.setMapType(G_SATELLITE_3D_MAP). Se a instância ainda não tiver sido criada, a chamada de getEarthInstance inicializará o Plug-in do Google Earth. Esse comportamento assíncrono é o motivo pelo qual este método exige um retorno de chamada.

Observação: Se a inicialização encontrar um erro, a função de retorno de chamada irá passar um parâmetro null.

Embora esse método crie uma instância da Terra, ele não definirá o tipo de mapa da Terra como a visualização atual. Para fazer isso, chame GMap2.setMapType(G_SATELLITE_3D_MAP) explicitamente ou permita que o usuário selecione este tipo de mapa por meio do MapTypeControl. Consulte o Guia do desenvolvedor da API do Google Earth para obter detalhes sobre como usar o objeto GEPlugin.

(Desde a versão 2.113)

Modificar o estado do mapa

Método Valor de retorno Descrição
setCenter(center:GLatLng, zoom?:Number, type?:GMapType) None Define a visualização do mapa no centro especificado. Opcionalmente, também define o nível de zoom e o tipo de mapa. O tipo de mapa deve ser conhecido pelo mapa. Consulte o construtor e o método addMapType(). Este método deverá ser chamado imediatamente após a construção para definir o estado inicial do mapa. É um erro chamar operações em um objeto GMap2 recentemente construído antes que essa função seja chamada.
panTo(center:GLatLng) None Altera o ponto central do mapa para o ponto especificado. Se o ponto já estiver aparecendo na visualização atual do mapa, altera o centro com uma animação suave.
panBy(distance:GSize) None Inicia uma animação panorâmica percorrendo a distância especificada em pixels.
panDirection(dx:one of -1 0 +1, dy:one of -1 0 +1) None Inicia uma animação panorâmica percorrendo metade da largura do mapa nas direções indicadas. +1 para a direita e para baixo, -1 para a esquerda e para cima, respectivamente.
setZoom(level:Number) None Define o nível de zoom com o novo valor especificado.
zoomIn() None Aumenta o nível de zoom em uma unidade.
zoomOut() None Diminui o nível de zoom em uma unidade.
savePosition() None Armazena a posição do mapa e o nível de zoom atuais, para reutilização posterior por returnToSavedPosition().
returnToSavedPosition() None Restaura a visualização do mapa salva por savePosition().
checkResize() None Notifica o mapa sobre uma alteração de tamanho em seu recipiente. Chame este método depois que o tamanho do objeto DOM do recipiente for alterado, para que o mapa possa se ajustar ao novo tamanho.

Sobreposições

Método Valor de retorno Descrição
addOverlay(overlay:GOverlay) None Adiciona uma sobreposição ao mapa e dispara o evento addoverlay.
removeOverlay(overlay:GOverlay) None Remove a sobreposição do mapa. É um erro tentar remover uma sobreposição que não está no mapa. Se a chamada tiver êxito, o evento removeoverlay será disparado.
clearOverlays() None Remove todas as sobreposições do mapa e dispara o evento clearoverlays.
getPane(pane:GMapPane) Node Retorna um DIV que mantém o objeto na camada identificada por pane. Usado por instâncias GOverlay nas instâncias do método GOverlay.initialize() de modo a se desenharem no mapa.

Janela de informações

Método Valor de retorno Descrição
openInfoWindow(latlng:GLatLng, node:Node, opts?:GInfoWindowOptions) None Abre uma janela de informações simples no ponto especificado. Desloca o mapa de forma que a janela de informações aberta fique totalmente visível. O conteúdo da janela de informações é fornecido como um nó DOM.
openInfoWindowHtml(latlng:GLatLng, html:String, opts?:GInfoWindowOptions) None Abre uma janela de informações simples no ponto especificado. Desloca o mapa de forma que a janela de informações aberta fique totalmente visível. O conteúdo da janela de informações é fornecido como texto HTML.
openInfoWindowTabs(latlng:GLatLng, tabs:GInfoWindowTab[], opts?:GinfoWindowOptions) None Abre uma janela de informações com guias no ponto especificado. Desloca o mapa de forma que a janela de informações aberta fique totalmente visível. O conteúdo da janela de informações é apresentado como nós DOM.
openInfoWindowTabsHtml(latlng:GLatLng, tabs:GInfoWindowTab[], opts?:GInfoWindowOptions) None Abre uma janela de informações com guias no ponto especificado. Desloca o mapa de forma que a janela de informações aberta fique totalmente visível. O conteúdo da janela de informações é fornecido como texto HTML.
showMapBlowup(latlng:GLatLng, opts?:GInfoWindowOptions) None Abre uma janela de informações no ponto especificado que contém uma visualização ampliada do mapa ao redor desse ponto.
updateInfoWindow(tabs:GInfoWindowTab[], onupdate?:Function) None Atualiza o conteúdo do objeto GInfoWindow aberto no momento, sem alterar a posição. A janela de informações é redimensionada para se ajustar ao novo conteúdo. A função de retorno onupdate opcional é chamada depois que o conteúdo da janela de informações é alterado de fato.

(Desde a versão 2.85)

updateCurrentTab(modifier:Function, onupdate?:Function) None Atualiza a guia selecionada no momento, causando o redimensionamento do objeto GInfoWindow, mas sem alterar a posição. A função modifier é usada para modificar a guia selecionada no momento e um uma GInfoWindowTab é informada como argumento. A função de retorno onupdate opcional é chamada depois que a janela de informações exibe o novo conteúdo.

(Desde a versão 2.85)

closeInfoWindow() None Fecha a janela de informações aberta no momento.
getInfoWindow() GInfoWindow Retorna o objeto da janela de informações deste mapa. Caso ainda não haja uma janela de informações, ela será criada, mas não exibida. Esta operação não é afetada por enableInfoWindow().

Transformações das coordenadas

Método Valor de retorno Descrição
fromContainerPixelToLatLng(pixel:GPoint) GLatLng Calcula as coordenadas geográficas do ponto correspondente às coordenadas de pixel especificadas no elemento DOM que contém o mapa da página. Útil para implementar a interação de controles personalizados no mapa.
fromLatLngToContainerPixel(latlng:GLatLng) GPoint Calcula as coordenadas de pixel do ponto geográfico especificado no elemento DOM que contém o mapa da página.

(Desde a versão 2.100)

fromLatLngToDivPixel(latlng:GLatLng) GPoint Calcula as coordenadas de pixels do ponto geográfico especificado no elemento DOM que contém o mapa arrastável. Você precisará deste método para posicionar uma sobreposição personalizada ao implementar o método GOverlay.redraw() para uma sobreposição personalizada.
fromDivPixelToLatLng(pixel:GPoint) GLatLng Calcula as coordenadas geográficas a partir das coordenadas de pixel no div que contém o mapa arrastável. Pode ser útil para implementar a interação com sobreposições personalizadas que não estendem a interface GOverlay. Caso isso não proporcione o resultado esperado, tente o método fromContainerPixelToLatLng.

Eventos

Evento Descrição
addmaptype(type:GMapType) Este evento é disparado quando um tipo de mapa é adicionado ao mapa.
removemaptype(type:GMapType) Este evento é disparado quando um tipo de mapa é removido do mapa.
click(overlay:GOverlay, latlng:GLatLng, overlaylatlng:GLatLng) Este evento é disparado quando o usuário clica no mapa com o mouse. Um evento click passa argumentos diferentes com base no contexto do clique e considera se o clique ocorreu ou não em uma sobreposição clicável. Se o clique não tiver ocorrido em uma sobreposição cliclável, o argumento overlay será null e o argumento latlng irá conter as coordenadas geográficas do ponto clicado. Se o usuário clicar em uma sobreposição clickable (que pode ser clicada), como GMarker, GPolygon, GPolyline ou GInfoWindow, o argumento overlay irá conter o objeto da sobreposição, enquanto o argumento overlaylatlng irá conter as coordenadas da sobreposição clicada. Além disso, um evento click também é disparado na própria sobreposição.
dblclick(overlay:GOverlay, latlng:GLatLng) Este evento é disparado quando se clica duas vezes no mapa. Esse evento não será disparado se o clique duplo ocorrer em um marcador ou em outra sobreposição clicável. As coordenadas geográficas do ponto que recebeu clique duplo serão passadas no argumento latlng. O argumento overlay é sempre definido como null.

(Desde a versão 2.83)

singlerightclick(point:GPoint, src:Element, overlay?:GOverlay) Este evento é disparado quando o evento contextmenu DOM é disparado no recipiente do mapa. Se o clique com o botão direito do mouse ocorrer em um marcador ou em outra sobreposição clicável, a sobreposição será passada ao manipulador de evento no argumento overlay. As coordenadas de pixel (no elemento DOM que contém o mapa) do ponto clicado com o botão direito do mouse e do elemento de origem do evento DOM são passados nos argumentos point e src, respectivamente. Se ocorrer um clique duplo com o botão direito do mouse e o zoom por meio de clique duplo estiver ativado, ocorrerá a diminuição do zoom no mapa e nenhum evento singlerightclick será disparado. No entanto, se o zoom através de clique duplo estiver desativado, dois eventos singlerightclick serão disparados.

(Desde a versão 2.84)

movestart() Este evento é disparado quando a visualização do mapa começa a mudar. Isso pode ser causado por arrastamento, caso em que um evento dragstart também é disparado, ou pela chamada de um método que altera a visualização do mapa.
move() Este evento é disparado, possivelmente várias vezes, enquanto a visualização do mapa estiver sendo alterada.
moveend() Este evento é disparado quando a alteração da visualização do mapa é encerrada.
zoomend(oldLevel:Number, newLevel:Number) Este evento é disparado quando o mapa atinge um novo nível de zoom. O manipulador de evento recebe os níveis de zoom anterior e novo na forma de argumentos.
maptypechanged() Este evento é disparado quando outro tipo de mapa é selecionado.
infowindowopen() Este evento é disparado quando a janela de informações é aberta.
infowindowbeforeclose() Este evento é disparado antes que a janela de informações seja fechada.

(Desde a versão 2.83)

infowindowclose() Este evento é disparado quando a janela de informações é fechada. O evento infowindowbeforeclose é disparado antes deste evento. Se uma janela de informações aberta no momento for reaberta em outro ponto usando outra chamada para openInfoWindow*(), os eventos infowindowbeforeclose, infowindowclose e infowindowopen serão disparados nessa ordem.
addoverlay(overlay:GOverlay) Este evento é disparado quando uma única sobreposição é adicionada pelo método addOverlay(). A nova sobreposição é passada como um argumento overlay para o manipulador de evento.
removeoverlay(overlay:GOverlay) Este evento é disparado quando uma única sobreposição é removida pelo método removeOverlay(). A sobreposição removida é passada como um argumento overlay para o manipulador de evento.
clearoverlays() Este evento é disparado quando todas as sobreposições são removidas simultaneamente pelo método clearOverlays().
mouseover(latlng:GLatLng) Este evento é disparado quando o usuário move o mouse sobre o mapa a partir de um ponto exterior a ele.
mouseout(latlng:GLatLng) Este evento é disparado quando o usuário move o mouse para fora do mapa.
mousemove(latlng:GLatLng) Este evento é disparado quando o usuário move o mouse dentro do mapa.
dragstart() Este evento é disparado quando o usuário começa a arrastar o mapa.
drag() Este evento é disparado repetidamente enquanto o usuário arrasta o mapa.
dragend() Este evento é disparado quando o usuário para de arrastar o mapa.
load() Este evento é disparado quando a configuração do mapa está concluída e isLoaded() retorna true. Isso significa que posição, zoom e tipo de mapa foram inicializados, mas as partes de imagens podem ainda estar sendo carregadas.

(Desde a versão 2.52)

classe GMapOptions

Esta classe representa os argumentos opcionais para o construtor GMap2. Essa classe não possui construtor, mas é instanciada como literal de objeto.

Propriedades

Propriedade Tipo Descrição
size GSize Define o tamanho do mapa em pixels. O recipiente passado ao construtor do mapa será redimensionado conforme o tamanho especificado. Por padrão, o mapa assumirá o tamanho de seu recipiente.
mapTypes GMapType[] Matriz de tipos de mapa a serem usados por este mapa. Por padrão, G_DEFAULT_MAP_TYPES é usado. Você pode usar essa opção para limitar o conjunto de tipos de mapa predefinidos exibidos no mapa ou passar seus próprios tipos de mapa para o mapa. Consulte também GMap2.addMapType().
draggableCursor String Cursor a ser exibido quando o mapa estiver com a propriedade arrastável ativada.

(Desde a versão 2.59)

draggingCursor String Cursor exibido enquanto o mapa estiver sendo arrastado.

(Desde a versão 2.59)

googleBarOptions GGoogleBarOptions Esta propriedade especifica as opções para configurar o controle de pesquisa GGoogleBar. Essas opções são passadas para o literal de objeto GMapOptions durante a construção do mapa e são usadas para a construção do controle GGoogleBar local quando GMap2.enableGoogleBar() é chamado.

(Desde a versão 2.95)

backgroundColor String Esta propriedade especifica a cor a ser exibida atrás dos blocos do mapa. A cor pode ser qualquer valor de cor padrão W3C válido.

(Desde a versão 2.119)

classe GGoogleBarOptions

Esta classe representa as opções passadas ao parâmetro googleBarOptions para o objeto GMapOptions. Essa classe não possui construtor, mas é instanciada como literal de objeto. O objeto GGoogleBar, como o GInfoWindow não é construído, mas é anexado automaticamente ao objeto do mapa e ativado pelas propriedades descritas aqui.

Propriedades

Propriedade Tipo Descrição
showOnLoad Boolean Quando definida como verdadeira, esta propriedade exibe a caixa de pesquisa dentro de GoogleBar (desde que o controle esteja ativado e o mapa carregado). Por padrão, a caixa de pesquisa fica oculta dentro do controle e só se expande com o clique na lente de aumento do controle.

(Desde a versão 2.95)

linkTarget GGoogleBarLinkTarget Esta propriedade permite especificar o destino dos links incorporados nos resultados de pesquisa de GoogleBar. O valor padrão, G_GOOGLEBAR_LINK_TARGET_BLANK, especifica que os links serão abertos em uma nova janela.

(Desde a versão 2.95)

resultList GGoogleBarResultList or Element Esta propriedade permite especificar o estilo da lista de resultados de pesquisa para a GoogleBar, que pode ser um dos seguintes: G_GOOGLEBAR_RESULT_LIST_INLINE (padrão) coloca a lista de resultados em uma tabela acima da caixa de pesquisa, G_GOOGLEBAR_RESULT_LIST_SUPPRESS substitui a lista por um conjunto de botões próximo/anterior e, ao passar um DOM de nível de bloqueio, Element coloca a lista em um recipiente da sua escolha (normalmente um elemento <div>).

(Desde a versão 2.95)

suppressInitialResultSelection Boolean Esta propriedade suprime a exibição do primeiro resultado em sua própria janela de informações na conclusão de uma pesquisa na GoogleBar (comportamento padrão).

(Desde a versão 2.95)

suppressZoomToBounds Boolean Esta propriedade suprime a visão panorâmica e o zoom automáticos do conjunto de resultados na conclusão de uma pesquisa na GoogleBar. Esta propriedade substitui o comportamento padrão.

(Desde a versão 2.95)

onIdleCallback Function Esta propriedade especifica uma função de retorno que será invocada quando a GoogleBar terminar a pesquisa e os respectivos resultados forem fechados.

(Desde a versão 2.95)

onSearchCompleteCallback Function Esta propriedade especifica uma função de retorno que será invocada quando a GoogleBar terminar a pesquisa e ela for concluída. O objeto associado será passado através do controle de pesquisa. GlocalSearch Esta função de retorno é chamada antes que os resultados sejam colocados no mapa ou na lista de resultados.

(Desde a versão 2.95)

onGenerateMarkerHtmlCallback Function Esta propriedade permite especificar uma função de retorno que será invocada quando for aberta a janela de informações do marcador de resultado da pesquisa. Esta função deve receber um GMarker, a string HTML gerada e um GlocalSearchResult (nessa ordem) e deve retornar a string HTML modificada a ser exibida na janela de informações.

(Desde a versão 2.95)

onMarkersSetCallback Function Esta propriedade permite especificar uma função de retorno que será invocada quando GGoogleBar concluir a criação de seus marcadores e colocá-los no mapa. É preciso passar para esta função uma matriz de objetos no formato {result: GlocalSearch, marker: GMarker}.

(Desde a versão 2.95)

enum GGoogleBarListingTypes

Estas constantes restringem o tipo de resultados retornados por uma pesquisa local com a GGoogleBar. O comportamento desta pesquisa é definido na propriedade GGoogleBarOptions.listingTypes.

Constantes

Constante Descrição
G_GOOGLEBAR_TYPE_BLENDED_RESULTS Esta constante indica que as pesquisas a partir da GGoogleBar do mapa devem retornar todos os tipos de resultados (KML, comerciais, geocódigos etc).

(Desde a versão 2.113)

G_GOOGLEBAR_TYPE_KMLONLY_RESULTS Esta constante indica que as pesquisas da GGoogleBar do mapa devem retornar apenas os resultados de arquivos KML/KMZ/GeoRSS indexados.

(Desde a versão 2.113)

G_GOOGLEBAR_TYPE_LOCALONLY_RESULTS Esta constante indica que as pesquisas da GGoogleBar do mapa devem retornar apenas resultados comerciais e geocódigos.

(Desde a versão 2.113)

enum GGoogleBarLinkTarget

Estas constantes são passadas através de GGoogleBarOptions.linkTarget e definem o destino padrão dos links nas janelas de informações de resultado.

Constantes

Constante Descrição

enum GGoogleBarResultList

Estas constantes são passadas através de GGoogleBarOptions.resultList e definem como é exibida a lista de resultados.

Constantes

Constante Descrição
G_GOOGLEBAR_RESULT_LIST_INLINE Corresponde ao estilo padrão, no qual a lista de resultados é exibida em forma de tabela no mapa.
G_GOOGLEBAR_RESULT_LIST_SUPPRESS Isso corresponde ao estilo padrão, no qual a lista de resultados fica oculta e é substituída pelos botões próximo/anterior..

enum GMapPane

Estas constantes definem a ordem de empilhamento ("ordem z") usada pelo mapa e pelos objetos no mapa para fins de exibição. Cada painel define um conjunto de objetos de exibição similares a serem mostrados no mapa e cada painel define uma "ordem z" exclusiva no mapa. Os painéis com "ordem z" mais alta são exibidos acima daqueles com uma "ordem z" mais baixa. Os objetos em um determinado painel também podem exibir suas próprias preferências de "ordem-z". Certos objetos podem aparecer acima de outros nesse painel.

Se você fizer a subclassificação a partir de GOverlay, será necessário usar essas constantes de modo a colocar sua sobreposição personalizada em um dos painéis.

As seguintes constantes estão listadas em ordem a partir da menor "ordem z" (final) até a maior (início).

Constantes

Constante Descrição
G_MAP_MAP_PANE Este painel é o painel mais baixo e está acima dos blocos.
G_MAP_OVERLAY_LAYER_PANE Este painel contém polilinhas, polígonos, sobreposições de solo e sobreposições de camada de blocos.

(Desde a versão 2.127)

G_MAP_MARKER_SHADOW_PANE Este painel contém as sombras do marcador.
G_MAP_MARKER_PANE Este painel contém as imagens em primeiro plano do marcador.
G_MAP_FLOAT_SHADOW_PANE Este painel contém o sombreamento da janela de informações. Ele fica acima do G_MAP_MARKER_PANE, de modo que os marcadores fiquem na sombra da janela de informações.
G_MAP_MARKER_MOUSE_TARGET_PANE Este painel contém elementos transparentes que recebem eventos de mouse DOM para os marcadores. Ele fica acima do G_MAP_FLOAT_SHADOW_PANE, de modo que os marcadores sombra da janela de informações possam ser clicados.
G_MAP_FLOAT_PANE O painel contém a janela de informações. Está acima de todas as sobreposições do mapa.

classe GKeyboardHandler

Instancie esta classe para adicionar teclas de atalho a um mapa. As teclas de atalho são as mesmas que existem no aplicativo de mapas.

Tecla(s) Ação
para cima, para baixo, para a esquerda, para a direita Move o mapa continuamente enquanto a tecla está sendo pressionada. É possível pressionar duas teclas simultaneamente para fazer movimento diagonal.
page down, page up, home, end Mostra a panorâmica do mapa em 3/4 do tamanho na direção correspondente, com uma bela animação. Corresponde aos botões de seta em GLargeMapControl e GSmallMapControl.
+, - Aumenta ou diminui um nível de zoom, respectivamente. Corresponde aos botões + e - em GLargeMapControl e GSmallMapControl.

Construtor

Construtor Descrição
GKeyboardHandler(map:GMap2) Instala o manipulador de evento do teclado para o mapa passado como argumento.

interface GOverlay

Esta interface é implementada pelas classes GMarker, GPolyline, GTileLayerOverlay e GInfoWindow na biblioteca da API de mapas. Você poderá implementá-la se quiser exibir tipos personalizados de objetos sobreposição no mapa. Uma instância de GOverlay pode ser colocada no mapa com o método GMap2.addOverlay(). Assim, o mapa chamará o método GOverlay.initialize() na instância da sobreposição para exibir a si mesmo pela primeira vez. Sempre que houver alteração na exibição do mapa, ele chamará GOverlay.redraw() para que a sobreposição seja reposicionada, se necessário. A instância da sobreposição pode usar o método GMap2.getPane() para obter um ou mais elementos recipientes DOM aos quais se vincular.

Construtor

Construtor Descrição
GOverlay() Este construtor cria implementações fictícias dos métodos. Todavia, ao obter herança desta classe, seu construtor de classe derivada deverá chamar este construtor para ser concluído.

Métodos estáticos

Método Valor de retorno Descrição
GOverlay.getZIndex(latitude:Number) Number Retorna um valor CSS z-index para uma determinada latitude. Calcula um "índice z" que faz com que as sobreposições mais ao sul fiquem acima das sobreposições mais ao norte, criando assim a aparência 3D das sobreposições de marcador.

Métodos abstratos

Método Valor de retorno Descrição
initialize(map:GMap2) None Chamado pelo mapa depois que a sobreposição é adicionada ao mapa usando GMap2.addOverlay(). O objeto de sobreposição pode ser traçado nos diferentes painéis do mapa, obtidos por meio do GMap2.getPane().
remove() None Chamado pelo mapa depois que a sobreposição é removida do mapa com GMap2.removeOverlay() ou GMap2.clearOverlays(). A sobreposição deve ser removida dos painéis do mapa.
copy() GOverlay Retorna uma cópia própria não inicializada que pode ser adicionada ao mapa.
redraw(force:Boolean) None Chamado pelo mapa quando sua exibição tiver mudado. O argumento force será true se o nível de zoom ou o deslocamento de pixels da visualização do mapa tiver sido alterado, de forma que as coordenadas de pixel precisam ser recalculadas.

classe GInfoWindow

GInfoWindow não possui construtor. Ela é criada pelo mapa e acessado por seu método GMap2.getInfoWindow().

Métodos

Método Valor de retorno Descrição
selectTab(index:Number) None Seleciona a guia do índice especificado. Tem o mesmo efeito do clique na guia correspondente.
hide() None Torna invisível a janela de informações. OBSERVAÇÃO: Isso não fecha a janela de informações. Ela pode ficar visível novamente por meio de show().
show() None Torna visível a janela de informações, caso esteja invisível.
isHidden() Boolean Retorna true se a janela de informações estiver oculta. inclusive se ela estiver fechada.
reset(latlng:GLatLng, tabs:GInfoWindowTab[], size:GSize, offset?:GSize, selectedTab?:Number) None Redefine o estado da janela de informações. Cada argumento pode ser null, caso em que o valor atual não será alterado.
getPoint() GLatLng Retorna o ponto geográfico ao qual a janela de informações está ancorada. A extremidade da janela aponta para esse ponto no mapa, de acordo com o deslocamento de pixels.
getPixelOffset() GSize Retorna o deslocamento, em pixels, da extremidade da janela de informações a partir do ponto no mapa em cujas coordenadas geográficas está ancorada a janela de informações.
getSelectedTab() Number Retorna o índice, começando por 0, da guia selecionada no momento.
getTabs() GInfoWindowTabs[] Retorna a matriz de guias nesta janela de informações.

(Desde a versão 2.59)

getContentContainers() Node[] Retorna a matriz de nós DOM que possui o conteúdo das guias desta janela de informações.

(Desde a versão 2.59)

enableMaximize() None Ativa a maximização da janela de informações. Uma janela de informações maximizável se expande para preencher grande parte do mapa com conteúdos especificados pelas propriedades maxContent e maxTitle de GInfoWindowOptions. A janela de informações deverá ter sido aberta com as opções maxContent ou maxTitle para que enableMaximize() ou disableMaximize tenham efeito. Uma janela de informações aberta com maxContent ou maxTitle terá a maximização ativada por padrão.

(Desde a versão 2.93)

disableMaximize() None Desativa a maximização da janela de informações. A janela de informações deve ter sido aberta com as opções maxContent ou maxTitle. Se a janela de informações já estiver aberta, esta função removerá o botão maximizar, mas não vai restaurar o estado minimizado da janela.

(Desde a versão 2.93)

maximize() None Maximiza a janela de informações. A janela de informações deverá ter sido aberta com as opções maxContent ou maxTitle, sem que sua maximização tenha sido desativada por meio de disableMaximize.

(Desde a versão 2.93)

restore() None Restaura o estado padrão da janela de informações (não maximizada). A janela de informações deve ter sido aberta com as opções maxContent ou maxTitle.

(Desde a versão 2.93)

Eventos

Evento Descrição
closeclick() Este evento é disparado quando o botão de fechamento da janela de informações é clicado.
maximizeclick() Sinaliza que a janela de informações está prestes a ser maximizada.

(Desde a versão 2.93)

maximizeend() Sinaliza que a janela de informações concluiu a maximização.

(Desde a versão 2.93)

restoreclick() Sinaliza que a janela de informações está prestes a restaurar seu estado não maximizado.

(Desde a versão 2.93)

restoreend() Sinaliza que a janela de informações concluiu a operação de restauração para o estado não maximizado.

(Desde a versão 2.93)

classe GInfoWindowTab

Uma matriz de instâncias desta classe pode ser passada como o argumento tabs para os métodos GMap2.openInfoWindowTabs(), GMap2.openInfoWindowTabsHtml(), GMarker.openInfoWindowTabs(), GMarker.openInfoWindowTabsHtml() e as variantes GMarker.bindInfoWindow*(). Se a matriz contiver mais de um elemento, a janela de informações será mostrada com guias. Todo objeto InfoWindowTab contém dois itens: content define o conteúdo da janela de informações quando a guia é selecionada e label define o rótulo da guia. As propriedades são passadas como argumentos para o construtor. Para os métodos openInfoWindowTabs(), content é um nó DOM. Para os métodos openInfoWindowTabsHtml(), content é uma string que contém texto HTML.

Construtor

Construtor Descrição
GInfoWindowTab(label:String, content:Node or String) Cria uma estrutura de dados para a guia da janela de informações que pode ser passada no argumento tabs para os métodos openInfoWindowTabs*().

classe GInfoWindowOptions

As instâncias desta classe são usadas no argumento opts? para os métodos openInfoWindow(), openInfoWindowHtml(), openInfoWindowTabs(), openInfoWindowTabsHtml(), as variantes bindInfoWindow*() e showMapBlowup() das classes GMap2 e GMarker. Não há nenhum construtor para esta classe. Ela é instanciada como literal de objeto JavaScript.

Propriedades

Como indica o nome desta classe, todas as propriedades são opcionais.

Propriedade Tipo Descrição
selectedTab Number Seleciona a guia com o índice especificado, começando por 0, em vez da primeira guia (com índice 0).
maxWidth Number Largura máxima, em pixels, do conteúdo da janela de informações.
noCloseOnClick Boolean Indica se a janela de informações deve se fechar quando um clique no mapa recair fora de um marcador. Se for definida como true, a janela de informações não se fechará quando o mapa for clicado. O valor padrão é false.

(Desde a versão 2.83)

onOpenFn Function A função é chamada depois que a janela de informações é aberta e o conteúdo exibido.
onCloseFn Function A função é chamada quando a janela de informações é fechada.
zoomLevel Number Pertinente somente para showMapBlowup(). Nível de zoom do mapa ampliado na janela de informações.
mapType GMapType Pertinente somente para showMapBlowup(). Tipo de mapa do mapa ampliado na janela de informações.
maxContent String Especifica o conteúdo a ser mostrado quando a janela de informações é maximizada. O conteúdo pode ser uma string HTML ou um elemento DOM HTML.

(Desde a versão 2.93)

maxTitle String Especifica o título a ser mostrado quando a janela de informações é maximizada. O conteúdo pode ser uma string HTML ou um elemento DOM HTML.

(Desde a versão 2.93)

pixelOffset GSize Especifica um número de pixels para cima (x) e para a direita (y) para mover a janela de informações a partir do GLatLng especificado.

(Desde a versão 2.98)

classe GMarker

Uma classe GMarker marca uma posição no mapa. Ela implementa a interface GOverlay e, por isso, é adicionada ao mapa usando o método GMap2.addOverlay().

Um objeto do marcador possui uma latlng, que é a posição geográfica na qual o marcador está ancorado ao mapa, e um icon. Se o icon não for definido no construtor, o ícone padrão G_DEFAULT_ICON será usado.

Depois de adicionada a um mapa, a janela de informações pode ser aberta pelo marcador. O objeto do marcador irá disparar eventos do mouse e da janela de informações.

Construtor

Construtor Descrição
GMarker(latlng:GLatLng, icon?:GIcon, inert?:Boolean) Cria um marcador na latlng informada de GPoint ou GLatLng com icon ou G_DEFAULT_ICON. Se o sinalizador inert for true, o marcador não será clicável e não irá disparar nenhum evento.

(Obsoleto desde a versão 2.50)

GMarker(latlng:GLatLng, opts?:GMarkerOptions) Cria um marcador na latlng com opções especificadas em GMarkerOptions. Por padrão, os marcadores são clicáveis e têm o ícone padrão G_DEFAULT_ICON.

(Desde a versão 2.50)

Métodos

Antes que estes métodos possam ser chamados, o marcador deve ser adicionado ao mapa.

Método Valor de retorno Descrição
openInfoWindow(content:Node, opts?:GInfoWindowOptions) None Abre a janela de informações do mapa sobre o ícone do marcador. O conteúdo da janela de informações é fornecido como um nó DOM. Somente a opção GInfoWindowOptions.maxWidth pode ser aplicada.
openInfoWindowHtml(content:String, opts?:GInfoWindowOptions) None Abre a janela de informações do mapa sobre o ícone do marcador. O conteúdo da janela de informações é fornecido como uma string que contém texto HTML. Somente a opção GInfoWindowOptions.maxWidth pode ser aplicada.
openInfoWindowTabs(tabs:GInfoWindowTab[], opts?:GInfoWindowOptions) None Abre a janela de informações do mapa com guias sobre o ícone do marcador. O conteúdo da janela de informações é fornecido como uma matriz de guias com o conteúdo da guia na forma de nós DOM. Somente as opções GInfoWindowOptions.maxWidth e InfoWindowOptions.selectedTab podem ser aplicadas.
openInfoWindowTabsHtml(tabs:GInfoWindowTab[], opts?:GInfoWindowOptions) None Abre a janela de informações do mapa com guias sobre o ícone do marcador. O conteúdo da janela de informações é fornecido como uma matriz de guias com o conteúdo da guia na forma de strings que contêm texto HTML. Somente as opções InfoWindowOptions.maxWidth e InfoWindowOptions.selectedTab podem ser aplicadas.
bindInfoWindow(content:Node, opts?:GInfoWindowOptions) None Vincula o nó DOM especificado a este marcador. O conteúdo deste nó será exibido automaticamente na janela de informações quando o marcador for clicado. Para desvincular, passe content como null.

(Desde a versão 2.85)

bindInfoWindowHtml(content:String, opts?:GInfoWindowOptions) None Vincula o HTML especificado a este marcador. O conteúdo HTML será exibido automaticamente na janela de informações quando o marcador for clicado. Para desvincular, passe content como null.

(Desde a versão 2.85)

bindInfoWindowTabs(tabs:GInfoWindowTab[], opts?:GInfoWindowOptions) None Vincula as GInfoWindowTab (fornecidas como nós DOM) a este marcador. O conteúdo destes nós de guia será exibido automaticamente na janela de informações quando o marcador for clicado. Para desvincular, passe tabs como null.

(Desde a versão 2.85)

bindInfoWindowTabsHtml(tabs:GInfoWindowTab[], opts?:GInfoWindowOptions) None Vincula os GInfoWindowTabs (fornecidas como strings HTML) a este marcador. O conteúdo HTML destas guias será exibido automaticamente na janela de informações quando o marcador for clicado. Para desvincular, passe tabs como null.

(Desde a versão 2.85)

closeInfoWindow() None Fecha a janela de informações somente se ela pertencer a este marcador.

(Desde a versão 2.85)

showMapBlowup(opts?:GInfoWindowOptions) None Abre a janela de informações do mapa sobre o ícone do marcador. O conteúdo da janela de informações é uma ampliação do mapa ao redor da posição do marcador. Somente as opções InfoWindowOptions.zoomLevel e InfoWindowOptions.mapType podem ser aplicadas.
getIcon() GIcon Retorna o icon deste marcador, conforme definido pelo construtor.
getTitle() String Retorna o título deste marcador, conforme definido pelo construtor através da propriedade GMarkerOptions.title. Retorna valor indefinido se nenhum título for passado.

(Desde a versão 2.85)

getPoint() GLatLng Retorna as coordenadas geográficas às quais este marcador está ancorado, conforme definido pelo construtor ou por setPoint().

(Obsoleto desde a versão 2.88)

getLatLng() GLatLng Retorna as coordenadas geográficas às quais este marcador está ancorado, conforme definido pelo construtor ou por setLatLng().

(Desde a versão 2.88)

setPoint(latlng:GLatLng) None Define as coordenadas geográficas do ponto ao qual este marcador está ancorado.

(Obsoleto desde a versão 2.88)

setLatLng(latlng:GLatLng) None Define as coordenadas geográficas do ponto ao qual este marcador está ancorado.

(Desde a versão 2.88)

enableDragging() None Ativa o recurso arrastar e soltar do marcador ao redor do mapa. Para que ele funcione, o marcador deverá ter sido inicializado com GMarkerOptions.draggable = true.
disableDragging() None Desativa o recurso arrastar e soltar do marcador ao redor do mapa.
draggable() Boolean Retorna true se o marcador tiver sido inicializado pelo construtor usando GMarkerOptions.draggable = true. Caso contrário, retorna false.
draggingEnabled() Boolean Retorna true se estiver ativado o recurso que permite ao usuário arrastar o marcador no mapa.
setImage(url:String) None Solicita que a imagem especificada pelo url seja definida como imagem de primeiro plano neste marcador. Nem a imagem impressa nem a imagem sombreada são ajustadas. Portanto, este método destina-se sobretudo a implementar efeitos de realce ou esmaecimento, e não alterações drásticas na aparência do marcador.

(Desde a versão 2.75)

hide() None Oculta o marcador se ele estiver visível no momento. Esta função dispara o evento GMarker.visibilitychanged se o marcador estiver visível no momento.

(Desde a versão 2.77)

show() None Mostra o marcador se ele estiver oculto no momento. Esta função dispara o evento GMarker.visibilitychanged se o marcador estiver oculto no momento.

(Desde a versão 2.77)

isHidden() Boolean Retorna true se o marcador estiver oculto no momento. Caso contrário, retorna false.

(Desde a versão 2.77)

Eventos

Todos estes eventos são disparados somente se o marcador não estiver inerte (consulte o construtor).

Evento Descrição
click(latlng:GLatLng) Este evento é disparado ao clicar no ícone do marcador, passando a coordenada atual do marcador em seu argumento latlng. O evento também vai disparar para o mapa se o marcador for passado como primeiro argumento do manipulador de evento.
dblclick(latlng:GLatLng) Este evento é disparado ao clicar duas vezes no ícone do marcador, passando a coordenada atual do marcador com seu argumento latlng. Este evento não será disparado para o mapa, pois o mapa centraliza no clique duplo como comportamento inerente.
mousedown(latlng:GLatLng) Este evento é disparado quando o evento mousedown do DOM é disparado no ícone do marcador, passando a coordenada atual do marcador em seu argumento latlng. O marcador vai parar o evento mousedown do DOM de modo que não o mapa não seja arrastado.
mouseup(latlng:GLatLng) Este evento é disparado para o evento mouseup do DOM no marcador, passando a coordenada atual do marcador em seu argumento latlng. O marcador não interromperá o evento mousedown do DOM, a fim de não confundir o manipulador de arrastamento do mapa.
mouseover(latlng:GLatLng) Este evento é disparado quando o mouse entra na área do ícone do marcador, passando a coordenada atual do marcador em seu argumento latlng.
mouseout(latlng:GLatLng) Este evento é disparado quando o mouse deixa na área do ícone do marcador, passando a coordenada atual do marcador em seu argumento latlng.
infowindowopen() Este evento é disparado quando a janela de informações do mapa é aberta por meio deste marcador.
infowindowbeforeclose() Este evento é disparado antes que seja fechada a janela de informações do mapa que foi aberta através deste marcador.

(Desde a versão 2.83)

infowindowclose() Este evento é disparado quando a janela de informações do mapa que foi aberta por meio deste marcador é fechada. Isso ocorre quando a janela de informações é fechada ou quando ela é aberta em outro marcador ou no mapa. O evento infowindowbeforeclose é disparado antes deste evento.
remove() Este evento é disparado quando o marcador é removido do mapa usando GMap2.removeOverlay() ou GMap2.clearOverlays().
dragstart(latlng:GLatLng) Se o marcador estiver ativado para a ação de arrastar, esse evento será disparado quando a ação de arrastar do marcador começar, passando a coordenada atual do marcador em seu argumento latlng.
drag(latlng:GLatLng) Se o marcador estiver ativado para a ação de arrastar, esse evento será disparado quando o marcador for arrastado, passando a coordenada atual do marcador em seu argumento latlng.
dragend(latlng:GLatLng) Se o marcador estiver ativado para a ação de arrastar, esse evento será disparado quando o marcador não estiver mais sendo arrastado, passando a coordenada atual do marcador em seu argumento latlng.
visibilitychanged(isVisible:Boolean) Este evento é disparado quando a visibilidade do marcador é alterada (ou seja, de visível para oculta ou vice-versa). isVisible refere-se ao estado do marcador depois que ocorre a alteração da visibilidade.

(Desde a versão 2.77)

classe GMarkerOptions

As instâncias desta classe são usadas no argumento opts? para o construtor da classe GMarker. Não há nenhum construtor para esta classe. Ela é instanciada como literal de objeto JavaScript.

Propriedades

Como indica o nome desta classe, todas as propriedades são opcionais.

Propriedade Tipo Descrição
icon GIcon Escolhe o ícone para esta classe. Se não for especificado, G_DEFAULT_ICON será usado.

(Desde a versão 2.50)

dragCrossMove Boolean Quando se arrasta um marcador normalmente, ele flutua, distanciando-se do cursor. Definir este valor como true mantém o marcador sob o cursor e move a cruz para baixo. O valor padrão desta opção é false.

(Desde a versão 2.63)

title String Esta string aparecerá no marcador como dica de ferramentas, ou seja, funcionará exatamente como o atributo title em elementos HTML.

(Desde a versão 2.50)

clickable Boolean Ativa ou desativa o recurso que torna o marcador clicável. Os marcadores que não podem ser clicados ou arrastados são inertes, consomem menos recursos e não respondem a nenhum evento. O valor padrão desta opção é true. Isto é, se a opção não for especificada, o marcador será clicável.

(Desde a versão 2.50)

draggable Boolean Ativa ou desativa o recurso que torna o marcador arrastável pelos usuários. Os marcadores configurados para serem arrastados exigem a configuração de mais recursos do que os marcadores clicáveis. Qualquer marcador arrastável também é clicável, animado e com recurso panorâmico automático por padrão. O valor padrão desta opção é false.

(Desde a versão 2.61)

bouncy Boolean Ativa ou desativa o recurso que faz o marcador saltar depois de ser arrastado. O valor padrão desta opção é false.

(Desde a versão 2.61)

bounceGravity Number Após o arrastamento, este número é usado para definir a taxa de aceleração do marcador durante o salto para a Terra. O valor padrão desta opção é 1.

(Desde a versão 2.61)

autoPan Boolean Mostra a panorâmica do mapa automaticamente à medida que você arrasta o marcador perto da borda. Se o marcador é clicável, o valor padrão desta opção é true.

(Desde a versão 2.87)

zIndexProcess Function Esta função é usada para alterar a ordem z-Index dos marcadores quando eles são sobrepostos no mapa. Ela também é chamada quando as respectivas janelas de informações são abertas. A ordem padrão é a seguinte: os marcadores ao sul ficam mais altos que os marcadores ao norte. Esta função é passada através do objeto GMarker e retorna um número que indica o novo z-index.

(Desde a versão 2.98)

hide Boolean Quando for "true", indicará que o mapa não deve exibir inicialmente o GMarker. Para ativar a sobreposição, chame GMarker.show(). Por padrão, esse valor está definido como "false".

(Desde a versão 2.139)

classe GPolyline

Trata-se de uma sobreposição de mapa que traça uma polilinha no mapa, usando os recursos de desenho vetorial do navegador, se estiverem disponíveis. Se não estiverem, é usada uma sobreposição de imagem dos servidores do Google.

Construtor

Construtor Descrição
GPolyline(latlngs:GLatLng[], color?:String, weight?:Number, opacity?:Number, opts?:GPolylineOptions) Cria uma polilinha a partir de uma matriz de vértices. color é dada como uma string que contém a cor em estilo HTML numérico hexadecimal, ou seja, #RRGGBB. weight é a largura da linha em pixels. opacity é especificado o como um número entre 0 e 1. A linha será suavizada e semitransparente.

Métodos de fábrica

Método Valor de retorno Descrição
GPolyline.fromEncoded(color?:String, weight?:Number, opacity?:Number, latlngs:String, zoomFactor:Number, levels:String, numLevels:Number) GPolyline Cria uma polilinha a partir das strings codificadas de coordenadas e níveis agregados. color é uma string que contém um estilo HTML numérico hexadecimal, ou seja #RRGGBB. weight é a largura da linha em pixels. opacity é um número entre 0 e 1. latlngs é uma string contendo as coordenadas codificadas de latitude e longitude. levels é uma string contendo os grupos codificados de níveis de zoom da polilinha. numLevels é o número de níveis de zoom contidos na string levels codificada. zoomFactor é a ampliação entre os conjuntos adjacentes de níveis de zoom na string levels codificada. Juntos, esses dois valores determinam a precisão de levels em uma polilinha codificada. A linha será suavizada e semitransparente.

(Desde a versão 2.63)

Métodos

Método Valor de retorno Descrição
deleteVertex(index:Number) None Remove o vértice com o índice determinado na polilinha e atualiza a forma da polilinha adequadamente. A GPolyline já deve ter sido adicionada ao mapa pela GMap2.addOverlay().

(Desde a versão 2.111)

disableEditing() None Inverte o efeito de enableEditing, removendo todos os pontos de controle da linha e impedindo a edição pelo usuário.

(Desde a versão 2.111)

enableDrawing(opts?:GPolyEditingOptions) None Permite que um usuário construa (ou modifique) um objeto GPolyline clicando em pontos adicionais no mapa. A GPolyline já deve ter sido adicionada ao mapa pela GMap2.addOverlay(), mesmo se inicialmente a polilinha não estiver preenchida e não contiver vértices. Cada clique adiciona um vértice à cadeia da polilinha e o desenho pode ser encerrado com um duplo clique ou com um novo clique no último ponto adicionado, o que dispara um evento "endline" caso a polilinha tenha sido concluída com êxito. Caso contrário, um evento "cancelline" será disparado, mas a polilinha não será removida do mapa. Se estiver modificando um GPolyline existente, os vértices serão conectados a partir dos pontos inicial ou final da polilinha existente, especificada no parâmetro GPolyEditingOptions.fromStart opcional.

(Desde a versão 2.111)

enableEditing(opts?:GPolyEditingOptions) None Permite a modificação de uma cadeia de pontos GPolyline existente. Quando está ativado, os usuários podem selecionar e arrastar vértices existentes. A menos que um limite de vértice menor que o número atual de vértices seja especificado pelo maxVertices em GPolyEditingOptions, pontos "fantasma" também serão adicionados aos pontos centrais das seções da polilinha, permitindo que os usuários interpolem novos vértices clicando e arrastando esses vértices adicionais. Um evento "lineupdated" será disparado sempre que um vértice for adicionado ou movido.

(Desde a versão 2.111)

getVertexCount() Number Retorna o número de vértices na polilinha.

(Desde a versão 2.46)

getVertex(index:Number) GLatLng Retorna o vértice com o índice especificado na polilinha.

(Desde a versão 2.46)

getLength() Number Retorna o comprimento (em metros) da polilinha ao longo da superfície esférica da Terra.

(Desde a versão 2.85)

getBounds() GLatLngBounds Retorna os limites desta polilinha.

(Desde a versão 2.85)

hide() None Oculta a polilinha se ela estiver visível no momento e GPolyline.supportsHide() retornar true. Esta função dispara o evento GPolyline.visibilitychanged se a polilinha estiver visível no momento.

(Desde a versão 2.87)

insertVertex(index:Number, latlng:GLatLng) None Insere um novo ponto no índice determinado na polilinha e atualiza sua forma. A GPolyline já deve ter sido adicionada ao mapa pela GMap2.addOverlay().

(Desde a versão 2.111)

isHidden() Boolean Retorna true se a polilinha estiver oculta no momento. Caso contrário, retorna false.

(Desde a versão 2.87)

show() None Mostra a polilinha se ela estiver oculta no momento. Essa função dispara o evento GPolyline.visibilitychanged se a polilinha estiver oculta no momento.

(Desde a versão 2.87)

supportsHide() Boolean Retorna true se GPolyline.hide() for suportado no ambiente atual para os objetos GPolyline . Caso contrário, retorna false.

(Desde a versão 2.87)

setStrokeStyle(style:GPolyStyleOptions) None Altera o estilo da polilinha. A GPolyline já deve ter sido adicionada ao mapa pela GMap2.addOverlay().

(Desde a versão 2.111)

Eventos

Evento Descrição
remove() Este evento é disparado quando a polilinha é removida do mapa usando GMap2.removeOverlay() ou GMap2.clearOverlays().
visibilitychanged(isVisible:Boolean) Este evento é disparado quando o estado de visibilidade da polilinha se alterna entre visível e oculta. O argumento isVisible reflete o estado da polilinha após a conclusão desse estado de visibilidade.

(Desde a versão 2.87)

click(latlng:GLatLng) Este evento é disparado ao clicar na polilinha, passando a coordenada de clique da linha em seu argumento latlng. Esse evento também dispara subsequentemente um evento "click" no mapa, e a polilinha é passada como o argumento overlay dentro desse evento.

(Desde a versão 2.88)

mouseover() Este evento é disparado quando o mouse é movido sobre a polilinha.

(Desde a versão 2.111)

mouseout() Este evento é disparado quando o mouse é retirado de cima da polilinha.

(Desde a versão 2.111)

lineupdated() Este evento é disparado quando se altera o estilo ou a forma da polilinha

(Desde a versão 2.111)

endline() Este evento é disparado quando o desenho da linha (iniciado pela chamada de GPolyline.enableDrawing) é concluído pelo usuário.

(Desde a versão 2.111)

cancelline() Este evento é disparado quando o desenho da linha (iniciado pela chamada de GPolyline.enableDrawing) é cancelado pelo usuário.

(Desde a versão 2.111)

classe GPolylineOptions

A instâncias desta classe são usadas no construtor de GPolyline. Não há nenhum construtor para esta classe. Ela é instanciada como literal de objeto JavaScript.

Propriedades

Como indica o nome desta classe, todas as propriedades são opcionais.

Propriedade Tipo Descrição
clickable Boolean Ativa ou desativa o recurso que torna a polilinha clicável. O valor padrão desta opção é true. Isto é, se a opção não for especificada, a polilinha poderá ser clicada.

(Desde a versão 2.91)

geodesic Boolean Renderiza cada extremidade da polilinha como geodésica (segmento de um "grande círculo"). Uma geodésica é o menor caminho entre dois pontos ao longo da superfície da Terra.

(Desde a versão 2.84)

classe GPolyEditingOptions

As instâncias dessa classe são usadas nos métodos enableEditing de GPolyline e de GPolygon. Não há nenhum construtor para esta classe. Ela é instanciada como literal de objeto JavaScript.

Propriedades

Como indica o nome desta classe, todas as propriedades são opcionais.

Propriedade Tipo Descrição
maxVertices Number Essa propriedade especifica o número máximo de vértices permitidos para essa polilinha. Assim que esse número é atingido, não são permitidas novas adições.

(Desde a versão 2.111)

fromStart Boolean Essa propriedade especifica se enableDrawing deve adicionar pontos a partir do início em vez de a partir do final, que é o padrão.

(Desde a versão 2.111)

classe GPolyStyleOptions

As instâncias dessa classe são usadas no método setStrokeStyle de GPolyline e de GPolygon e no método setFillStyle de GPolygon. Não há nenhum construtor para esta classe. Ela é instanciada como literal de objeto JavaScript.

Propriedades

Como indica o nome desta classe, todas as propriedades são opcionais.

Propriedade Tipo Descrição
color String Essa propriedade especifica uma string que contém um estilo HTML numérico hexadecimal, ou seja #RRGGBB.

(Desde a versão 2.111)

weight Number Essa propriedade especifica a largura da linha em pixels.

(Desde a versão 2.111)

opacity Number Essa propriedade especifica a opacidade da polilinha como um valor fracionário entre 0 (transparente) e 1 (opaco).

(Desde a versão 2.111)

classe GPolygon

Esta classe é muito semelhante a GPolyline, exceto pelo fato de que você pode especificar uma cor de preenchimento e uma opacidade.

Construtor

Construtor Descrição
GPolygon(latlngs:GLatLng[], strokeColor?:String, strokeWeight?:Number, strokeOpacity?:Number, fillColor?:Number, fillOpacity?:Number, opts?:GPolygonOptions) Cria um polígono a partir de uma matriz de vértices. colors são dadas como uma string que contém a cor em estilo HTML numérico hexadecimal, ou seja, #RRGGBB. weight é a largura da linha em pixels. opacities é especificado o como um número entre 0 e 1. A linha será suavizada e semitransparente.

(Desde a versão 2.69)

Métodos de fábrica

Método Valor de retorno Descrição
GPolygon.fromEncoded(polylines:encoded polylines[], fill?:Boolean, color?:String, opacity?:Number, outline?:Boolean) GPolygon Cria um polígono (formado por algumas polilinhas) a partir de strings codificadas de coordenadas e níveis agregados. polylines contém uma matriz associativa de polilinhas integrantes, codificadas no mesmo formato descrito na documentação de GPolyline.fromEncoded. fill especifica se o polígono será preenchido com uma determinada color. opacity e outline especificam se o polígono terá a cor, a densidade e a opacidade da polilinha. Se forem especificados vários valores nas polilinhas, serão adotados os valores da primeira polilinha.

(Desde a versão 2.78)

Métodos

Método Valor de retorno Descrição
deleteVertex(index:Number) None Remove com o índice determinado no polígono e atualiza a forma do polígono adequadamente. A GPolygon já deve ter sido adicionada ao mapa pela GMap2.addOverlay().

(Desde a versão 2.111)

disableEditing() None Inverte o efeito de enableEditing, removendo todos os pontos de controle da linha e impedindo a edição pelo usuário.

(Desde a versão 2.111)

enableDrawing(opts?:GPolyEditingOptions) None Permite que um usuário construa um objeto GPolygon clicando em pontos adicionais no mapa. A GPolyline já deve ter sido adicionada ao mapa pela GMap2.addOverlay(), mesmo se inicialmente a polilinha não estiver preenchida e não contiver vértices. Cada clique adiciona um vértice ao limite do polígono e o desenho pode ser encerrado com um duplo clique ou com um clique simples no primeiro ponto para completar a forma, o que dispara um evento "endline" caso o polígono tenha sido concluído com êxito. Caso contrário, um evento "cancelline" será disparado, mas o polígono não será removido do mapa.

(Desde a versão 2.111)

enableEditing(opts?:GPolyEditingOptions) None Permite a modificação de um limite GPolygon existente. Quando está ativado, os usuários podem selecionar e arrastar vértices existentes. A menos que um limite de vértice menor que o número atual de vértices seja especificado pelo maxVertices em GPolyEditingOptions, pontos "fantasma" também serão adicionados aos pontos centrais das seções do polígono, permitindo que os usuários interpolem novos vértices clicando e arrastando esses vértices adicionais. Um evento "lineupdated" será disparado sempre que um vértice for adicionado ou movido.

(Desde a versão 2.111)

getVertexCount() Number Retorna o número de vértices no polígono.

(Desde a versão 2.69)

getVertex(index:Number) GLatLng Retorna o vértice com o índice especificado no polígono.

(Desde a versão 2.69)

getArea() Number Retorna a área (em metros quadrados) do polígono na superfície esférica da Terra.

(Desde a versão 2.85)

getBounds() GLatLngBounds Retorna os limites deste polígono.

(Desde a versão 2.85)

hide() None Oculta o polígono se ele estiver visível no momento e GPolygon.supportsHide retornar true. Esta função dispara o evento GPolygon.visibilitychanged se o polígono estiver visível no momento.

(Desde a versão 2.87)

insertVertex(index:Number, latlng:GLatLng) None Insere um novo ponto no índice determinado no polígono. A GPolygon já deve ter sido adicionada ao mapa pela GMap2.addOverlay().

(Desde a versão 2.111)

isHidden() Boolean Retorna true se o polígono estiver oculto no momento. Caso contrário, retorna false.

(Desde a versão 2.87)

show() None Mostra o polígono se ele estiver oculto no momento. Essa função dispara o evento GPolygon.visibilitychanged se o polígono estiver oculto no momento.

(Desde a versão 2.87)

supportsHide() Boolean Retorna true se GPolygon.hide() for suportado no ambiente atual para os objetos GPolygon . Caso contrário, retorna false.

(Desde a versão 2.87)

setFillStyle(style:GPolyStyleOptions) None Altera o estilo de preenchimento do polígono. A GPolygon já deve ter sido adicionada ao mapa pela GMap2.addOverlay().

(Desde a versão 2.111)

setStrokeStyle(style:GPolyStyleOptions) None Altera o estilo da linha do polígono. A GPolygon já deve ter sido adicionada ao mapa pela GMap2.addOverlay().

(Desde a versão 2.111)

Eventos

Evento Descrição
remove() Este evento é disparado quando o polígono é removido do mapa usando GMap2.removeOverlay() ou GMap2.clearOverlays().
visibilitychanged(isVisible:Boolean) Este evento é disparado quando o estado de visibilidade do polígono se alterna entre visível e oculto. O argumento isVisible reflete o estado do polígono após a conclusão desse estado de visibilidade.

(Desde a versão 2.87)

click(latlng:GLatLng) Este evento é disparado ao clicar no polígono, passando a coordenada de clique do polígono em seu argumento latlng. Esse evento também dispara subsequentemente um evento "click" no mapa, e o polígono é passado como o argumento overlay nesse evento.

(Desde após a versão 2.88)

mouseover() Este evento é disparado quando o mouse entra na região do polígono.

(Desde a versão 2.111)

mouseout() Este evento é disparado quando o mouse sai da região do polígono.

(Desde a versão 2.111)

lineupdated() Este evento é disparado quando se altera o estilo ou a forma do polígono.

(Desde a versão 2.111)

endline() Este evento é disparado quando o desenho do polígono (iniciado pela chamada de GPolyline.enableDrawing) é concluído pelo usuário.

(Desde a versão 2.111)

cancelline() Este evento é disparado quando o desenho do polígono (iniciado pela chamada de GPolyline.enableDrawing) é cancelado pelo usuário.

(Desde a versão 2.111)

classe GPolygonOptions

A instâncias desta classe são usadas no construtor de GPolygon. Não há nenhum construtor para esta classe. Ela é instanciada como literal de objeto JavaScript.

Propriedades

Como indica o nome desta classe, todas as propriedades são opcionais.

Propriedade Tipo Descrição
clickable Boolean Ativa ou desativa o recurso que torna o polígono clicável. O valor padrão desta opção é true. Isto é, se a opção não for especificada, o polígono poderá ser clicado.

(Desde a versão 2.91)

classe GScreenOverlay

Este objeto exibe uma sobreposição de imagem retangular no mapa, cuja posição permanece fixa enquanto a janela de visualização muda. Exemplos de uso de ScreenOverlay são bússolas, logotipos e displays heads-up.

Construtor

Construtor Descrição
GScreenOverlay(imageUrl:String, screenXY:GScreenPoint, overlayXY:GScreenPoint, size:GScreenSize) Cria uma sobreposição de tela a partir do URL de uma imagem e a exibe na tela conforme especificado pelos parâmetros screenXY, overlayXY e size. O parâmetro overlayXY determina o ponto na imagem de sobreposição (ou fora dela) mapeado para a coordenada screenXY. Isso serve para 'cortar' de fato a imagem. O parâmetro screenXY determina o ponto em relação à origem da tela (canto inferior esquerdo) para o qual a imagem de sobreposição está mapeada.

(Desde a versão 2.92)

Métodos

Método Valor de retorno Descrição
hide() None Oculta a sobreposição de tela se ela estiver visível no momento. Esta função dispara o evento GScreenOverlay.visibilitychanged se a sobreposição de tela estiver visível no momento.

(Desde a versão 2.92)

isHidden() Boolean Retorna true se a sobreposição de tela estiver oculta no momento. Caso contrário, retorna false.

(Desde a versão 2.92)

show() None Mostra a sobreposição de tela se ela estiver oculta no momento. Esta função dispara o evento GScreenOverlay.visibilitychanged se a sobreposição de tela estiver oculta no momento.

(Desde a versão 2.92)

supportsHide() Boolean Sempre retorna true.

(Desde a versão 2.92)

Eventos

Evento Descrição
visibilitychanged(isVisible:Boolean) Este evento é disparado quando o estado de visibilidade da sobreposição de tela se alterna entre visível e oculta. O argumento isVisible reflete o estado da sobreposição de tela após a conclusão desse estado de visibilidade.

(Desde a versão 2.92)

classe GScreenPoint

Um GScreenPoint identifica um ponto na janela de visualização do mapa por coordenadas X e Y, que podem representar uma posição fracionária ou absoluta, a depender do valor dos parâmetros opcionais do construtor.

Construtor

Construtor Descrição
GScreenPoint(x:Number, y:Number, xunits?:String, yunits?:String) Cria um objeto GScreenPoint. As coordenadas x e y podem representar uma posição fracionária ou absoluta passando "fraction" ou "pixels" para os parâmetros xunits e yunits. O valor padrão desses parâmetros é "pixels".

(Desde a versão 2.92)

Propriedades

Propriedade Tipo Descrição
x Number Coordenada x, aumenta para a esquerda.
y Number Coordenada y, aumenta para baixo.
xunits String Especifica o tipo de unidades para usar na coordenada x. Defina como "fração" para indicar a posição fracionária em relação ao tamanho do mapa ou como "pixels" para posição absoluta. O padrão é a posição absoluta.
yunits String Especifica o tipo de unidades para usar na coordenada y. Defina como "fração" para indicar a posição fracionária em relação ao tamanho do mapa ou como "pixels" para posição absoluta. O padrão é a posição absoluta.

classe GScreenSize

Um GScreenSize indica o tamanho de uma área retangular do mapa, determinado pelos parâmetros width e height. Cada um desses parâmetros pode representar tamanho fracionário ou absoluto, a depender do valor dos parâmetros opcionais do construtor.

Construtor

Construtor Descrição
GScreenSize(width:Number, height:Number, xunits?:String, yunits?:String) Cria um objeto GScreenSize. As coordenadas width e height podem representar um tamanho fracionário ou em pixels passando "fraction" ou "pixel" para os parâmetros xunits e yunits. O valor padrão dos argumentos width e height é "pixel".

(Desde a versão 2.92)

Propriedades

Propriedade Tipo Descrição
width Number Parâmetro de largura do estado real da tela. Este valor representa um valor fracionário ou absoluto em pixels, dependendo do valor da propriedade GScreen.yunits.
height Number Parâmetro de altura do estado real da tela. Este valor representa um valor fracionário ou absoluto em pixels, dependendo do valor da propriedade GScreen.yunits.
xunits String Especifica o tipo de unidade a ser usado na propriedade GScreenSize.width. Defina como "fração" para indicar a posição fracionária em relação ao tamanho do mapa ou como "pixel" para a posição em pixels. O padrão é a posição em pixels.
yunits String Especifica o tipo de unidade a ser usado na propriedade GScreenSize.height. Defina como "fração" para indicar a posição fracionária em relação ao tamanho do mapa ou como "pixel" para a posição em pixels. O padrão é a posição em pixels.

classe GGroundOverlay

Este objeto cria uma sobreposição de imagem retangular no mapa, cujos limites são definidos por GLatLngBounds.

Construtor

Construtor Descrição
GGroundOverlay(imageUrl:String, bounds:GLatLngBounds) Cria uma sobreposição de solo a partir do URL de uma imagem e seus limites.

(Desde a versão 2.79)

Métodos

Método Valor de retorno Descrição
hide() None Oculta a sobreposição de solo se ela estiver visível no momento. Esta função dispara o evento GGroundOverlay.visibilitychanged se a sobreposição de solo estiver visível no momento.

(Desde a versão 2.87)

isHidden() Boolean Retorna true se a sobreposição de solo estiver oculta no momento. Caso contrário, retorna false.

(Desde a versão 2.87)

show() None Mostra a sobreposição de solo se ela estiver oculta no momento. Esta função dispara o evento GGroundOverlay.visibilitychanged se a sobreposição de solo estiver oculta no momento.

(Desde a versão 2.87)

supportsHide() Boolean Sempre retorna true.

(Desde a versão 2.87)

Eventos

Evento Descrição
visibilitychanged(isVisible:Boolean) Este evento é disparado quando o estado de visibilidade da sobreposição de solo se alterna entre visível e oculta. O argumento isVisible reflete o estado da sobreposição de solo após a conclusão desse estado de visibilidade.

(Desde a versão 2.77)

classe GIcon

Um ícone especifica as imagens usadas para exibir um GMarker no mapa. Por questões de compatibilidade do navegador, a especificação de um ícone é uma tarefa realmente complexa. Você pode usar o ícone padrão G_DEFAULT_ICON do Google Maps se não quiser especificar o seu próprio ícone.

Construtor

Construtor Descrição
GIcon(copy?:GIcon, image?:String) Cria um novo objeto de ícone. Se outro ícone for especificado no argumento copy opcional, suas propriedades são copiadas. Caso contrário, elas ficam vazias. O argumento image opcional define o valor da propriedade image.

Constantes

Constante Descrição
G_DEFAULT_ICON Ícone padrão usado pelos marcadores.

Propriedades

Propriedade Tipo Descrição
image String URL da imagem de primeiro plano do ícone.
shadow String URL da imagem sombreada do ícone.
iconSize GSize Tamanho em pixels da imagem de primeiro plano do ícone.
shadowSize GSize Tamanho em pixels da imagem sombreada.
iconAnchor GPoint Coordenada em pixels relativa ao canto superior esquerdo da imagem do ícone, pelo qual o ícone está ancorado ao mapa.
infoWindowAnchor GPoint Coordenada em pixels relativa ao canto superior esquerdo da imagem do ícone, pelo qual a janela de informações está ancorada ao ícone.
printImage String URL da imagem de primeiro plano do ícone, usada em mapas impressos. Deverá ter o mesmo tamanho da imagem do ícone principal, especificada por image.
mozPrintImage String URL da imagem de primeiro plano do ícone, usado em mapas impressos no Firefox/Mozilla. Deverá ter o mesmo tamanho da imagem do ícone principal, especificada por image.
printShadow String URL da imagem sombreada do ícone, usado em mapas impressos. Deverá ser uma imagem GIF, visto que quase todos os navegadores não imprimem imagens PNG.
transparent String URL de uma versão quase transparente da imagem de primeiro plano do ícone, usado para capturar eventos de clique no Internet Explorer. Essa imagem deverá ser uma versão PNG de 24 bits da imagem do ícone principal, com 1% de opacidade e o mesmo formato e tamanho do ícone principal.
imageMap Number[] Matriz de inteiros que representa as coordenadas x/y do mapa de imagem, que deverá ser usado para especificar a parte clicável da imagem do ícone em navegadores que não sejam o Internet Explorer.
maxHeight Integer Especifica a distância em pixels em que um marcador se "eleva" verticalmente quando arrastado.

(Desde a versão 2.79)

dragCrossImage String Especifica o URL da imagem de cruz quando um ícone é arrastado.

(Desde a versão 2.79)

dragCrossSize GSize Especifica o tamanho em pixels da imagem de cruz quando um ícone é arrastado.

(Desde a versão 2.79)

dragCrossAnchor GPoint Especifica os deslocamentos de coordenada em pixels (em relação ao iconAnchor) da imagem de cruz quando um ícone é arrastado.

(Desde a versão 2.79)

classe GPoint

Um GPoint representa um ponto no mapa pelas suas coordenadas em pixels. Na v2, não há mais a representação de um ponto na Terra por meio de coordenadas geográficas. As coordenadas geográficas agora são representadas por GLatLng.

No sistema de coordenadas do Google Maps, a coordenada x aumenta para a direita e a coordenada y aumenta para baixo, embora seja possível usar as coordenadas GPoint, se desejar.

Embora os dois parâmetros de um GPoint possam ser acessados como as propriedades x e y, recomenda-se nunca modificá-los, e sim criar um novo objeto com parâmetros diferentes.

Construtor

Construtor Descrição
GPoint(x:Number, y:Number) Cria um objeto GPoint.

Propriedades

Propriedade Tipo Descrição
x Number Coordenada x. Este valor aumenta para a direita, no sistema de coordenadas do Google Maps.
y Number Coordenada y. Este valor aumenta para baixo, no sistema de coordenadas do Google Maps.

Métodos

Método Valor de retorno Descrição
equals(other:GPoint) Boolean Retorna true se o outro ponto tiver coordenadas idênticas.
toString() String Retorna uma string contendo as coordenadas x e y, nesta ordem, separadas por vírgula.

classe GSize

GSize é o tamanho em pixels de uma área retangular do mapa. O objeto tamanho tem dois parâmetros, width e height. A largura é uma diferença de pontos na coordenada x; a altura é uma diferença de pontos na coordenada y.

Embora os dois parâmetros de um GSize possam ser acessados como as propriedades width e height, recomenda-se nunca modificá-los, e sim criar um novo objeto com parâmetros diferentes.

Construtor

Construtor Descrição
GSize(width:Number, height:Number) Cria um objeto GSize.

Propriedades

Propriedade Tipo Descrição
width Number Parâmetro de largura.
height Number Parâmetro de altura.

Métodos

Método Valor de retorno Descrição
equals(other:GSize) Boolean Retorna true se o outro tamanho tiver componentes idênticos.
toString() String Retorna uma string contendo os parâmetros de largura e altura, nesta ordem, separada por vírgula.

classe GBounds

GBounds é uma área retangular do mapa definida por coordenadas em pixels. Um retângulo, em coordenadas geográficas, é representado por um objeto GLatLngBounds.

Construtor

Construtor Descrição
GBounds(points:GPoint[]) Constrói um retângulo contendo todos os points especificados.

Propriedades

Propriedade Tipo Descrição
minX Number Coordenada x da borda esquerda do retângulo.
minY Number Coordenada y da borda superior do retângulo.
maxX Number Coordenada x da borda direita do retângulo.
maxY Number Coordenada y da borda inferior do retângulo.

Métodos

Método Valor de retorno Descrição
toString() String Retorna uma string contendo as coordenadas dos pontos do canto superior esquerdo e inferior direito da caixa, nesta ordem. A string é separada por vírgula e aparece entre parênteses.
equals(other:GBounds) Boolean Retorna "true" se todos os parâmetros deste retângulo forem idênticos aos parâmetros do outro.

(Desde a versão 2.98)

mid() GPoint Retorna as coordenadas em pixels do centro da área retangular.

(Desde a versão 2.88)

min() GPoint Retorna as coordenadas em pixels da extremidade superior esquerda da área retangular.
max() GPoint Retorna as coordenadas em pixels da extremidade inferior direita da área retangular.
containsBounds(other:GBounds) Boolean Retorna true se a área retangular passada estiver inteiramente incluída nesta área retangular.
containsPoint(point:GPoint) Boolean Retorna true se a área retangular (inclusive) contiver as coordenadas de pixel.

(Desde a versão 2.88)

extend(point:GPoint) None Amplia esta caixa para que o ponto também fique incluído nela.

classe GLatLng

GLatLng é um ponto das coordenadas geográficas de longitude e latitude.

Embora as projeções de mapa comuns associem a longitude à coordenada x do mapa e a latitude à coordenada y, a coordenada de latitude vem sempre antes, seguida pela longitude, como é comum na cartografia.

Além disso, não é possível modificar as coordenadas de uma GLatLng. Se você quiser calcular outro ponto, deverá criar um novo.

Construtor

Construtor Descrição
GLatLng(lat:Number, lng:Number, unbounded?:Boolean) Observe ordem da latitude e longitude. Se o sinalizador unbounded for true, então os números serão usados conforme foram passados. Caso contrário, a latitude será fixada entre -90 e +90 graus e a longitude será ajustada entre -180 e +180 graus.

Métodos

Método Valor de retorno Descrição
lat() Number Retorna a coordenada de latitude em graus, como um número entre -90 e +90. Se o sinalizador unbounded tiver sido definido no construtor, a coordenada pode estar fora deste intervalo.
lng() Number Retorna a coordenada de longitude em graus, como um número entre -180 e +180. Se o sinalizador unbounded tiver sido definido no construtor, a coordenada pode estar fora deste intervalo.
latRadians() Number Retorna a coordenada de latitude em radianos, como um número entre -PI/2 e +PI/2. Se o sinalizador unbounded tiver sido definido no construtor, a coordenada pode estar fora deste intervalo.
lngRadians() Number Retorna a coordenada de longitude em radianos, como um número entre -PI e +PI. Se o sinalizador unbounded tiver sido definido no construtor, a coordenada pode estar fora deste intervalo.
equals(other:GLatLng) Boolean Retorna true se o outro tamanho tiver componentes idênticos, com margens de erro específicas.
distanceFrom(other:GLatLng) Number Retorna a distância, em metros, deste ponto até o ponto especificado. A Terra é aproximada como uma esfera, portanto, a distância admite um desvio de até 0,3%. Consulte abaixo.

(Obsoleto desde a versão 2.89)

distanceFrom(other:GLatLng, radius?:Number) Number Retorna a distância, em metros, deste ponto até o ponto especificado. Por padrão, essa distância é calculada a partir do raio equatorial padrão da Terra, de 6378137 metros. A Terra é aproximada como uma esfera, portanto, a distância admite um desvio de até 0,3%, especialmente nas extremidades polares. Você também pode passar um argumento radius opcional para calcular as distâncias entre as coordenadas GLatLng em esferas com raio diferente da Terra.

(Desde a versão 2.89)

toUrlValue() String Esta versão do método ficou obsoleta diante da versão revisada (mostrada abaixo), que passa um parâmetro precision opcional.

(Obsoleto desde a versão 2.78)

toUrlValue(precision?:Number) String Retorna uma string que representa este ponto em formato compatível para ser usado como valor de parâmetro de URL. A string é separada por vírgula, sem espaços em branco. Por padrão, a precisão é retornada para 6 dígitos, o que corresponde a uma resolução de 4 polegadas/11 centímetros. Um parâmetro precision opcional permite que você especifique uma precisão menor para reduzir a carga do servidor. Observação: Antes da versão 2.78, este parâmetro precision não estava disponível.

(Desde a versão 2.78)

Propriedades

Estas propriedades existem somente para manter a compatibilidade com funções do manipulador de evento da v1. Elas não devem ser usadas.

As propriedades refletem os valores de retorno dos métodos de acesso lng() e lat() e permitem que uma GLatLng seja exibido nos locais em que um GPoint é esperado por um cliente v1. Isto é necessário quando GLatLng aparece em detalhes de evento (isto é, em argumentos de função do manipulador de evento). Ao contrário dos empacotadores de método, na infraestrutura atual é impossível criar empacotadores de evento.

Propriedade Tipo Descrição
x Number Obsoleto.
y Number Obsoleto.

classe GLatLngBounds

Uma instância GLatLngBounds representa um retângulo em coordenadas geográficas, incluindo a que cruza o meridiano de 180 graus.

Construtor

Construtor Descrição
GLatLngBounds(sw?:GLatLng, ne?:GLatLng) Constrói um retângulo a partir dos pontos nas extremidades sudoeste e nordeste.

Métodos

Método Valor de retorno Descrição
equals(other:GLatLngBounds) Boolean Retorna true se todos os parâmetros deste retângulo forem idênticos aos parâmetros do outro, com uma margem de erro específica.
contains(latlng:GLatLng) Boolean Retorna true se as coordenadas geográficas do ponto recaírem dentro deste retângulo.

(Obsoleto desde a versão 2.88)

containsLatLng(latlng:GLatLng) Boolean Retorna true se as coordenadas geográficas do ponto recaírem dentro deste retângulo.

(Desde a versão 2.88)

intersects(other:GLatLngBounds) Boolean Faz o que o nome indica.
containsBounds(other:GLatLngBounds) Boolean Faz o que o nome indica.
extend(latlng:GLatLng) None Amplia este retângulo de modo a incluir o ponto especificado. No sentido longitudinal, ele é ampliado para o modo mais reduzido entre as duas opções possíveis. Se ambas forem iguais, ele será ampliado pela borda leste.
getSouthWest() GLatLng Retorna o ponto na extremidade sudoeste do retângulo.
getNorthEast() GLatLng Retorna o ponto na extremidade nordeste do retângulo.
toSpan() GLatLng Retorna um GLatLng cujas coordenadas representam o tamanho deste retângulo.
isFullLat() Boolean Retorna true se este retângulo se estender do polo Sul ao polo Norte.
isFullLng() Boolean Retorna true se este retângulo se estender ao redor de toda a Terra no sentido longitudinal.
isEmpty() Boolean Retorna true se este retângulo estiver vazio.
getCenter() GLatLng Retorna o ponto no centro do retângulo.

(Desde a versão 2.52)

interface GControl

Esta interface é implementada por todos os controles. Você pode implementá-la de modo a fornecer um controle personalizado para o mapa. Os controles são adicionados ao mapa através do método GMap2.addControl().

Ao contrário das sobreposições, que são posicionadas em relação ao mapa, os controles são posicionados em relação à visualização do mapa, ou seja, eles não se movem quando o mapa é movido.

Construtor

Construtor Descrição
GControl(printable?:Boolean, selectable?:Boolean) Cria a instância de protótipo para uma nova classe de controle. O flag printable indica que o controle deve ficar visível na saída da impressão do mapa. O flag selectable indica que o controle conterá texto que deve ser selecionável.

Métodos

Estes métodos serão chamados pelo mapa quando o controle for adicionado ao mapa através de GMap2.addControl(). Por isso, esses métodos não serão chamados por você, mas você os implementará.

Método Valor de retorno Descrição
printable() Boolean Retorna ao mapa caso o controle deva ser imprimível.
selectable() Boolean Retorna ao mapa caso o controle contenha texto selecionável.
initialize(map:GMap2) Node Será chamado pelo mapa para que o controle possa inicializar. O controle usará o método GMap2.getContainer() para manter o elemento DOM que contém o mapa e incluir-se nele. Ele retorna o elemento adicionado.
getDefaultPosition() GControlPosition Retorna ao mapa a posição da visualização de mapa onde o controle é exibido por padrão. Este método será substituído pelo segundo argumento de GMap2.addControl().

classe GControlPosition

Esta classe descreve a posição de um controle na visualização de mapa. Ela consiste em uma extremidade relativa ao local onde o controle está posicionado e em um deslocamento que determina esta posição. Ela pode ser passada como um argumento position opcional para o método GMap2.addControl(), além de ser retornada do método GControl.getDefaultPosition().

Construtor

Construtor Descrição
GControlPosition(anchor:enum GControlAnchor, offset:GSize) Cria uma especificação para uma posição de controle.

enum GControlAnchor

Constantes

Constante Descrição
G_ANCHOR_TOP_RIGHT O controle será ancorado na extremidade superior direita do mapa.
G_ANCHOR_TOP_LEFT O controle será ancorado na extremidade superior esquerda do mapa.
G_ANCHOR_BOTTOM_RIGHT O controle será ancorado na extremidade inferior direita do mapa.
G_ANCHOR_BOTTOM_LEFT O controle será ancorado na extremidade inferior esquerda do mapa.

classe GControl

Essas implementações de interface GControl estão disponíveis.

Construtor

Construtor Descrição
GSmallMapControl() Cria um controle com botões para aplicar panorâmica em quatro direções e aumentar e diminuir o zoom.
GLargeMapControl() Cria um controle com botões para aplicar panorâmica em quatro direções, aumentar e diminuir o zoom e um regulador de zoom.
GSmallZoomControl() Cria um controle com botões para aumentar e diminuir o zoom.
GScaleControl() Cria um controle que exibe a escala do mapa.
GMapTypeControl() Cria um controle padrão de tipos de mapa que permite selecionar e alternar entre os tipos de mapa aceitos através de botões.
GMenuMapTypeControl() Cria um controle suspenso de tipos de mapa que permite alternar entre os tipos de mapa aceitos.
GHierarchicalMapTypeControl() Cria um controle "hierarquizado" de tipos de mapa que permite selecionar e alternar entre os tipos de mapa aceitos através de botões e caixas de seleção hierarquizadas.
GOverviewMapControl() Cria um mini-mapa panorâmico retrátil na extremidade do mapa principal para servir de referência na localização e navegação (ao arrastá-lo). GOverviewMapControl cria um mapa panorâmico com borda preta de um pixel. Observação: Ao contrário de outros controles, é possível apenas colocar este controle no canto inferior direito do mapa (G_ANCHOR_BOTTOM_RIGHT).

classe GMapTypeControl

Um GMapTypeControl fornece um controle que permite selecionar e alternar entre os tipos de mapa aceitos através de botões. Os controles serão disponibilizados para todos os tipos de mapa atualmente anexados ao mapa no momento em que o controle é construído.

Por padrão, os mapas suportam o conjunto de G_DEFAULT_MAP_TYPES, além de poderem adicionar tipos de mapa explicitamente por meio do GMap2.addMapType(). Para conservar o espaço no mapa, é possível usar um GHierarchicalMapTypeControl para exibir tipos de mapa "aninhados" ou GMenuMapTypeControl para exibir um menu suspenso com tipos de mapas.

Construtor

Construtor Descrição
GMapTypeControl(useShortNames?:Boolean) Cria um GMapTypeControl usando os nomes abreviados (alternativos) dos tipos de mapa, caso useShortNames esteja definido como "true" ou, por padrão, usando os nomes completos.

classe GMenuMapTypeControl

Um GMenuMapTypeControl fornece um controle que permite selecionar e alternar entre os tipos de mapa aceitos através de um menu suspenso. Os controles serão disponibilizados para todos os tipos de mapa atualmente anexados ao mapa no momento em que o controle é construído.

Por padrão, os mapas suportam o conjunto de G_DEFAULT_MAP_TYPES, além de poderem adicionar tipos de mapa explicitamente por meio do GMap2.addMapType().

Construtor

Construtor Descrição
GMenuMapTypeControl(useShortNames?:Boolean) Cria um GMenuMapTypeControl usando os nomes abreviados (alternativos) dos tipos de mapa, caso useShortNames esteja definido como "true" ou, por padrão, usando os nomes completos.

classe GHierarchicalMapTypeControl

GHierarchicalMapTypeControl fornece um controle "hierarquizado" de tipos de mapa que permite selecionar e alternar entre os tipos de mapa aceitos através de botões e caixas de seleção hierarquizadas. Os controles serão disponibilizados para todos os tipos de mapa atualmente anexados ao mapa no momento em que o controle é construído.

Os tipos de mapa adicionados ao mapa são exibidos como botões, como no GMapTypeControl comum. No entanto, os tipos de mapa definidos como subtipos de outros tipos de mapa (consulte o método addRelationship() abaixo) serão exibidos como itens de submenu (caixa de seleção) sob o botão pai.

Por padrão, os mapas suportam o conjunto de G_DEFAULT_MAP_TYPES, apesar de poderem adicionar tipos de mapa explicitamente por meio do GMap2.addMapType(). Os controles serão disponibilizados para todos os tipos de mapa atualmente anexados ao mapa no momento em que o controle é construído. Como os subtipos aparecem como caixas de seleção, você pode trocá-las de lugar com os pais ou irmãos no submenu.

Construtor

Construtor Descrição
GHierarchicalMapTypeControl() Constrói o controle. Por padrão, o tipo de mapa G_HYBRID_MAP é transformado em filho do tipo de mapa G_SATELLITE_MAP. Se a relação for indesejada, ela poderá ser removida chamando o método clearRelationships().

Métodos

Método Valor de retorno Descrição
addRelationship(parentType:GMapType, childType:GMapType, childText?:String, isDefault?:Boolean) None Registra uma relação pai/filho entre os tipos de mapa no controle. Se for especificado childText, ele será exibido ao lado da caixa de seleção do tipo de mapa filho, no lugar do nome. Se isDefault for "true", o tipo de mapa filho será selecionado por padrão. Todas as relações devem ser configuradas antes que o controle seja adicionado. Adicionar relações depois de adicionar o controle não terá efeito.

(Desde a versão 2.94)

removeRelationship(mapType:GMapType) None Remove do controle todas a relações que envolvem um tipo de mapa.

(Desde a versão 2.94)

clearRelationships() None Remove do controle todas as relações.

(Desde a versão 2.94)

classe GMapType

O Google fornece alguns tipos de mapa predefinidos - esta classe é usada para definir os tipos personalizados. Para mostrá-los no mapa, use o construtor GMap2 ou o método GMap2.addMapType(). Consulte também GTileLayerOverlay para adicionar às camadas de bloco do mapa (em vez de substituir totalmente).

Esta classe também pode ser transformada em subclasse. Os argumentos do construtor poderão ser omitidos se forem instanciados como protótipos. Um construtor de subclasse deve chamar o construtor GMapType usando call().

Construtor

Construtor Descrição
GMapType(layers:GTileLayer[], projection:GProjection, name:String, opts?:GMapTypeOptions) Constrói um tipo de mapa com as camadas de bloco, projeção, nome e parâmetros opcionais especificados.

Métodos

Estes métodos normalmente são chamados pelo mapa ao qual este tipo de mapa é passado, mas alguns métodos também podem ser chamados de fora do mapa, como getBoundsZoomLevel().

Método Valor de retorno Descrição
getSpanZoomLevel(center:GLatLng, span:GLatLng, viewSize:GSize) Number Retorna ao mapa o nível de zoom em que a seção do mapa definida pelo centro e o intervalo se ajusta na visualização do mapa do tamanho especificado em pixels.
getBoundsZoomLevel(bounds:GLatLngBounds, viewSize:GSize) None Retorna ao mapa o nível de zoom em que a seção do mapa definida pelos limites se ajusta na visualização do mapa do tamanho especificado em pixels.
getName(short?:Boolean) String Retorna ao mapa o nome do tipo de mapa que será usado como rótulo do botão no GMapTypeControl.
getProjection() GProjection Retorna ao mapa a projeção deste tipo de mapa.
getTileSize() Number Retorna ao mapa o tamanho do bloco de mapa, em pixels, deste tipo de mapa. Parte-se do pressuposto que os blocos são quadráticos. Todas as camadas de bloco têm o mesmo tamanho de bloco.
getTileLayers() GTileLayer[] Retorna ao mapa a matriz de camadas de bloco.
getMinimumResolution() Number Retorna ao mapa o nível de zoom mais baixo em que este tipo de mapa é definido.
getMaximumResolution() Number Retorna ao mapa o nível de zoom mais alto em que este tipo de mapa é definido.
getTextColor() String Retorna ao mapa a cor que fica melhor para o texto sobreposto ao mapa. Usado para a cor do texto da mensagem de direitos autorais exibida pelo controle de direitos autorais.
getLinkColor() String Retorna ao mapa a cor que fica melhor para o hiperlink sobreposto ao mapa. Usado para a cor do link para os termos de uso exibidos pelo controle de direitos autorais.
getErrorMessage() String Retorna ao mapa a mensagem de erro exibida em áreas ou no nível de zoom onde este tipo de mapa não possui blocos de mapa.
getCopyrights(bounds:GLatLngBounds, zoom:Number) String[] Retorna ao mapa as mensagens de direitos autorais apropriadas para a região descrita pelo bounds no nível de zoom determinado. Usado pela mensagem de direitos autorais no mapa.
getUrlArg() String Retorna ao mapa um valor que é usado como valor de parâmetro URL para identificar este tipo de mapa em ligações permanentes com a visualização de mapa atual. Atualmente é usado somente por aplicativos de mapas.
getAlt() String Retorna ao mapa o texto alternativo deste tipo de mapa.

(Desde a versão 2.86)

Constantes

Constante Descrição
G_NORMAL_MAP Este tipo de mapa (que é o padrão) exibe um mapa de ruas comum.
G_SATELLITE_MAP Este tipo de mapa exibe imagens de satélite.
G_HYBRID_MAP Este tipo de mapa exibe uma camada transparente das principais ruas nas imagens de satélite.
G_PHYSICAL_MAP Este tipo de mapa exibe os mapas com características físicas como terreno e vegetação. Este tipo de mapa não é exibido dentro dos controles de tipo de mapa por padrão.

(Desde a versão 2.94)

G_MOON_ELEVATION_MAP Este tipo de mapa exibe um mapa plano sombreado na superfície da Lua, com altitudes diferenciadas por cores. Este tipo de mapa não é exibido dentro dos controles de tipo de mapa por padrão.

(Desde a versão 2.95)

G_MOON_VISIBLE_MAP Este tipo de mapa exibe fotografias tiradas da órbita da Lua. Este tipo de mapa não é exibido dentro dos controles de tipo de mapa por padrão.

(Desde a versão 2.95)

G_MARS_ELEVATION_MAP Este tipo de mapa exibe um mapa em relevo sombreado na superfície de Marte, com altitudes diferenciadas por cores. Este tipo de mapa não é exibido dentro dos controles de tipo de mapa por padrão.

(Desde a versão 2.95)

G_MARS_VISIBLE_MAP Este tipo de mapa exibe fotografias tiradas da órbita de Marte. Este tipo de mapa não é exibido dentro dos controles de tipo de mapa por padrão.

(Desde a versão 2.95)

G_MARS_INFRARED_MAP Este tipo de mapa exibe um mapa infravermelho sombreado na superfície de Marte, no qual as áreas quentes aparecem brilhantes e as áreas frias aparecem escuras.

(Desde a versão 2.95)

G_SKY_VISIBLE_MAP Este tipo de mapa mostra um mosaico do céu, abrangendo toda a esfera celeste.

(Desde a versão 2.95)

G_SATELLITE_3D_MAP Este tipo de mapa, junto com o Plug-in do navegador do Google Earth, exibe um modelo 3D interativo da Terra com imagens de satélite. Este tipo de mapa não é exibido dentro dos controles de tipo de mapa por padrão.

A adição desse tipo de mapa ao seu mapa não apenas adiciona um controle ao tipo de mapa do Google Earth, mas também manipula a inicialização do tipo de mapa assim que um usuário clica no controle. Se no momento um usuário não tem o Plug-in do Google Earth instalado no navegador, na primeira vez em que esse usuário selecionar esse tipo de mapa, receberá uma solicitação para fazer o download, instalar o Plug-in e reiniciar o navegador.

Para usuários que já possuem o plug-in instalado, a seleção desse tipo de mapa criará uma instância da Terra para o mapa e exibirá uma visualização 3D da Terra. É possível usar o GMap2.getEarthInstance() para recuperar essa instância da Terra e manipulá-la usando a API do Google Earth.

No momento, marcadores, janelas de informação e polilinhas funcionam com esse tipo de mapa 3D, mas outros recursos ainda não são suportados. Planejamos aumentar suporte para mais recursos em lançamentos futuros.

(Desde a versão 2.113)

G_DEFAULT_MAP_TYPES Uma matriz dos três primeiros tipos de mapas predefinidos descritos acima (G_NORMAL_MAP, G_SATELLITE_MAP e G_HYBRID_MAP).
G_MOON_MAP_TYPES Matriz dos dois tipos de Lua definidos acima (G_MOON_ELEVATION_MAP e G_MOON_VISIBLE_MAP).
G_MARS_MAP_TYPES Matriz dos três tipos de mapa de Marte definidos acima (G_MARS_ELEVATION_MAP, G_MARS_VISIBLE_MAP e G_MARS_INFRARED_MAP).
G_SKY_MAP_TYPES Matriz do único tipo de mapa do céu definido acima (G_SKY_VISIBLE_MAP).

Eventos

Evento Descrição
newcopyright(copyright:GCopyright) Este evento é disparado quando um novo direito autoral é adicionado à coleção de direitos autorais de uma das camadas de bloco contidas neste tipo de mapa.

classe GMapTypeOptions

As instâncias desta classe são usadas como o argumento opts? do construtor GMapType Não há nenhum construtor para esta classe. Ela é instanciada como literal de objeto JavaScript.

Propriedades

Propriedade Tipo Descrição
shortName String Define o nome abreviado do tipo de mapa retornado de GMapType.getName(true). O padrão é o mesmo de name.
urlArg String Define o argumento url do tipo de mapa retornado de GMapType.getUrlArg(). A string vazia é o padrão.
maxResolution Number Define o nível máximo de zoom deste tipo de mapa, retornado por GMapType.getMaximumResolution(). O padrão é o máximo de todas as camadas de bloco.
minResolution Number Define o nível mínimo de zoom deste tipo de mapa, retornado por GMapType.getMinimumResolution(). O padrão é o mínimo de todas as camadas de bloco.
tileSize Number Define o tamanho de bloco retornado por GMapType.getTileSize(). O padrão é 256.
textColor String Define a cor de texto retornada por GMapType.getTextColor(). O padrão é "black".
linkColor String Define a cor de texto retornada por GMapType.getLinkColor(). O padrão é "#7777cc".
errorMessage String Define a mensagem de erro retornada por GMapType.getErrorMessage(). A string vazia é o padrão.
alt String Define o texto alternativo ao tipo de mapa retornado por GMapType.getAlt(). A string vazia é o padrão.

(Desde a versão 2.64)

radius Number Define o raio do tipo de mapa especificado pelo Number passado, medido em metros. O valor padrão é 6378137 metros, o raio equatorial da Terra.

(Desde a versão 2.89)

classe GLayer

Essa classe instancia uma sobreposição de "camada" predefinida composta por uma coleção de itens relacionados. Ela implementa a interface GOverlay e, por isso, é adicionada ao mapa usando o método GMap2.addOverlay().

Construtor

Construtor Descrição
GLayer(layerId:String) Cria uma camada usando o ID de Camada exclusivo fornecido. http://spreadsheets.google.com/pub?key=p9pdwsai2hDN-cAocTLhnag contém uma lista das camadas suportadas no momento.

Métodos

Método Valor de retorno Descrição
hide() None Oculta esta sobreposição para que não fique visível, mas mantém sua posição na pilha de sobreposições.
show() None Mostra uma GLayer oculta anteriormente.

Métodos estáticos

Método Valor de retorno Descrição
GLayer.isHidden(layerId:String) None Retorna true se a sobreposição de camada estiver oculta ou não tiver sido adicionada ao mapa usando o método GMap2.addOverlay(). Caso contrário, retorna false.

interface GTileLayer

Esta interface pode ser implementada para fornecer camadas de bloco de mapas personalizadas com o uso de GMapType ou de GTileLayerOverlay. Sua implementação desta interface deve usar uma instância de GTileLayer como protótipo, que implementa a manipulação de direitos autorais.

Construtor

Construtor Descrição
GTileLayer(copyrights:GCopyrightCollection, minResolution:Number, maxResolution:Number, options?:GTileLayerOptions) Os argumentos do construtor poderão ser omitidos se forem instanciados como protótipos. Um construtor de subclasse deve invocar o construtor usando call(). O parâmetro options opcional especifica um conjunto de GTileLayerOptions que deve ser passado como literal de um objeto.

Métodos

Estes métodos são chamados pelo mapa e o tipo de mapa para o qual é passada esta camada de bloco. Será preciso implementar os métodos marcados como abstratos ao implementar uma camada de bloco personalizada.

Método Valor de retorno Descrição
minResolution() Number Retorna ao tipo de mapa o nível de zoom mais baixo desta camada de bloco.
maxResolution() Number Retorna ao tipo de mapa o nível de zoom mais alto desta camada de bloco.
getTileUrl(tile:GPoint, zoom:Number) String Abstrato. Retorna ao mapa o URL do bloco de mapa com os índices de bloco especificados pelas propriedades x e y de GPoint, no nível de zoom especificado.
isPng() Boolean Abstrato. Retorna ao mapa se os blocos estão no formato de imagem PNG, podendo ser transparentes. Caso contrário, retorna GIF.
getOpacity() Number Abstrato. Retorna ao mapa a opacidade para exibição desta camada de bloco. 1.0 é opaco, 0.0 é transparente.
getCopyright(bounds:GLatLngBounds, zoom:Number) String Abstrato. Retorna ao mapa as mensagens de direitos autorais desta camada de bloco que forem pertinentes à região de mapa especificada no nível de zoom especificado. Usado para gerar a mensagem de direitos autorais do GMapType ao qual pertence esta camada de bloco.

(Desde a versão 2.89)

Eventos

Evento Descrição
newcopyright(copyright:GCopyright) Este evento é disparado quando um novo direito autoral é adicionado à coleção de direitos autorais desta camadas de bloco.

classe GTileLayerOptions

Esta classe representa os argumentos opcionais para a interface GTileLayer. Essa classe não possui construtor, mas é instanciada como literal de objeto.

Propriedades

Propriedade Tipo Descrição
opacity Number Define a opacidade de bloco de 0.0 (invisível) para 1.0 (opaca). O padrão é 1.0.
isPng Boolean Indica se os blocos estão no formato PNG.
tileUrlTemplate String Especifica um modelo para os URLs de bloco que serão expandidos para que cada solicitação de bloco faça referência a um único bloco, com base em um sistema de coordenadas existente. Colocar um modelo no construtor GTileLayer permite a recuperação ativa dos blocos por meio desse sistema de coordenadas, semelhante ao modo como o Google Maps recupera os blocos.

Os modelos devem ter a seguinte forma:
http://host/tile?x={X}&y={Y}&z={Z}.png
, em que X e Y se referem às coordenadas de bloco latitudinal e longitudinal e Z se refere ao nível do zoom. Exemplo. http://host/tile?x=3&y=27&z=5.png.
draggingCursor String Cursor exibido enquanto o mapa estiver sendo arrastado.

(Desde a versão 2.59)

classe GTileLayerOverlay

Uma GTileLayerOverlay amplia o mapa com uma GTileLayer. Ela implementa a interface GOverlay e, por isso, é adicionada ao mapa usando o método GMap2.addOverlay(). A GTileLayer é apresentada acima da imagem de mapa existente. Para substituir a imagem, coloque a GTileLayer dentro de um GMapType personalizado.

Construtor

Construtor Descrição
GTileLayerOverlay(tileLayer:GTileLayer, opts?:GTileLayerOverlayOptions) Cria uma GOverlay que empacota a tileLayer.

(Desde a versão 2.61)

Métodos

Método Valor de retorno Descrição
hide() None Oculta a sobreposição para que não fique visível, mas mantém sua posição na pilha de sobreposições.

(Desde a versão 2.71)

isHidden() None Retorna true se a sobreposição de camada de bloco estiver oculta. Caso contrário, retorna false.

(Desde a versão 2.87)

show() None Mostra uma GTileLayerOverlay oculta anteriormente.

(Desde a versão 2.71)

refresh() None Recarrega todos os blocos visíveis anexados a essa GTileLayerOverlay.

(Desde a versão 2.132)

supportsHide() None Sempre retorna true.

(Desde a versão 2.87)

getTileLayer() None Retorna a camada de bloco usada por esta sobreposição.

(Desde a versão 2.83)

classe GTileLayerOverlayOptions

Esta classe representa os argumentos opcionais para o construtor GTileLayerOverlayOptions. Essa classe não possui construtor, mas é instanciada como literal de objeto.

Propriedades

Propriedade Tipo Descrição
zPriority Number zPriority contém um valor que determina a "ordem z" relativa para essa TileLayerOverlay. As camadas de bloco com uma prioridade mais alta serão renderizadas acima das camadas de bloco com uma prioridade mais baixa.

(Desde a versão 2.110)

classe GCopyrightCollection

Use esta classe para gerenciar as mensagens de direitos autorais exibidas nos mapas do tipo personalizado. Se você for não implementar tipos de mapa personalizados, não precisará usar esta classe. Uma coleção de direitos autorais contém informações sobre determinados direitos autorais a serem exibidos para determinadas regiões do mapa em determinados nível de zoom. Isso é especialmente importante para tipos de mapa que exibem dados heterogêneos como o tipo de mapa de satélite.

Construtor

Construtor Descrição
GCopyrightCollection(prefix?:String) O prefixo em comum das mensagens de direitos autorais produzidas a partir desta coleção será especificado como argumento.
Exemplo: "Imagery (C) 2006"

Métodos

Método Valor de retorno Descrição
addCopyright(copyright:GCopyright) None Adiciona à coleção um objeto informações de direitos autorais.
getCopyrights(bounds:GLatLngBounds, zoom:Number) String[] Retorna todas as strings de direitos autorais pertinentes à região de mapa especificada no nível de zoom especificado.
Exemplo: [ "Google", "Keyhole" ]
getCopyrightNotice(bounds:GLatLngBounds, zoom:Number) String Retorna o prefixo e todas as strings de direitos autorais relevantes que forem pertinentes à região de mapa especificada no nível de zoom especificado.
Exemplo: "Imagery (C) 2006 Google, Keyhole"

Eventos

Evento Descrição
newcopyright(copyright:GCopyright) Este evento é disparado quando um novo direito autoral é adicionado a esta coleção de direitos autorais.

classe GCopyright

Um objeto direito autoral contém informações sobre quais mensagens de direitos autorais se aplicam a uma região do mapa especificada por um retângulo, em um nível de zoom especificado. Esse objeto somente é necessário quando você implementa tipos de mapa personalizados ou camadas de bloco.

Construtor

Construtor Descrição
GCopyright(id:Number, bounds:GLatLngBounds, minZoom:Number, text:String) Cria um objeto informações de direitos autorais com as propriedades especificadas.

Propriedades

Propriedade Tipo Descrição
id Number Identificador exclusivo das informações de direitos autorais.
minZoom Number Nível de zoom mais baixo a que se referem as informações.
bounds GLatLngBounds Região a que se referem as informações.
text String Texto da mensagem de direitos autorais.

interface GProjection

Interface das projeções de mapa. Uma instância de projeção de mapa é passada ao construtor de GMapType. Esta interface é implementada pelo class GMercatorProjection, usado por todos os tipos de mapa predefinidos. Você pode implementar esta interface quando quiser definir tipos de mapa com projeções de mapa diferentes.

Métodos

Estes métodos são chamados pelo mapa. É necessário implementá-los.

Método Valor de retorno Descrição
fromLatLngToPixel(latlng:GLatLng, zoom:Number) GPoint Retorna as coordenadas de mapa em pixels do ponto referente às coordenadas geográficas especificadas e ao nível de zoom especificado.
fromPixelToLatLng(pixel:GPoint, zoom:Number, unbounded?:Boolean) GLatLng Retorna as coordenadas geográficas do ponto referente às coordenadas de mapa em pixels especificadas e ao nível de zoom especificado. O flag unbounded faz com que a coordenada longitudinal geográfica não seja ajustada quando estiver além do meridiano de -180 ou 180 graus.
tileCheckRange(tile:GPoint, zoom:Number, tilesize:Number) Boolean Retorna ao mapa se o índice de bloco está em um intervalo válido para o tipo de mapa. Se não estiver, o mapa exibirá um bloco vazio. Este método também pode modificar o índice de tile para que aponte para outra instância do mesmo bloco, caso o mapa contenha mais de uma cópia da Terra e, com isso, o mesmo bloco em diferentes coordenadas de bloco.
getWrapWidth(zoom:Number) Number Retorna ao mapa a periodicidade na direção x, ou seja, o número de pixels após o qual o mapa se repete porque se ajustou uma vez ao redor da Terra. Por padrão, retorna Infinity, ou seja, o mapa não se repetirá. Isto é usado pelo mapa para calcular o posicionamento das sobreposições em visualizações de mapa que contêm mais de uma cópia da Terra (o que geralmente ocorre apenas em níveis baixos de zoom).

(Desde a versão 2.46)

classe GMercatorProjection

Essa implementação da interface GProjection para a projeção de Mercator é usada por todos os tipos de mapas predefinidos.

Construtor

Construtor Descrição
GMercatorProjection(zoomlevels:Number) Cria uma projeção de Mercator para o número especificado de níveis de zoom.

Métodos

Método Valor de retorno Descrição
fromLatLngToPixel(latlng:GLatLng, zoom:Number) GPoint Consulte GProjection.
fromPixelToLatLng(pixel:GPoint, zoom:Number, unbounded?:Boolean) GLatLng Consulte GProjection.
tileCheckRange(tile:GPoint, zoom:Number, tilesize:Number) None Consulte GProjection.
getWrapWidth(zoom:Number) None Consulte GProjection. Projeção de Mercator na direção longitudinal, retornando a largura do mapa de toda a Terra, em pixels, no nível de zoom especificado.

(Desde a versão 2.46)

espaço para nome GEvent

Este espaço para nome contém funções que podem ser usadas para registrar manipuladores de eventos (para eventos personalizados ou DOM) e para disparar eventos personalizados. Todos os eventos definidos por esta API são eventos personalizados disparados internamente por GEvent.trigger().

Métodos estáticos

Método Valor de retorno Descrição
GEvent.addListener(source:Object, event:String, handler:Function) GEventListener Registra um manipulador de evento para um evento personalizado no objeto de origem. Retorna um manipulador que pode ser usado para, depois, cancelar seu registro. O manipulador de evento será chamado com this definido como o objeto de origem.
GEvent.addDomListener(source:Node, event:String, handler:Function) GEventListener Registra um manipulador para um evento DOM no objeto de origem. O objeto de origem deve ser um nó DOM. Retorna um manipulador que pode ser usado para, depois, cancelar seu registro. O manipulador de evento será chamado com this definido como o objeto de origem. Esta função usa os métodos DOM para o navegador atual registrar o manipulador de evento.
GEvent.removeListener(handle:GEventListener) None Remove um manipulador instalado com o uso de addListener() ou addDomListener().
GEvent.clearListeners(source:Object or Node, event:String) None Remove todos os manipuladores do objeto especificado para o evento especificado que foram instalados usando addListener() ou addDomListener().
GEvent.clearInstanceListeners(source:Object or Node) None Remove todos os manipuladores do objeto especificado referentes a todos os eventos instalados usando addListener() ou addDomListener().
GEvent.clearNode(source:Node) None Chama clearInstanceListeners em um nó e todos seus nós filhos, recursivamente.
GEvent.trigger(source:Object, event:String, ...) None Dispara um evento personalizado no objeto de origem. Todos os argumentos opcionais restantes após event são passados como argumentos para as funções do manipulador de evento.
GEvent.bind(source:Object, event:String, object:Object, method:Function) GEventListener Registra uma chamada do método no objeto especificado como o manipulador para um evento personalizado no objeto de origem. Retorna um manipulador que pode ser usado para, depois, cancelar seu registro.
GEvent.bindDom(source:Node, event:String, object:Object, method:Function) GEventListener Registra uma chamada do método no objeto especificado como o manipulador para um evento personalizado no objeto de origem. Retorna um manipulador que pode ser usado para, depois, cancelar seu registro.
GEvent.callback(object:Object, method:Function) Function Retorna um fechamento que chama method em object.
GEvent.callbackArgs(object:Object, method:Function, ...) Function Retorna um fechamento que chama method em object. Todos os argumentos opcionais restantes após method são passados como argumentos method, quando a função retornada é chamada.

Eventos

Evento Descrição
clearlisteners(event?:String) Este evento é disparado no objeto quando clearListeners() ou clearInstanceListeners() é chamada nesse objeto. Certamente, este evento é disparado antes que as funções sejam executadas.

classe GEventListener

Esta classe é opaca. Ela não possui nenhum método nem construtor. Suas instâncias são retornadas de GEvent.addListener() ou GEvent.addDomListener() e, depois, são passadas de volta para GEvent.removeListener().

espaço para nome GXmlHttp

Este espaço para nome dispõe de um método de fábrica para criar instâncias XmlHttpRequest, independentemente do navegador.

Métodos estáticos

Método Valor de retorno Descrição
GXmlHttp.create() GXmlHttp Fábrica para criar uma nova instância de XmlHttpRequest.

espaço para nome GXml

Este espaço para nome fornece métodos estáticos para manipular documentos e fragmentos de documentos XML.

Métodos estáticos

Método Valor de retorno Descrição
GXml.parse(xmltext:String) Node Analisa a string especificada como texto XML e retorna uma representação DOM. Caso o navegador não aceite a análise de XML originalmente, retorna o nó DOM de um elemento DIV vazio.
GXml.value(xmlnode:Node) String Retorna o valor de texto (isto é, o conteúdo de texto simples) do fragmento de documento XML especificado na representação DOM.

classe GXslt

Esta classe dispõe de métodos para aplicar XSLT a XML, independentemente do navegador.

Métodos estáticos

Método Valor de retorno Descrição
GXslt.create(xsltnode:Node) GXslt Cria uma instância de GXslt a partir da folha de estilo XSLT especificada como representação DOM.
GXslt.transformToHtml(xmlnode:Node, htmlnode:Node) Boolean Usa a folha de estilo XSLT especificada no construtor desta instância GXslt para transformar o documento XML especificado em representação DOM em xmlnode. Anexa o fragmento de documento HTML resultante ao htmlnode especificado. Funciona somente se o navegador aceitar transformações de XSL originalmente, caso em que retorna true. Caso contrário, esta função não faz nada e retorna false.

espaço para nome GLog

Este espaço para nome contém alguns métodos estáticos que o ajudam a depurar aplicativos web. Quando você usa um dos métodos write*() pela primeira vez, uma janela flutuante é aberta na página e exibe as mensagens escritas.

Métodos estáticos

Método Valor de retorno Descrição
GLog.write(message:String, color?:String) None Escreve a mensagem como texto simples dentro da janela de registro. Os caracteres de marcação HTML terão escape para que apareçam como caracteres.
GLog.writeUrl(url:String) None Escreve um link para o URL especificado dentro da janela de registro.
GLog.writeHtml(html:String) None Escreve texto como HTML na janela de registro.

classe GDraggableObject

Esta classe torna um elemento DOM arrastável. Os membros estáticos para alteração dos cursores de arrastamento afetam todos os objetos arrastáveis criados subsequentemente, como mapa, controle deslizante de zoom e retângulos de mapa panorâmico. Os membros de cada instância afetam somente a respectiva instância. Por exemplo, antes de criar o mapa, você pode chamar GDraggableObject.setDraggableCursor('default') e GDraggableObject.setDraggingCursor('move') para obter o estilo anterior à API 2.56. Como alternativa, o construtor do mapa pode usar opções para definir o estilo de cursor de seu objeto arrastável (DraggableObject). Consulte os valores de cursor permitidos na especificação W3C CSS.

Construtor

Construtor Descrição
GDraggableObject(src:Node, opts?:GDraggableObjectOptions) Define manipuladores de evento para que o elemento de origem possa ser arrastado. Posições opcionais à esquerda e acima para o elemento. O recipiente opcional funciona como caixa delimitadora.

(Desde a versão 2.59)

Métodos estáticos

Método Valor de retorno Descrição
GDraggableObject.setDraggableCursor(cursor:String) None Define o cursor arrastável para os objetos arrastáveis criados subsequentemente.

(Desde a versão 2.59)

GDraggableObject.setDraggingCursor(cursor:String) None Define o cursor de arrastamento para os objetos arrastáveis criados subsequentemente.

(Desde a versão 2.59)

GDraggableObject.getDraggingCursor() String Retorna o cursor de arrasto em uso pelo mapa no momento. Se não for definido pelo método estático setDraggingCursor(), retorna o cursor padrão usado pelo mapa para seus controles e marcadores.

(Desde a versão 2.87)

GDraggableObject.getDraggableCursor() String Retorna o cursor arrastável em uso pelo mapa no momento. Se não for definido pelo método estático setDraggableCursor(), retorna o cursor padrão usado pelo mapa para seus controles e marcadores.

(Desde a versão 2.87)

Métodos

Método Valor de retorno Descrição
setDraggableCursor(cursor:String) None Define o cursor do mouse quando passa sobre este objeto arrastável.

(Desde a versão 2.59)

setDraggingCursor(cursor:String) None Define o cursor quando o mouse é mantido pressionado, arrastando o objeto arrastável.

(Desde a versão 2.59)

moveTo(point:GPoint) None Move o GDraggableObject para uma posição absoluta especificada por coordenadas em pixels em relação ao nó pai. Este método usa o sistema de coordenadas DOM, isto é, a coordenada X aumenta para a esquerda e a coordenada Y aumenta para baixo.

(Desde a versão 2.89)

moveBy(size:GSize) None Move o GDraggableObject em um deslocamento de tamanho especificado. Este método usa o sistema de coordenadas DOM, isto é, a largura aumenta para a esquerda e a altura aumenta para baixo.

(Desde a versão 2.89)

Eventos

Evento Descrição
mousedown() Este evento é disparado em resposta ao evento mousedown do DOM. A manipulação deste evento impede a ação padrão do evento mousedown DOM.

(Desde a versão 2.84)

mouseup() Este evento é disparado em resposta ao evento mouseup do DOM em um objeto arrastável. A manipulação deste evento impede a ação padrão do evento mouseup DOM.

(Desde a versão 2.84)

click() Este evento é disparado quando um objeto arrastável é clicado.

(Desde a versão 2.84)

dragstart() Este evento é disparado no início do evento de arrasto de um objeto arrastável (quando o usuário clica e arrasta um objeto arrastável).

(Desde a versão 2.84)

drag() Este evento é disparado repetidamente enquanto o usuário arrasta o objeto arrastável.

(Desde a versão 2.84)

dragend() Este evento é disparado no fim do evento de arrasto de um objeto arrastável (quando o usuário solta o objeto).

(Desde a versão 2.84)

classe GDraggableObjectOptions

Esta classe representa os argumentos opcionais para o construtor GDraggableObject. Essa classe não possui construtor, mas é instanciada como literal de objeto.

Propriedades

Propriedade Tipo Descrição
left Number Posição inicial à esquerda do objeto.

(Desde a versão 2.59)

top Number Posição inicial no topo do objeto.

(Desde a versão 2.59)

container Node Um elemento DOM que funcionará como caixa delimitadora para o objeto arrastável.

(Desde a versão 2.59)

draggableCursor String Cursor a ser exibido quando ocorrer mouseover.

(Desde a versão 2.59)

draggingCursor String Cursor a ser exibido durante o arrasto.

(Desde a versão 2.59)

delayDrag Boolean Por padrão, o evento dragstart é disparado quando o evento mousedown DOM é disparado em um elemento DOM arrastável. Da mesma forma, o evento dragend é disparado quando o evento mouseup DOM é disparado. Definir este valor como true adia os eventos da ação de arrastar até que o mouse seja movido da localização onde o mousedown ou o mouseup foi gerado. O valor padrão desta propriedade é false.

(Desde a versão 2.84)

enum GGeoStatusCode

Os equivalentes numéricos de cada constante simbólica são especificados entre parênteses.

Constantes

Constante Descrição
G_GEO_SUCCESS
= 200
Não ocorreu nenhum erro; o endereço foi analisado com êxito e seu geocódigo foi retornado.

(Desde a versão 2.55)

G_GEO_BAD_REQUEST
= 400
Uma solicitação de rota não foi analisada com êxito. Por exemplo, a solicitação pode ter sido rejeitada por exceder o número máximo de waypoints permitidos.

(Desde a versão 2.81)

G_GEO_SERVER_ERROR
= 500
Uma solicitação de geocódigo ou rota não foi processada com êxito, porém o motivo exato da falha é desconhecido.

(Desde a versão 2.55)

G_GEO_MISSING_QUERY
= 601
O parâmetro HTTP q estava ausente ou não tinha valor algum. No caso de solicitações de geocódigo, significa que um endereço vazio foi especificado como entrada. No caso de solicitações de rota, significa que nenhuma consulta foi especificada na entrada.

(Desde a versão 2.81)

G_GEO_MISSING_ADDRESS
= 601
Sinônimos de G_GEO_MISSING_QUERY.

(Desde a versão 2.55)

G_GEO_UNKNOWN_ADDRESS
= 602
Nenhuma localização geográfica correspondente foi encontrada para o endereço especificado. Isso pode ocorrer porque o endereço é relativamente novo ou está incorreto.

(Desde a versão 2.55)

G_GEO_UNAVAILABLE_ADDRESS
= 603
Não é possível retornar o geocódigo do endereço especificado ou a rota para a consulta de rota especificada devido a motivos legais ou contratuais.

(Desde a versão 2.55)

G_GEO_UNKNOWN_DIRECTIONS
= 604
O objeto GDirections não pôde calcular as rotas entre os pontos mencionados na consulta. Isso geralmente ocorre porque não há rota disponível entre os dois pontos ou porque não temos os dados de rota da região.

(Desde a versão 2.81)

G_GEO_BAD_KEY
= 610
A chave especificada é inválida ou não corresponde ao domínio para o qual foi fornecida.

(Desde a versão 2.55)

G_GEO_TOO_MANY_QUERIES
= 620
A chave especificada ultrapassou o limite de solicitações em um período de 24 horas ou enviou muitas solicitações em um período muito curto. Se você estiver enviando diversas solicitações em paralelo ou em um loop simples, use um temporizador ou pausa em seu código para garantir que as solicitações não sejam enviadas muito rapidamente rapidez.

(Desde a versão 2.55)

enum GGeoAddressAccuracy

Não há nenhuma constante simbólica definida para esta enumeração.

Constantes

Constante Descrição
0 Localização desconhecida.

(Desde a versão 2.59)

1 Precisão no nível do país.

(Desde a versão 2.59)

2 Precisão no nível da região (estado, província, distrito etc).

(Desde a versão 2.59)

3 Precisão no nível da sub-região (condado, município etc).

(Desde a versão 2.59)

4 Precisão no nível da comarca (cidade, aldeia).

(Desde a versão 2.59)

5 Precisão no nível do código postal (CEP).

(Desde a versão 2.59)

6 Precisão no nível da rua.

(Desde a versão 2.59)

7 Precisão no nível do cruzamento.

(Desde a versão 2.59)

8 Precisão no nível do endereço.

(Desde a versão 2.59)

9 Premissa (nome do edifício, nome da propriedade, nome do shopping etc). nível de precisão.

(Desde a versão 2.105)

classe GClientGeocoder

Esta classe é usada para fazer a comunicação direta com os servidores do Google a fim de obter geocódigos para os endereços especificados pelo usuário. Além disso, um serviço de geocódigos mantém seu próprio cache de endereços, permitindo que consultas repetidas sejam respondidas sem precisar percorrer todo o servidor. Uma prática recomendada geral é não usar funções GClientGeocoder em um loop. Os desenvolvedores que possuem diversos endereços para geocódigos devem usar nosso Geocodificador HTTP.

Construtor

Construtor Descrição
GClientGeocoder(cache?:GGeocodeCache) Cria uma nova instância de um serviço de geocódigos que conversa diretamente com os servidores do Google. O parâmetro opcional de cache permite especificar um cache personalizado do cliente para endereços conhecidos. Se nada for especificado, um GFactualGeocodeCache é usado.

(Desde a versão 2.55)

Métodos

Método Valor de retorno Descrição
getLatLng(address:String, callback:function) None Envia uma solicitação aos servidores do Google para geocodificar o endereço especificado. Se o endereço foi localizado com êxito, a função de retorno de chamada especificada pelo usuário é chamada com um ponto GLatLng. Caso contrário, a função de retorno de chamada recebe um ponto null. Em caso de endereços ambíguos, somente o ponto da correspondência perfeita é passado para a função de retorno de chamada.

(Desde a versão 2.55)

getLocations(query:String|GLatLng, callback:function) None Este método envia uma solicitação ao serviço de geocodificação do Google, solicitando a análise da query especificada e a entrega da resposta na callback especificada. Geocodificação se refere à conversão de endereços legíveis para os humanos em valores de latitude/longitude. O serviço de geocodificação do Google também suporta a geocodificação reversa, em que um ponto geográfico fornecido é convertido em um endereço legível para humanos. Para usar esse serviço de geocodificação, chame esse método informando sobre a query a ser geocodificada. Se a consulta for fornecida como uma String endereçável, o serviço realizará um geocódigo padrão. Se, no entanto, a query contiver uma GLatLng, o serviço realizará um geocódigo inverso. Como esse método exige uma chamada para um servidor do Google, você também deve passar um método callback para manipular a resposta. Essa resposta conterá um código Status e, se tiver êxito, um ou mais objetos Placemark. Ao contrário do método GClientGeocoder.getLatLng, a função de retorno de chamada pode determinar as razões da falha examinando o campo Status.

(Desde a versão 2.55)

getCache() GGeocodeCache Retorna o cache de geocódigos usado no momento ou null se não ocorrer nenhum armazenamento em cache por parte do cliente.

(Desde a versão 2.55)

setCache(cache:GGeocodeCache) None Define um novo cache do cliente. Se este método for invocado com o cache definido como null, o cache do cliente fica desativado. Definir um novo cache descarta os endereços que foram armazenados anteriormente.

(Desde a versão 2.55)

setViewport(bounds:GLatLngBounds) None Define o serviço de geocódigos para ampliar os resultados da geocodificação na janela de visualização ou perto dela. A janela de visualização é expressa como um retângulo GLatLngBounds. Definir uma janela de visualização não restringe os resultados a essa caixa delimitadora, porém, aumenta-lhes a prioridade.

(Desde a versão 2.82)

getViewport() GLatLngBounds Retorna a janela de visualização para ampliar os resultados da geocodificação neste serviço de geocódigos. A janela de visualização é expressa como um retângulo GLatLngBounds.

(Desde a versão 2.82)

setBaseCountryCode(countryCode:String) None

Define o serviço de geocódigos para induzir os resultados de pesquisa como se tivessem sido enviados do domínio especificado pelo domínio de nível superior do código de país (ccTLD) especificado. A geocodificação só é aceita nos países em que o próprio Google Maps a disponibiliza. Quase todos os códigos ccTLD são idênticos aos códigos ISO 3166-1, com algumas exceções notáveis. Por exemplo, o ccTLD da Grã-Bretanha é "uk" (.co.uk), enquanto seu código ISO 3166-1 é "GB."

O domínio padrão é o domínio a partir do qual você carrega inicialmente a API do Google Maps. Os códigos de país não diferenciam minúsculas de maiúsculas.

(Desde a versão 2.82)

getBaseCountryCode() String Retorna o código de país em uso pelo geocodificador especificado. Se não houver nenhum código de país em vigor, este método retorna null.

(Desde a versão 2.82)

reset() None Redefine o geocodificador. Este método, especificamente, chama o método GGeocodeCache.reset() no cache do cliente, caso um não esteja sendo usado por este serviço de geocódigos.

(Desde a versão 2.55)

classe GGeocodeCache

Esta classe mantém um mapa de endereços de localizações conhecidas. Embora esta classe seja totalmente funcional, ela é apropriada como classe de base da qual se derivam caches mais avançados.

Construtor

Construtor Descrição
GGeocodeCache() Cria um novo cache para armazenar um mapa de endereços das localizações. O construtor imediatamente chama o método GGeocodeCache.reset.

(Desde a versão 2.55)

Métodos

Método Valor de retorno Descrição
get(address:String) Object Retorna uma resposta que foi armazenada com o address especificado. Se nenhuma resposta tiver sido armazenada para o endereço especificado, este método retorna null.

(Desde a versão 2.55)

isCachable(reply:Object) Boolean Retorna se a resposta especificada deve ser armazenada em cache. Por padrão, são feitas verificações muito rudimentares no objeto reply. Esta classe, especificamente, garante que o objeto não seja null e que possua o campo name. Este método pode ser sobreposto com a extensão de classes, visando oferecer condições mais precisas no objeto reply.

(Desde a versão 2.55)

put(address:String, reply:Object) None Armazena a reply especificada no address especificado. Este método chama o método GGeocodeCache.isCachable para verificar se a reply pode ser armazenada em cache. Se obtiver uma resposta positiva, ele armazenará a reply em cache com o endereço normalizado com a ajuda do método GGeocodeCache.toCanoninical.

(Desde a versão 2.55)

reset() None Elimina todas as respostas do cache. Depois do retorno deste método, o cache fica vazio.

(Desde a versão 2.55)

toCanonical(address:String) String Retorna o que se considera uma versão canônica do endereço. Converte o parâmetro address para letras minúsculas, substitui vírgulas por espaços e substitui vários espaços por um espaço.

(Desde a versão 2.55)

classe GFactualGeocodeCache

Esta classe refina a classe básica GGeocodeCache ao estabelecer condições mais estritas nas respostas em cache. Ela armazena em cache somente as respostas que provavelmente não vão se alterar dentro de um curto período de tempo.

Construtor

Construtor Descrição
GFactualGeocodeCache() Cria um novo cache que armazena somente as respostas que considera factuais.

(Desde a versão 2.55)

Métodos

Método Valor de retorno Descrição
isCachable(reply:Object) Boolean Substitui a implementação padrão deste método para fazer uma verificação mais detalhada do código de status. Só é considerada para armazenamento em cache uma resposta com Status.code definido como G_GEO_SUCCESS ou reconhecida como inválida. Respostas que atingiram o tempo limite ou resultaram em erro geral de servidor não são armazenadas em cache.

(Desde a versão 2.55)

classe GMarkerManager

Esta classe é usada para gerenciar a visibilidade de centenas de marcadores em um mapa, com base na janela de visualização atual e o nível de zoom do mapa. Essa classe é obsoleta; recomenda-se que em vez dela os desenvolvedores usem a MarkerManager, de código aberto.

Construtor

Construtor Descrição
GMarkerManager(map:GMap, opts?:GMarkerManagerOptions) Cria um novo gerenciador de marcadores que controla a visibilidade dos marcadores do mapa especificado.

(Desde a versão 2.67)

Métodos

Método Valor de retorno Descrição
addMarkers(markers:GMarker[], minZoom:Number, maxZoom?:Number) None Adiciona um lote de marcadores a este gerenciador de marcadores. Os marcadores não são adicionados ao mapa até que o método refresh() seja chamado. Depois de colocados em um mapa, os marcadores são mostrados se recaírem na janela de visualização atual do mapa e o nível de zoom do mapa for maior ou igual ao minZoom especificado. Caso maxZoom tenha sido especificado, os marcadores são automaticamente removidos se o zoom do mapa for maior que o especificado.

(Desde a versão 2.67)

addMarker(marker:GMarker, minZoom:Number, maxZoom?:Number) None Adiciona um único marcador a uma coleção de marcadores controlados por este gerenciador. Se a localização do marcador recair dentro da janela de visualização atual do mapa e o nível de zoom do mapa estiver dentro do intervalo especificado, o marcador é imediatamente adicionado ao mapa. Do mesmo modo que o método addMarkers, os parâmetros minZoom e maxZoom, esse último opcional, especificam o intervalo de níveis de zoom em que o marcador é mostrado.

(Desde a versão 2.67)

refresh() None Força o gerenciador a atualizar os marcadores mostrados no mapa. Este método deve ser chamado se os marcadores tiverem sido adicionados através do método addMarkers.

(Desde a versão 2.67)

getMarkerCount(zoom:Number) Number Retorna o número total de marcadores potencialmente visíveis no nível de zoom especificado. Pode incluir os marcadores em níveis de zoom inferiores.

(Desde a versão 2.67)

Eventos

Evento Descrição
changed(bounds:GBounds, markerCount:Number) Este evento é disparado quando os marcadores controlados por um gerenciador tiverem sido removidos do mapa. A função de manipulação de evento deve ser preparada para aceitar dois argumentos. O primeiro é o retângulo que define os limites da grade visível. O segundo leva o número de marcadores atualmente mostrados no mapa.

classe GMarkerManagerOptions

Esta classe representa os argumentos opcionais para o construtor GMarkerManager. Essa classe não possui construtor, mas é instanciada como literal de objeto.

Propriedades

Propriedade Tipo Descrição
borderPadding Number Especifica, em pixels, o enchimento extra fora da janela de visualização atual do mapa monitorada por um gerenciador. Os marcadores que recaem dentro deste enchimento são adicionados ao mapa, mesmo que não sejam totalmente visíveis.

(Desde a versão 2.67)

maxZoom Number Define o nível máximo de zoom monitorado por um gerenciador de marcadores. Se não for especificado, o gerenciador assume o nível máximo de zoom do mapa. Este valor também é usado quando os marcadores são adicionados ao gerenciador sem o parâmetro maxZoom opcional.

(Desde a versão 2.67)

trackMarkers Boolean Indica se um gerenciador deve rastrear os movimentos dos marcadores. Se você quiser mover os marcadores gerenciados usando o método setPoint, esta opção deve ser definida como true. O valor padrão é false.

(Desde a versão 2.67)

classe GGeoXml

Um objeto GGeoXml adiciona conteúdo geográfico ao mapa a partir de um arquivo XML (como um arquivo KML) hospedado em um servidor web de acesso público. Ela implementa a interface GOverlay e, por isso, é adicionada ao mapa usando o método GMap2.addOverlay().

Construtor

Construtor Descrição
GGeoXml(urlOfXml:String, callback?:function) Cria uma GOverlay que representa esse arquivo XML. Uma função opcional de retorno de chamada é chamada quando o objeto GGeoXml termina de carregar o arquivo XML.

(Obsoleto desde a versão 2.108)

GGeoXml(urlOfXml:String) Cria uma GOverlay que representa esse arquivo XML.

(Desde a versão 2.108)

Métodos

Método Valor de retorno Descrição
getTileLayerOverlay() GTileLayerOverlay Os GGeoXml objetos podem criar uma sobreposição de bloco para fins de otimização em certos casos. Este método retorna esta sobreposição da camada de bloco (se disponível). A sobreposição de bloco pode ser null caso não seja necessária ou se o arquivo GGeoXml ainda não estiver totalmente carregado.

(Desde a versão 2.84)

getDefaultCenter() GLatLng Retorna o centro da janela de visualização padrão como lat/lng. Esta função só deve ser chamada depois que o arquivo estiver carregado.

(Desde a versão 2.84)

getDefaultSpan() GLatLng Retorna o intervalo da janela de visualização padrão como lat/lng. Esta função só deve ser chamada depois que o arquivo estiver carregado.

(Desde a versão 2.84)

getDefaultBounds() GLatLngBounds Retorna a caixa delimitadora da janela de visualização padrão. Esta função só deve ser chamada depois que o arquivo estiver carregado.

(Desde a versão 2.84)

gotoDefaultViewport(map:GMap2) None Define como a janela de visualização do mapa a janela de visualização padrão do arquivo XML.

(Desde a versão 2.84)

hasLoaded() Boolean Verifica se o arquivo XML foi totalmente carregado, caso em que retorna true. Se o arquivo XML não estiver totalmente carregado, este método retorna false.

(Desde a versão 2.84)

hide() None Oculta as sobreposições filhas criadas pelo objeto GGeoXml se a sobreposição estiver visível no momento e seu método supportsHide() retornar "true". Este método dispara o respectivo evento visibilitychanged para cada sobreposição filha que dispara este evento (por exemplo, GMarker.visibilitychanged, GGroundOverlay.visibilitychanged etc). Se nenhuma sobreposição que estiver visível no momento retornar supportsHide() como "true", este método não tem efeito.

(Desde a versão 2.87)

isHidden() Boolean Retorna true se o objeto GGeoXml estiver oculto no momento, conforme alterado pelo método GGeoXml.hide(). Caso contrário, retorna false.

(Desde a versão 2.87)

loadedCorrectly() Boolean Verifica se o arquivo XML foi carregado corretamente, caso em que retorna true. Se o arquivo XML não estiver carregado corretamente, este método retorna false. Se o arquivo XML não estiver totalmente carregado, o valor de retorno deste método é indefinido.

(Desde a versão 2.84)

show() None Mostra as sobreposições filhas criadas pelo objeto GGeoXml, caso estejam ocultas no momento. Este método dispara o respectivo evento visibilitychanged para cada sobreposição filha que dispara este evento (por exemplo, GMarker.visibilitychanged, GGroundOverlay.visibilitychanged).

(Desde a versão 2.87)

supportsHide() Boolean Sempre retorna true.

(Desde a versão 2.87)

Eventos

Evento Descrição
load() Este evento é disparado quando o arquivo XML do GGeoXml estiver totalmente carregado e todas as sobreposições associadas tiverem sido exibidas no mapa ou se o arquivo XML não tiver sido carregado corretamente.

(Desde a versão 2.108)

função GDownloadUrl

Esta função oferece uma maneira conveniente de recuperar de forma assíncrona um recurso identificado por um URL. Como o objeto XmlHttpRequest é usado para executar a solicitação, ele está sujeito à restrição de mesma origem no script entre sites, isto é, o URL deve referenciar o mesmo servidor que o URL do documento atual que executa esse código. Portanto, geralmente é redundante usar um URL absoluto para o argumento url. O melhor é usar somente um caminho absoluto ou relativo. É responsabilidade do chamador tratar quaisquer exceções que possam ocorrer, como erros de segurança.

Função

Método Valor de retorno Descrição
GDownloadUrl(url:String, onload:Function, postBody?:String, postContentType?:String) None Recupera a origem a partir do URL especificado e chama a função onload com o texto do documento como primeiro argumento e o código de status da resposta HTTP como o segundo. Se a solicitação chegar ao tempo limite, pode-se recorrer à função onload, chamada com o primeiro argumento definido como "null" e o segundo como -1. Esta função assume como padrão o envio de uma solicitação HTTP GET. Para enviar uma solicitação HTTP POST, passe dados através do argumento postBody opcional. Se os dados que estiverem sendo enviados não forem do tipo "application/x-www-form-urlencoded", passe o tipo de conteúdo como uma string no argumento postContentType. Este método está sujeito às restrições de script entre sites. Observe que ele usa a implementação XmlHttpRequest subjacente do navegador.

função GBrowserIsCompatible

Esta função decide se a API de mapas pode ser usada no navegador atual.

Função

Método Valor de retorno Descrição
GBrowserIsCompatible() Boolean Retorna true se o navegador atual aceitar a biblioteca da API de mapas.

função GUnload

Você pode chamar esta função para fazer com que a API de mapas limpe as estruturas internas de dados para liberar memória. Isso o ajuda a contornar várias falhas do navegador que causam vazamentos de memória nos aplicativos web. Você deverá chamar esta função no manipulador de evento unload da sua página. Depois que a função for chamada, os objetos de mapa que você criou nesta página perderão a funcionalidade.

Função

Método Valor de retorno Descrição
GUnload() None Destrói todos os manipuladores de evento registrados para evitar vazamentos de memória. Deverá ser chamado como um manipulador do evento unload.

classe GDirections

Esta classe é usada para obter resultados de rotas de tráfego e exibi-los em um mapa e/ou um painel de texto.

Construtor

Construtor Descrição
GDirections(map?:GMap2, panel?:Element) Cria uma nova instância de um objeto de rotas para solicitar e armazenar resultados de rotas. Com isso, o objeto de rotas pode criar rotas a partir de uma consulta usando o método GDirections.load().

O construtor usa um objeto de mapa opcional (para exibir uma polilinha das rotas calculadas) e/ou um elemento DIV de painel (para exibir resultados de instruções textuais de rotas).

Se for passado um argumento map, sempre que um novo resultado de rotas é calculado, a polilinha e os marcadores a ele associados são automaticamente adicionados como sobreposições no mapa. Da mesma forma, quando um argumento panel é passado, as instruções textuais de rotas associadas ao resultado são adicionadas ao DIV indicado, substituindo qualquer conteúdo existente no DIV.

Se algum desses argumentos for "null", os elementos associados não serão recuperados, exceto quando explicitamente solicitados pelo método GDirections.load(). (Consulte abaixo).

Além disso, o objeto contém três escutas de evento que você pode interceptar:

  • "load": Este evento é disparado quando os resultados de uma consulta de rotas obtidos via GDirections.load() estão disponíveis. O método load() inicia uma nova consulta que, por sua vez, dispara um evento "load" depois que a consulta é totalmente carregada. O evento "load" é disparado antes que quaisquer elementos de sobreposição sejam adicionados ao mapa/painel.
  • "addoverlay": Esse evento é disparado depois que componentes das instruções textuais de rotas e/ou de polilinhas forem adicionados ao mapa e/ou a elementos DIV. O evento "addoverlay" não é disparado se nenhum destes elementos estiver anexado a um objeto GDirections.
  • "error": Esse evento é disparado se uma solicitação de rotas resultar em erro. Os chamadores podem usar GDirections.getStatus() para saber mais sobre o erro. Quando ocorre um evento "error", nenhum evento "load" ou "addoverlay" é disparado.

(Desde a versão 2.81)

Métodos

Método Valor de retorno Descrição
load(query:String, queryOpts?:GDirectionsOptions) None Este método gera uma nova consulta de rotas. O parâmetro query é uma string contendo quaisquer consultas de rotas válidas, por exemplo, "de: Seattle para: São Francisco" ou "de: Toronto para: Ottawa para: Nova York". Por padrão, se um mapa tiver sido especificado durante a construção do objeto GDirections, a consulta solicitará um resultado na forma de polilinha. Da mesma forma, se um painel de texto tiver sido especificado, a consulta solicitará resultados na forma de texto minucioso. Caso contrário, o resultado conterá somente informações resumidas sobre as rotas encontradas.

Para substituir este comportamento (por exemplo, para solicitar informações de polígono mesmo quando não houver nenhum mapa anexado ao objeto), os chamadores podem usar o parâmetro opcional queryOpts. Consulte a documentação de GDirectionsOptions para obter detalhes.

Quando os resultados de rotas forem recebidos, este objeto limpa os resultados antigos, substituindo-os pelos novos e atualizando o mapa e/ou painel com novos resultados. Os resultados de rotas consistem em várias rotas (objetos do tipo GRoute), uma para cada par consecutivo de waypoint/endereço especificado na consulta. As rotas consistem em várias etapas (objetos do tipo GStep).

Se uma solicitação load() anterior não estiver concluída quando ocorrer uma nova chamada de load(), a solicitação anterior será cancelada. Com isso, você pode usar um único objeto GDirections para gerar solicitações de rotas em série. No entanto, para gerar várias solicitações paralelamente, é necessário usar diversos objetos GDirections.

(Desde a versão 2.81)

loadFromWaypoints(waypoints:Array, queryOpts?:GDirectionsOptions) None Gera uma nova consulta de rotas usando uma matriz de waypoints como entrada, em vez de uma única string de consulta. Essa matriz pode conter um máximo de 25 entradas de waypoint. Cada entrada na matriz é uma string que representa um endereço de entrada ou um ponto lat,lng. Consulte GDirections.load() para saber mais sobre o comportamento deste método.

(Desde a versão 2.81)

clear() None Limpa quaisquer resultados de rotas existentes, remove sobreposições do mapa e do painel e cancela quaisquer solicitações load() pendentes.

(Desde a versão 2.81)

getStatus() Object Retorna o status da solicitação de rotas. O objeto retornado tem a seguinte forma:
{
  code: 200
  request: "directions"
}
O código do status pode receber qualquer um dos valores definidos no GGeoStatusCode.

(Desde a versão 2.81)

getBounds() GLatLngBounds Este método é usado para obter a caixa delimitadora para o resultado desta consulta de rotas. Retorna um objeto GLatLngBounds ou "null" se não houver nenhum resultado satisfatório.

(Desde a versão 2.81)

getNumRoutes() Number Retorna o número de rotas disponíveis no resultado. Visando o êxito da consulta, esse deve ser o número total de waypoints de entrada menos 1. Quando não há nenhum resultado disponível (seja porque nenhuma consulta foi gerada ou porque ocorreu falha na consulta anterior), este método retorna 0.

(Desde a versão 2.81)

getRoute(i:Number) GRoute Retorna o objeto GRoute para a rota de ordem i (iésima) na resposta.

(Desde a versão 2.81)

getNumGeocodes() Number Retorna o número de entradas geocodificadas disponíveis no resultado. Para o êxito da consulta, deverá ser igual ao número total de waypoints de entrada. Quando não há nenhum resultado disponível (seja porque nenhuma consulta foi gerada ou porque ocorreu falha na consulta), este método retorna 0.

(Desde a versão 2.81)

getGeocode(i:Number) Object Retorna o resultado geocodificado para o waypoint. A estrutura deste objeto é idêntica à de um marcador único em uma resposta do objeto GClientGeocoder.

(Desde a versão 2.81)

getCopyrightsHtml() String Retorna uma string HTML contendo as informações de direitos autorais deste resultado.

(Desde a versão 2.81)

getSummaryHtml() String Retorna um snippet HTML contendo um resumo da distância e o tempo para toda esta solicitação de rotas. Este resumo é a única informação retornada para um objeto GDirections construído sem qualquer mapa ou elemento DIV associado.

(Desde a versão 2.81)

getDistance() Object Retorna um literal de objeto que representa a distância total da solicitação de rotas (por todas as rotas). O objeto contém dois campos: um número denominado "metros", que indica o valor numérico da distância (em metros), e uma string denominada "html", que contém uma representação localizada da string referente à distância, nas unidades predominantes no país de partida desse conjunto de rotas.

(Desde a versão 2.81)

getDuration() Object Retorna um literal de objeto que representa o tempo total da solicitação de rotas (por todas as rotas). O objeto contém dois campos: um número denominado "segundos", que indica o valor numérico do tempo (em segundos), e uma string denominada "html", que contém uma representação localizada da string referente ao tempo.

(Desde a versão 2.81)

getPolyline() GPolyline Retorna o objeto GPolyline associado à toda a resposta de rotas. Há uma polilinha única que representa todas as rotas na resposta. Este objeto somente será definido depois que os resultados de rotas estiverem carregados (isto é, o evento "load" tiver sido disparado).

(Desde a versão 2.81)

getMarker(i:Number) GMarker Retorna o marcador associado ao geocódigo iº. Este método retorna um valor não "null" somente depois que os resultados de rotas estiverem carregados (isto é, o evento "load" tiver sido disparado).

(Desde a versão 2.81)

classe GDirectionsOptions

Esta classe representa os argumentos opcionais para os métodos GDirections.load() e GDirections.loadFromWaypoints(). Essa classe não possui construtor, mas é instanciada como literal de objeto.

Propriedades

Propriedade Tipo Descrição
locale String Localidade a ser usada no resultado de rotas. Por exemplo, pt_BR", "fr", "fr_CA" etc.
travelMode GTravelModes O modo do trajeto, como dirigindo (padrão) ou andando.

(Desde a versão 2.129)

avoidHighways Boolean Se as rotas true tentarão excluir estradas ao calcular as rotas. Essas rotas ainda podem incluir estradas se não houver alternativas viáveis.

(Desde a versão 2.124)

getPolyline Boolean Por padrão, os métodos GDirections.load*() obtêm os dados de polilinha somente se um mapa estiver anexado ao objeto GDirections. Este campo pode ser usado para substituir este comportamento e recuperar os dados de polilinha, mesmo quando um mapa não está anexado ao objeto Directions.
getSteps Boolean Por padrão, os métodos GDirections.load*() obtêm os dados de etapas somente se um painel estiver anexado ao objeto GDirections. Este campo pode ser usado para substituir este comportamento e recuperar os dados de etapas, mesmo quando um painel não está anexado ao objeto Directions.
preserveViewport Boolean Por padrão, quando um objeto Directions possui um mapa, o mapa é centralizado e ajustado à caixa delimitadora do resultado de rotas. Quando esta opção é definida como true, a janela de visualização fica intocada para esta solicitação (exceto se nunca tiver sido definida como o primeiro lugar).

enum GTravelModes

Constantes

Constante Descrição
G_TRAVEL_MODE_WALKING A pé

(Desde a versão 2.129)

G_TRAVEL_MODE_DRIVING Dirigindo

(Desde a versão 2.129)

classe GRoute

Os objetos desta classe são criados pelo objeto GDirections para armazenas informações sobre uma única rota em um resultado de rotas. Esta classe não tem um construtor público. Os clientes não devem criar objetos diretamente desta classe.

Métodos

Método Valor de retorno Descrição
getNumSteps() Number Retorna o número de etapas nesta rota.

(Desde a versão 2.81)

getStep(i:Number) GStep Retorna o objeto GStep para a iª etapa nesta rota.

(Desde a versão 2.81)

getStartGeocode() Object Retorna o resultado de geocódigo referente ao ponto de partida desta rota. A estrutura deste objeto é idêntica à de um marcador único em uma resposta do objeto GClientGeocoder.

(Desde a versão 2.83)

getEndGeocode() Object Retorna o resultado de geocódigo referente ao ponto de chegada desta rota. A estrutura deste objeto é idêntica à de um marcador único em uma resposta do objeto GClientGeocoder.

(Desde a versão 2.83)

getEndLatLng() GLatLng Retorna um objeto GLatLng referente ao último ponto ao longo da polilinha desta rota. Este ponto pode ser diferente de lat,lng em GRoute.getEndGeocode(), pois getEndLatLng() sempre retorna um ponto capturado para a malha rodoviária. Não existe nenhum método getStartLatLng() correspondente, pois isso é idêntico à chamada de GRoute.getStep(0).getLatLng().

(Desde a versão 2.81)

getSummaryHtml() String Retorna um snippet HTML contendo um resumo da distância e o tempo desta rota.

(Desde a versão 2.81)

getDistance() Object Retorna um literal de objeto que representa a distância total desta rota. Consulte GDirections.getDistance() referente à estrutura deste objeto.

(Desde a versão 2.81)

getDuration() Object Retorna um literal de objeto que representa o tempo total desta rota. Consulte GDirections.getDuration() referente à estrutura deste objeto.

(Desde a versão 2.81)

classe GStep

Os objetos desta classe são criados pelo objeto GDirections para armazenas informações sobre uma única etapa de uma rota em um resultado de rota. Esta classe não tem um construtor público. Os clientes não devem criar objetos diretamente desta classe.

Métodos

Método Valor de retorno Descrição
getLatLng() GLatLng Retorna um objeto GLatLng referente ao primeiro ponto ao longo da polilinha desta etapa.

(Desde a versão 2.81)

getPolylineIndex() Number Retorna o índice do primeiro ponto ao longo da polilinha desta etapa.

(Desde a versão 2.81)

getDescriptionHtml() String Retorna uma string HTML contendo a descrição desta etapa.

(Desde a versão 2.81)

getDistance() Object Retorna um literal de objeto que representa a distância total desta etapa. Consulte GDirections.getDistance() referente à estrutura deste objeto.

(Desde a versão 2.81)

getDuration() Object Retorna um literal de objeto que representa o tempo total desta etapa. Consulte GDirections.getDuration() referente à estrutura deste objeto.

(Desde a versão 2.81)

classe GTrafficOverlay

Um objeto GTrafficOverlay adiciona uma sobreposição ao mapa que exibe informações de tráfego rodoviário. Ele implementa a interface GOverlay e, por isso, é adicionado ao mapa usando o método GMap2.addOverlay() e removido pelo método GMap2.removeOverlay(). O GTrafficOverlay somente exibe informações de tráfego das cidades disponíveis.

Construtor

Construtor Descrição
GTrafficOverlay(opts?:GTrafficOverlayOptions) Cria um novo objeto GTrafficOverlay que mostra informações de tráfego de rodovia.

(Desde a versão 2.81)

Métodos

Método Valor de retorno Descrição
hide() None Oculta a sobreposição de tráfego.

(Desde a versão 2.81)

show() None Mostra a sobreposição de tráfego.

(Desde a versão 2.81)

Eventos

Evento Descrição
changed(hasTrafficInView:Boolean) Este evento é disparado quando o estado dos dados de tráfego mudam na janela de visualização atual. Este evento pode ser disparado ao mover o mapa entre áreas com e sem dados de tráfego ou quando a inclusão de um GTrafficOverlay no mapa causa a exibição dos dados de tráfego dentro da janela de visualização atual. O parâmetro hasTrafficInView será true se a janela de visualização contiver dados de tráfego. Caso contrário, será false. O evento funciona independentemente da camada estar oculta ou em exibição.

(Desde a versão 2.85)

classe GTrafficOverlayOptions

Esta classe representa os argumentos opcionais para o construtor GTrafficOverlay. Essa classe não possui construtor, mas é instanciada como literal de objeto.

Propriedades

Propriedade Tipo Descrição
incidents Boolean Quando é true, indica que GTrafficOverlay deve exibir os incidentes de tráfego no mapa, quando aplicável. Por padrão, esse valor é definido como false.

(Desde a versão 2.121)

hide Boolean Quando é true, indica que o mapa não deve exibir inicialmente a GTrafficOverlay. Para ativar a sobreposição, chame GTrafficOverlay.show(). Por padrão, esse valor é definido como false.

(Desde a versão 2.121)

classe GAdsManager

Um objeto GAdsManager busca anúncios do AdSense e os exibe em um mapa especificado. Os anúncios aparecem como GMarkers e podem ser clicados para exibir o anúncio dentro da janela de informações do marcador. O GAdsManager seleciona anúncios do AdSense com base na janela de visualização atual e no contexto da página. Ao incluir um GAdsManager a um mapa, você também deverá ativá-lo especificamente usando o método enable().

Construtor

Construtor Descrição
GAdsManager(map:GMap2, publisherId:String, adsManagerOptions?:GAdsManagerOptions) Cria um novo objeto GAdsManager que solicita anúncios do AdSense aos servidores do Google. O parâmetro map identifica o mapa no qual este GAdsManager deverá exibir os anúncios. O parâmetro publisherId especifica a conta do desenvolvedor no AdSense. O parâmetro adsManagerOptions é um literal do objeto GAdsManagerOptions.

(Desde a versão 2.85)

Métodos

Método Valor de retorno Descrição
enable() None Ativa a busca de anúncios. Os anúncios não são buscados por padrão.

(Desde a versão 2.85)

disable() None Desativa a busca de anúncios.

(Desde a versão 2.85)

classe GAdsManagerOptions

Esta classe armazena argumentos opcionais para o construtor GAdsManager. Essa classe não possui construtor, mas é instanciada como literal de objeto.

Propriedades

Propriedade Tipo Descrição
maxAdsOnMap Number Número máximo de anúncios a mostrar no mapa a qualquer momento. O valor padrão é 3.

(Desde a versão 2.85)

channel Number O número do canal do AdSense usado para obter anúncios. Os canais são um recurso opcional que os editores do AdSense podem usar para rastrear a receita proveniente de anúncios de várias fontes.

(Desde a versão 2.85)

minZoomLevel Number Nível de zoom mínimo para mostrar anúncios. O valor padrão é 6.

(Desde a versão 2.85)

classe GStreetviewPanorama

Um objeto GStreetviewPanorama contém uma instância do visualizador Flash® Street View Panorama. Cada objeto desta classe pode conter uma instância individual, mostrando uma visualização exclusiva. Este objeto normalmente é incorporado a um objeto recipiente, como DIV, e pode ser manipulado para que sua visualização seja alterada por meio dos métodos desta classe. Os dados da Vista da rua não estão disponíveis para todas as localizações. Use o objeto GStreetviewClient ou o objeto GStreetviewOverlay para determinar se há dados da Vista da rua disponíveis para a sua localização.

Construtor

Construtor Descrição
GStreetviewPanorama(container:Node, opts?:GStreetviewPanoramaOptions) Cria um novo objeto GStreetviewPanorama com um visualizador flash correspondente no recipiente especificado. O visualizador não será exibido até que uma localização seja especificada, no objeto opcional GStreetviewPanoramaOptions opts ou pela chamada de setLocationAndPOV.

(Desde a versão 2.104)

Métodos

Método Valor de retorno Descrição
remove() None Remove a instância do visualizador flash atualmente associado a este objeto a partir do DOM. Esta função deve ser chamada antes da remoção do elemento recipiente HTML, ou alguns navegadores podem deixar de fazer a coleta de lixo no visualizador flash.

(Desde a versão 2.104)

setContainer(container:Node) None Define o elemento recipiente para o visualizador flash, movendo o visualizador de sua localização antiga, caso esteja aberto no momento.

(Desde a versão 2.104)

checkResize() None Notifica o visualizador flash de uma alteração de tamanho em seu recipiente. Chame este método depois que o tamanho do objeto DOM do recipiente for alterado, para que o visualizador possa se ajustar ao novo tamanho.

(Desde a versão 2.104)

hide() None Oculta o visualizador flash. Para remover o visualizador, recorra à chamada a .remove().

(Desde a versão 2.104)

show() None Mostra o visualizador flash.

(Desde a versão 2.104)

isHidden() boolean Retorna true se o visualizador flash associado a este objeto estiver oculto. Caso contrário, retorna false.

(Desde a versão 2.104)

getPOV() GPov Retorna o ponto de visão (POV) atual exibido no visualizador flash.

(Desde a versão 2.104)

setPOV(pov:GPov) None Altera o ponto de visão (POV) atual exibido no visualizador flash sem alterar a localização.

(Desde a versão 2.104)

panTo(pov:GPov, opt_longRoute:Boolean) None Altera o ponto de visão (POV) atual exibido no visualizador flash sem alterar a localização. Executa uma animação suave desde o POV atual até o novo POV. Se opt_longRoute estiver definido, a animação percorrerá uma rota extensa ao redor da esfera. Caso contrário, percorrerá a rota mais curta.

(Desde a versão 2.104)

setLocationAndPOV(latlng:GLatLng, opt_pov:GPov) None Define a localização e o POV do visualizador flash. Depois de chamar esta função, o visualizador exibirá a localização mais próxima ao latlng especificado, se disponível. Se não houver nenhum dado disponível para esta localização, o player flash permanecerá inalterado e emitirá um código de erro. Consulte GStreetviewClient.ReturnValues para conhecer os códigos de resposta possíveis.

(Desde a versão 2.104)

Eventos

Evento Descrição
yawchanged(yaw:Number) Este evento é disparado quando a guinada exibida no visualizador flash sofre mudança.

(Desde a versão 2.104)

pitchchanged(pitch:Number) Este evento é disparado quando a oscilação longitudinal exibida no visualizador flash sofre mudança.

(Desde a versão 2.104)

zoomchanged(zoom:Number) Este evento é disparado quando o nível de zoom do visualizador flash sofre mudança.

(Desde a versão 2.104)

error(errorCode:GStreetviewPanorama.ErrorValues) Este evento é disparado quando ocorre um erro. Consulte GStreetviewPanorama.ErrorValues para obter uma lista de tipos de erro.

(Desde a versão 2.104)

initialized(location:GStreetviewLocation) Este evento é disparado quando o panorama é inicializado depois de movido para uma nova localização. A localização é um objeto GStreetviewLocation. Observação: O evento initialized não é enviado na primeira vez que a visão panorâmica é renderizada. Este problema já é conhecido, e estamos trabalhando para corrigi-lo em uma versão futura.

(Desde a versão 2.104)

classe GStreetviewPanoramaOptions

Esta classe representa as opções passadas para o construtor GStreetviewPanorama. Por não possuir construtor, ela é instanciada na forma de literal de objeto. Todas as propriedades são opcionais.

Propriedades

Propriedade Tipo Descrição
latlng GLatLng latlng no qual abrir o visualizador flash.

(Desde a versão 2.104)

pov GPov Orientação de câmera na qual abrir o visualizador flash.

(Desde a versão 2.104)

classe GStreetviewOverlay

Um objeto GStreetviewOverlay é um conjunto de blocos que destaca as localizações para as quais há dados da Vista da rua disponíveis. Esta classe implementa a interface GOverlay e pode ser adicionada ao mapa usando map.addOverlay e removida usando map.removeOverlay.

Construtor

Construtor Descrição
GStreetviewOverlay() Cria uma nova GStreetviewOverlay que implementa a interface GOverlay.

(Desde a versão 2.104)

Eventos

Evento Descrição
changed(hasStreetviewData:Boolean) Este evento é disparado quando o estado dos dados da Vista da rua mudam na janela de visualização atual. É disparado ao mover o mapa de uma área com dados da Vista da rua para uma área sem esses dados e vice-versa. Também é disparado quando a adição de uma GStreetviewOverlay ao mapa resulta no aparecimento de dados da Vista da rua na janela de visualização. O parâmetro hasStreetviewData será true se a janela de visualização contiver dados da Vista da rua. Caso contrário, será false.

(Desde a versão 2.120)

classe GStreetviewClient

Um objeto GStreetviewClient procura dados da Vista da rua de acordo com os parâmetros passados a seus métodos.

Construtor

Construtor Descrição
GStreetviewClient() Cria um novo GStreetviewClient

(Desde a versão 2.104)

Métodos

Método Valor de retorno Descrição
getNearestPanoramaLatLng(latlng:GLatLng, callback:Function(GLatLng)) None Localiza o GLatLng do panorama mais próximo a um ponto especificado e passa essa informação para o retorno. Se não houver panoramas ou se ocorrer um erro do servidor, o retorno especificado é passado como "null".

(Desde a versão 2.104)

getNearestPanorama(latlng:GLatLng, callback:Function(GStreetviewData)) None Recupera os dados da visão panorâmica mais próxima de uma latlng e passa-os para o retorno de chamada especificado como objeto GStreetviewData.

(Desde a versão 2.104)

getPanoramaById(panoId:string, callback:Function(GStreetviewData)) None Recupera os dados do ID de panorama especificado e passa-os para o retorno especificado como objeto GStreetviewData. Os ID são exclusivos a cada panorama e estáveis durante a vida útil de uma sessão, mas are são passíveis de alteração entre sessões.

(Desde a versão 2.104)

enum GStreetviewClient.ReturnValues

Os equivalentes numéricos de cada constante simbólica são especificados entre parênteses.

Constantes

Constante Descrição
SUCCESS
= 200
Êxito

(Desde a versão 2.104)

SERVER_ERROR
= 500
O servidor não está respondendo às consultas.

(Desde a versão 2.104)

NO_NEARBY_PANO
= 600
Nenhum dado de panorama foi encontrado.

(Desde a versão 2.104)

classe GStreetviewData

Esta classe representa os dados associados a um panorama. Essa classe não possui construtor, mas é instanciada como literal de objeto.

Propriedades

Propriedade Tipo Descrição
location GStreetviewLocation Dados da localização.

(Desde a versão 2.104)

copyright String Uma atribuição de direitos autorais localizados.

(Desde a versão 2.104)

code GStreetviewClient.ReturnValues Código de status. Consulte GStreetviewClient.ReturnValues.

(Desde a versão 2.104)

classe GStreetviewLocation

Esta classe representa uma localização na visualização de ruas. Essa classe não possui construtor, mas é instanciada como literal de objeto.

Propriedades

Propriedade Tipo Descrição
latlng GLatLng A latlng da visão panorâmica.

(Desde a versão 2.104)

pov GPov Ponto de visão inicial.

(Desde a versão 2.104)

description String String localizada que descreve a localização.

(Desde a versão 2.104)

panoId String Identificador exclusivo do panorama. Ele fica estável durante uma sessão, mas instável entre sessões.

(Desde a versão 2.104)

Esta classe representa um vínculo de uma GStreetviewLocation com uma GStreetviewLocation adjacente. Essa classe não possui construtor, mas é instanciada como literal de objeto.

Propriedades

Propriedade Tipo Descrição
yaw Number Guinada da localização atual para a localização adjacente.

(Desde a versão 2.104)

description String String localizada que descreve a localização adjacente.

(Desde a versão 2.104)

panoId String Identificador exclusivo do panorama adjacente. Ele fica estável durante uma sessão, mas instável entre sessões.

(Desde a versão 2.104)

classe GPov

Esta classe representa a estrutura de um ponto de visão da câmera usado pela visualização de ruas. Essa classe não possui construtor, mas é instanciada como literal de objeto. Todas as propriedades são opcionais.

Propriedades

Propriedade Tipo Descrição
yaw Number Guinada da câmera em graus, em relação ao norte real. O norte real equivale a 0 grau, o leste equivale a 90 graus, o sul equivale a 180 graus, o oeste equivale a 270 graus.

(Desde a versão 2.104)

pitch Number Oscilação longitudinal da câmera em graus, em relação ao instrumento da visualização de ruas. Varia de 90 graus (direto para cima) a -90 graus (direto para baixo).

(Desde a versão 2.104)

zoom Number Nível de zoom. O aumento total de zoom equivale ao nível 0, a diminuição de zoom aumenta o nível de zoom.

(Desde a versão 2.104)

enum GStreetviewPanorama.ErrorValues

Os equivalentes numéricos de cada constante simbólica são especificados entre parênteses.

Constantes

Constante Descrição
NO_NEARBY_PANO
= 600
Nenhum dado de panorama foi encontrado.

(Desde a versão 2.104)

FLASH_UNAVAILABLE
= 603
O visualizador flash não estava disponível, provavelmente porque o navegador do usuário não aceita flash.

(Desde a versão 2.104)