Marker (legacy)

Classe Marker

Classe google.maps.Marker

Descontinuado:desde 21 de fevereiro de 2024, o google.maps.Marker foi descontinuado. Use AdvancedMarkerElement. No momento, o google.maps.Marker não está programado para ser descontinuado, mas o AdvancedMarkerElement é recomendado em vez do google.maps.Marker. O google.maps.Marker vai continuar recebendo correções de bugs para qualquer regressão importante, mas os bugs atuais no google.maps.Marker não serão corrigidos. Haverá um aviso prévio de pelo menos 12 meses antes que o suporte seja descontinuado. Acesse https://developers.google.com/maps/deprecations para mais detalhes e https://developers.google.com/maps/documentation/javascript/advanced-markers/migration para acessar o guia de migração.

Essa classe estende MVCObject.

Acesse chamando const {Marker} = await google.maps.importLibrary("marker"). Consulte Bibliotecas na API Maps JavaScript.

Construtor
Marker	Marker([opts]) Parâmetros: opts:  MarkerOptions optional Argumentos opcionais nomeados Cria um marcador com as opções especificadas. Se um mapa for especificado, o marcador será adicionado ao mapa na construção. A posição precisa ser definida para o marcador ser exibido.

Constantes
MAX_ZINDEX	O índice z padrão máximo que a API designará a um marcador. Você pode definir um índice z mais alto para trazer o marcador para a frente.

Métodos
getAnimation	getAnimation() Parâmetros:nenhum Valor de retorno:Animation|null|undefined Receba a animação em execução no momento.
getClickable	getClickable() Parâmetros:nenhum Valor de retorno:boolean Verdadeiro se o marcador for clicável. Conferir o status clicável do Marker.
getCursor	getCursor() Parâmetros:nenhum Valor de retorno:string|null|undefined Recebe o tipo de cursor do mouse mostrado ao passar o cursor.
getDraggable	getDraggable() Parâmetros:nenhum Valor de retorno:boolean Verdadeiro se o marcador puder ser arrastado. Receba o status de arrastável do Marker.
getIcon	getIcon() Parâmetros:nenhum Valor de retorno:string|Icon|Symbol|null|undefined Receba o ícone do Marker. Consulte os MarkerOptions.icon.
getLabel	getLabel() Parâmetros:nenhum Valor de retorno:MarkerLabel|string|null|undefined Receba o rótulo do Marker. Consulte os MarkerOptions.label.
getMap	getMap() Parâmetros:nenhum Valor de retorno:Map|StreetViewPanorama Recebe o mapa ou panorama em que o Marker é renderizado.
getOpacity	getOpacity() Parâmetros:nenhum Valor de retorno:number|null|undefined um número entre 0,0 e 1,0. Receba a opacidade do Marker.
getPosition	getPosition() Parâmetros:nenhum Valor de retorno:LatLng|null|undefined Receba a posição do Marker.
getShape	getShape() Parâmetros:nenhum Valor de retorno:MarkerShape|null|undefined Receba a forma do Marker usado para interação. Consulte MarkerOptions.shape e MarkerShape.
getTitle	getTitle() Parâmetros:nenhum Valor de retorno:string|null|undefined Receba o título da dica Marker. Consulte os MarkerOptions.title.
getVisible	getVisible() Parâmetros:nenhum Valor de retorno:boolean Verdadeiro se o marcador estiver visível. Receba a visibilidade do Marker.
getZIndex	getZIndex() Parâmetros:nenhum Valor de retorno:number|null|undefined zIndex do marcador. Receba o zIndex do Marker. Consulte os MarkerOptions.zIndex.
setAnimation	setAnimation([animation]) Parâmetros: animation:  Animation optional A animação a ser reproduzida. Valor de retorno:nenhum Inicia uma animação. Qualquer animação em andamento será cancelada. As animações compatíveis no momento são: Animation.BOUNCE, Animation.DROP. A transmissão de null faz com que qualquer animação seja interrompida.
setClickable	setClickable(flag) Parâmetros: flag:  boolean Se true, o marcador pode ser clicado. Valor de retorno:nenhum Defina se o Marker é clicável.
setCursor	setCursor([cursor]) Parâmetros: cursor:  string optional Tipo de cursor do mouse. Valor de retorno:nenhum Define o tipo de cursor do mouse mostrado ao passar o cursor.
setDraggable	setDraggable(flag) Parâmetros: flag:  boolean optional Se true, o marcador pode ser arrastado. Valor de retorno:nenhum Define se o Marker é arrastável.
setIcon	setIcon([icon]) Parâmetros: icon:  string|Icon|Symbol optional Valor de retorno:nenhum Defina o ícone para o Marker. Consulte os MarkerOptions.icon.
setLabel	setLabel([label]) Parâmetros: label:  string|MarkerLabel optional O rótulo pode ser uma string de caracteres ou um objeto MarkerLabel. Valor de retorno:nenhum Defina o rótulo para o Marker. Consulte os MarkerOptions.label.
setMap	setMap(map) Parâmetros: map:  Map|StreetViewPanorama Valor de retorno:nenhum Renderiza o Marker no mapa ou panorama especificado. Se o mapa for definido como null, o marcador será removido.
setOpacity	setOpacity([opacity]) Parâmetros: opacity:  number optional Um número entre 0,0, transparente, e 1,0, opaco. Valor de retorno:nenhum Defina a opacidade do Marker.
setOptions	setOptions(options) Parâmetros: options:  MarkerOptions Valor de retorno:nenhum Defina as opções para o Marker.
setPosition	setPosition([latlng]) Parâmetros: latlng:  LatLng|LatLngLiteral optional A nova posição. Valor de retorno:nenhum Defina a posição do Marker.
setShape	setShape([shape]) Parâmetros: shape:  MarkerShape optional Valor de retorno:nenhum Defina a forma do Marker usado para interação. Consulte MarkerOptions.shape e MarkerShape.
setTitle	setTitle([title]) Parâmetros: title:  string optional Valor de retorno:nenhum Defina o título da dica Marker. Consulte os MarkerOptions.title.
setVisible	setVisible(visible) Parâmetros: visible:  boolean Se true, o marcador fica visível. Valor de retorno:nenhum Define se o Marker está visível.
setZIndex	setZIndex([zIndex]) Parâmetros: zIndex:  number optional Valor de retorno:nenhum Defina o zIndex do Marker. Consulte os MarkerOptions.zIndex.
Herdado: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll

Eventos
animation_changed	function() Argumentos:  nenhum Esse evento é acionado quando a propriedade de animação Marker muda.
click	function(event) Argumentos:  event:  MapMouseEvent Esse evento é acionado quando o ícone Marker é clicado.
clickable_changed	function() Argumentos:  nenhum Esse evento é disparado quando a propriedade clicável Marker muda.
contextmenu	function(event) Argumentos:  event:  MapMouseEvent Esse evento é acionado quando o evento contextmenu do DOM é acionado no Marker
cursor_changed	function() Argumentos:  nenhum Esse evento é acionado quando a propriedade do cursor Marker muda.
dblclick	function(event) Argumentos:  event:  MapMouseEvent Esse evento é acionado quando o ícone Marker é clicado duas vezes.
drag	function(event) Argumentos:  event:  MapMouseEvent Esse evento é acionado repetidamente enquanto o usuário arrasta o Marker.
dragend	function(event) Argumentos:  event:  MapMouseEvent Esse evento é acionado quando o usuário para de arrastar o Marker.
draggable_changed	function() Argumentos:  nenhum Esse evento é disparado quando a propriedade arrastável Marker muda.
dragstart	function(event) Argumentos:  event:  MapMouseEvent Esse evento é acionado quando o usuário começa a arrastar o Marker.
flat_changed	function() Argumentos:  nenhum Esse evento é disparado quando a propriedade plana Marker muda.
icon_changed	function() Argumentos:  nenhum Esse evento é acionado quando a propriedade do ícone Marker muda.
mousedown	function(event) Argumentos:  event:  MapMouseEvent Esse evento é acionado para um mousedown no Marker.
mouseout	function(event) Argumentos:  event:  MapMouseEvent Esse evento é acionado quando o mouse sai da área do ícone Marker.
mouseover	function(event) Argumentos:  event:  MapMouseEvent Esse evento é acionado quando o mouse entra na área do ícone Marker.
mouseup	function(event) Argumentos:  event:  MapMouseEvent Esse evento é acionado para um mouseup no Marker.
position_changed	function() Argumentos:  nenhum Esse evento é acionado quando a propriedade de posição Marker muda.
shape_changed	function() Argumentos:  nenhum Esse evento é disparado quando a propriedade de forma Marker muda.
title_changed	function() Argumentos:  nenhum Esse evento é acionado quando a propriedade de título Marker muda.
visible_changed	function() Argumentos:  nenhum Esse evento é disparado quando a propriedade Marker visível muda.
zindex_changed	function() Argumentos:  nenhum Esse evento é acionado quando a propriedade zIndex de Marker muda.
rightclick	Descontinuado:use o evento Marker.contextmenu para oferecer suporte a padrões de uso, como clicar com o botão direito do mouse no macOS. function(event) Argumentos:  event:  MapMouseEvent Esse evento é acionado para um clique com o botão direito do mouse no Marker.

Interface MarkerOptions

Interface google.maps.MarkerOptions

Descontinuado:desde 21 de fevereiro de 2024, o google.maps.Marker foi descontinuado. No lugar, use google.maps.marker.AdvancedMarkerElement. Acesse https://developers.google.com/maps/deprecations para mais detalhes sobre a descontinuação e https://developers.google.com/maps/documentation/javascript/advanced-markers/migration para conferir o guia de migração.

Objeto MarkerOptions usado para definir as propriedades que podem ser definidas em um marcador.

Propriedades
anchorPoint optional	Tipo:Point optional O deslocamento da posição do marcador até a ponta de uma InfoWindow aberta com o marcador como âncora.
animation optional	Tipo:Animation optional Padrão:null Qual animação deve ser reproduzida quando o marcador for adicionado a um mapa.
clickable optional	Tipo:boolean optional Padrão:true Se true, o marcador recebe eventos de mouse e de toque.
collisionBehavior optional	Descontinuado:o collisionBehavior foi descontinuado em julho de 2023. Em vez dela, use AdvancedMarkerElement.collisionBehavior. Aviso:disponível apenas no canal v=beta. Tipo:string|CollisionBehavior optional Padrão:null Defina um comportamento em caso de conflito para marcadores em mapas vetoriais.
crossOnDrag optional	Tipo:boolean optional Padrão:true Se false, desativa a cruz que aparece abaixo do marcador ao arrastar.
cursor optional	Tipo:string optional Padrão:pointer Tipo de cursor do mouse que aparece ao passar o cursor.
draggable optional	Tipo:boolean optional Padrão:false Se true, o marcador poderá ser arrastado.
icon optional	Tipo:string|Icon|Symbol optional Ícone do primeiro plano. Se uma string for fornecida, ela será tratada como se fosse um Icon com a string como url.
label optional	Tipo:string|MarkerLabel optional Padrão:null Adiciona um rótulo ao marcador. Um rótulo de marcador é um número ou uma letra que aparece dentro de um marcador. O rótulo pode ser uma string ou um objeto MarkerLabel. Se o elemento for fornecido e MarkerOptions.title não for, um texto de acessibilidade (por exemplo, para uso com leitores de tela) será adicionado ao marcador com o texto do rótulo fornecido. No momento, o label é usado apenas para texto de acessibilidade em marcadores não otimizados.
map optional	Tipo:Map|StreetViewPanorama optional Mapa no qual exibir o marcador. O mapa é necessário para mostrar o marcador e pode ser fornecido com Marker.setMap se não for fornecido na construção do marcador.
opacity optional	Tipo:number optional Padrão: 1,0 Um número entre 0,0, transparente, e 1,0, opaco.
optimized optional	Tipo:boolean optional A otimização melhora a performance ao renderizar muitos marcadores como um único elemento estático. Isso é útil quando muitos marcadores são necessários. Saiba mais sobre a otimização de marcadores.
position optional	Tipo:LatLng|LatLngLiteral optional Define a posição do marcador. Um marcador pode ser criado, mas não será exibido até que a posição dele seja informada, por exemplo, por ações ou escolhas do usuário. Uma posição de marcador pode ser fornecida com Marker.setPosition se não for fornecida na construção do marcador.
shape optional	Tipo:MarkerShape optional Definição da região no mapa de imagem usada para os eventos de arrastar/clicar.
title optional	Tipo:string optional Padrão:undefined texto da sobreposição. Se fornecido, um texto de acessibilidade (por exemplo, para uso com leitores de tela) será adicionado ao marcador com o valor fornecido. No momento, o title é usado apenas para texto de acessibilidade em marcadores não otimizados.
visible optional	Tipo:boolean optional Padrão:true Se for true, o marcador vai ficar visível.
zIndex optional	Tipo:number optional Todos os marcadores são exibidos no mapa na ordem de seus zIndex, com os valores maiores exibidos na frente dos marcadores com valores menores. Por padrão, os marcadores são exibidos de acordo com sua posição vertical na tela, com marcadores inferiores sendo exibidos na frente de marcadores posicionados acima na tela.

Constantes CollisionBehavior

Constantes google.maps.CollisionBehavior

Acesse chamando const {CollisionBehavior} = await google.maps.importLibrary("marker"). Consulte Bibliotecas na API Maps JavaScript.

Constantes
OPTIONAL_AND_HIDES_LOWER_PRIORITY	Mostre o marcador somente se ele não se sobrepor a outros marcadores. Em caso de conflito, o marcador com o z-index mais alto vai aparecer. Se eles tiverem o mesmo z-index, aquele com a posição vertical mais baixa na tela será mostrado.
REQUIRED	Sempre mostrar o marcador, independentemente do conflito. Esse é o comportamento padrão.
REQUIRED_AND_HIDES_OPTIONAL	Sempre mostrar o marcador, independentemente do conflito, e ocultar todos os marcadores ou rótulos OPTIONAL_AND_HIDES_LOWER_PRIORITY que se sobrepuserem a ele.

Interface Icon

Interface google.maps.Icon

Uma estrutura que representa uma imagem de ícone de marcador.

Propriedades
url	Tipo:string O URL da planilha de imagem ou sprite.
anchor optional	Tipo:Point optional A posição em que uma imagem é ancorada em correspondência com o local do marcador no mapa. Por padrão, a âncora está localizada ao longo do ponto central da parte inferior da imagem.
labelOrigin optional	Tipo:Point optional A origem do rótulo em relação ao canto superior esquerdo da imagem do ícone, se um rótulo for fornecido pelo marcador. Por padrão, a origem está localizada no ponto central da imagem.
origin optional	Tipo:Point optional A posição da imagem em um sprite, se houver. Por padrão, a origem fica no canto superior esquerdo da imagem (0, 0).
scaledSize optional	Tipo:Size optional O tamanho da imagem inteira após o dimensionamento, se houver. Use esta propriedade para aumentar/reduzir uma imagem ou um sprite.
size optional	Tipo:Size optional O tamanho de exibição da imagem ou do sprite. Quando você usa sprites, deve especificar o tamanho do sprite. Se o tamanho não for fornecido, ele será definido quando a imagem for carregada.

Interface MarkerLabel

Interface google.maps.MarkerLabel

Essas opções especificam a aparência de um marcador. Um rótulo de marcador é uma string (geralmente um único caractere) que aparece dentro do marcador. Se você estiver usando com um marcador personalizado, poderá reposicionar com a propriedade labelOrigin na classe Icon.

Propriedades
text	Tipo:string O texto que será exibido no rótulo.
className optional	Tipo:string optional Padrão:'' (string vazia) A propriedade "className" do elemento do rótulo (equivalente ao atributo de classe do elemento). É possível adicionar várias classes CSS separadas por espaços. A cor, o tamanho, o peso e a família da fonte só podem ser definidos pelas outras propriedades de MarkerLabel. As classes CSS não devem ser usadas para mudar a posição nem a orientação do rótulo (por exemplo, usando traduções e rotações) se você também estiver usando o gerenciamento de colisão de marcadores.
color optional	Tipo:string optional Padrão:'black' A cor do texto do rótulo.
fontFamily optional	Tipo:string optional A família de fontes do texto do rótulo (equivalente à propriedade font-family do CSS).
fontSize optional	Tipo:string optional Padrão:'14px' O tamanho da fonte do texto do marcador (equivalente à propriedade font-size do CSS).
fontWeight optional	Tipo:string optional O peso da fonte do texto do rótulo (equivalente à propriedade font-weight do CSS).

Interface MarkerShape

Interface google.maps.MarkerShape

Esse objeto define a região clicável de uma imagem de marcador. A forma consiste em duas propriedades, type e coord, que definem a região não transparente de uma imagem.

Propriedades
coords	Tipo:Array<number> O formato desse atributo depende do valor de type e segue a especificação coords de AREA do w3, disponível em http://www.w3.org/TR/REC-html40/struct/objects.html#adef-coords. O atributo coords é uma matriz de números inteiros que especifica a posição do pixel da forma em relação ao canto superior esquerdo da imagem de destino. As coordenadas dependem do valor de type da seguinte maneira:   - circle: coords é [x1,y1,r],em que x1, y2 são as coordenadas do centro do círculo e r é o raio do círculo.   - poly: coords é [x1,y1,x2,y2...xn,yn], em que cada par x,y contém as coordenadas de um vértice do polígono.   - rect: coords é [x1,y1,x2,y2], em que x1,y1 são as coordenadas do canto superior esquerdo do retângulo e x2,y2 são as coordenadas do canto inferior direito do retângulo.
type	Tipo:string Descreve o tipo da forma e pode ser circle, poly ou rect.

Interface do símbolo

Interface google.maps.Symbol

Descreve um símbolo, que consiste em um caminho vetorial com estilo. Um símbolo pode ser usado como ícone de um marcador ou colocado em uma polilinha.

Propriedades
path	Tipo:SymbolPath|string O caminho do símbolo, que é um caminho de símbolo integrado ou um caminho personalizado expresso usando a notação de caminho SVG. Obrigatório.
anchor optional	Tipo:Point optional Padrão:google.maps.Point(0,0) A posição do símbolo em relação ao marcador ou à polilinha. As coordenadas do caminho do símbolo são convertidas para a esquerda e para cima pelas coordenadas x e y da âncora, respectivamente. A posição é expressa no mesmo sistema de coordenadas que o caminho do símbolo.
fillColor optional	Tipo:string optional A cor de preenchimento do símbolo. Todas as cores CSS3 são permitidas, exceto cores nomeadas estendidas. Para marcadores de símbolo, o padrão é "preto". Para símbolos em polilinhas, o padrão é a cor do traço da polilinha correspondente.
fillOpacity optional	Tipo:number optional Padrão:0 A opacidade de preenchimento do símbolo.
labelOrigin optional	Tipo:Point optional Padrão:google.maps.Point(0,0) A origem do rótulo em relação à origem do caminho, se o rótulo for fornecido pelo marcador. A origem é expressa no mesmo sistema de coordenadas que o caminho do símbolo. Essa propriedade não é usada para símbolos em polilinhas.
rotation optional	Tipo:number optional Padrão:0 O ângulo pelo qual o símbolo deve ser girado, expresso em graus no sentido horário. Um símbolo em um IconSequence em que fixedRotation é false é girado em relação ao ângulo da borda em que está posicionado.
scale optional	Tipo:number optional O valor da escala do símbolo em tamanho. Para marcadores de símbolo, o padrão é 1. Após o dimensionamento, o símbolo pode ter qualquer tamanho. Para símbolos em uma polilinha, o padrão é a espessura do traço da polilinha. Depois da escala, o símbolo precisa ficar dentro de um quadrado de 22 pixels centralizado na âncora do símbolo.
strokeColor optional	Tipo:string optional A cor do traço do símbolo. Todas as cores CSS3 são permitidas, exceto cores nomeadas estendidas. Para marcadores de símbolo, o padrão é "preto". Para símbolos em uma polilinha, o padrão é a cor do traço da polilinha.
strokeOpacity optional	Tipo:number optional A opacidade do traço do símbolo. Para marcadores de símbolo, o padrão é 1. Para símbolos em uma polilinha, o padrão é a opacidade do traço da polilinha.
strokeWeight optional	Tipo:number optional Padrão:o Symbol.scale do símbolo. A espessura do traço do símbolo.

Constantes do SymbolPath

Constantes google.maps.SymbolPath

Caminhos de símbolo integrados.

Acesse chamando const {SymbolPath} = await google.maps.importLibrary("core"). Consulte Bibliotecas na API Maps JavaScript.

Constantes
BACKWARD_CLOSED_ARROW	Uma seta fechada apontando para trás.
BACKWARD_OPEN_ARROW	Uma seta aberta apontando para trás.
CIRCLE	Um círculo.
FORWARD_CLOSED_ARROW	Uma seta fechada apontando para a frente.
FORWARD_OPEN_ARROW	Uma seta aberta apontando para a frente.

Constantes de animação

Constantes google.maps.Animation

Animações que podem ser executadas em um marcador. Use o método Marker.setAnimation no marcador ou a opção MarkerOptions.animation para reproduzir uma animação.

Acesse chamando const {Animation} = await google.maps.importLibrary("marker"). Consulte Bibliotecas na API Maps JavaScript.

Constantes
BOUNCE	O marcador é acionado até que a animação seja interrompida chamando Marker.setAnimation com null.
DROP	O marcador cai da parte de cima do mapa até o local final. A animação termina quando o marcador para de se mover, e Marker.getAnimation volta a ser null. Esse tipo de animação geralmente é especificado durante a criação do marcador.