Classe Marker
Classe
google.maps.Marker
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:
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 Exibe a animação em execução no momento. |
getClickable |
getClickable() Parâmetros: nenhum
Return Value:
boolean "True", se o Marker for clicável.Confira o status clicável da Marker . |
getCursor |
getCursor() Parâmetros: nenhum
Valor de retorno:
string|null|undefined Obter o tipo de cursor do mouse exibido ao passar o cursor. |
getDraggable |
getDraggable() Parâmetros: nenhum
Valor de retorno:
boolean "True" se o marcador for arrastável.Recebe o status arrastável do Marker . |
getIcon |
getIcon() Parâmetros: nenhum
Encontre o ícone do Marker . Consulte os MarkerOptions.icon . |
getLabel |
getLabel() Parâmetros: nenhum
Valor de retorno:
MarkerLabel|string|null|undefined Receba o rótulo de Marker . Consulte os MarkerOptions.label . |
getMap |
getMap() Parâmetros: nenhum
Valor de retorno:
Map|StreetViewPanorama Confira o mapa ou o Panaroama em que o Marker foi renderizado. |
getOpacity |
getOpacity() Parâmetros: nenhum
Valor de retorno:
number|null|undefined um número entre 0,0 e 1,0.Acessa a opacidade da Marker . |
getPosition |
getPosition() Parâmetros: nenhum
Valor de retorno:
LatLng|null|undefined Confira a posição do Marker . |
getShape |
getShape() Parâmetros: nenhum
Valor de retorno:
MarkerShape|null|undefined |
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 "True" se o marcador estiver visível.Consiga a visibilidade da Marker . |
getZIndex |
getZIndex() Parâmetros: nenhum
Valor de retorno:
number|null|undefined zIndex do marcador.Acessa o zIndex do Marker . Consulte os MarkerOptions.zIndex . |
setAnimation |
setAnimation([animation]) Parâmetros:
Valor de retorno: nenhum
Inicia uma animação. Qualquer animação em andamento será cancelada. As animações com suporte no momento são: Animation.BOUNCE e Animation.DROP . Transmitir null fará com que todas as animações sejam interrompidas. |
setClickable |
setClickable(flag) Parâmetros:
Valor de retorno: nenhum
Defina se Marker for clicável. |
setCursor |
setCursor([cursor]) Parâmetros:
Valor de retorno: nenhum
Defina o tipo de cursor do mouse mostrado ao passar o cursor. |
setDraggable |
setDraggable(flag) Parâmetros:
Valor de retorno: nenhum
Defina se o Marker é arrastável. |
setIcon |
setIcon([icon]) Valor de retorno: nenhum
Defina o ícone do Marker . Consulte os MarkerOptions.icon . |
setLabel |
setLabel([label]) Parâmetros:
Valor de retorno: nenhum
Defina o rótulo da Marker . Consulte os MarkerOptions.label . |
setMap |
setMap(map) Parâmetros:
Valor de retorno: nenhum
Renderiza Marker no mapa ou panorama especificado. Se o mapa estiver definido como null , o marcador será removido. |
setOpacity |
setOpacity([opacity]) Parâmetros:
Valor de retorno: nenhum
Defina a opacidade da Marker . |
setOptions |
setOptions(options) Parâmetros:
Valor de retorno: nenhum
Defina as opções do Marker . |
setPosition |
setPosition([latlng]) Parâmetros:
Valor de retorno: nenhum
Defina a posição do Marker . |
setShape |
setShape([shape]) Parâmetros:
Valor de retorno: nenhum
|
setTitle |
setTitle([title]) Parâmetros:
Valor de retorno: nenhum
Defina o título da dica Marker . Consulte os MarkerOptions.title . |
setVisible |
setVisible(visible) Parâmetros:
Valor de retorno: nenhum
Defina se a Marker estiver visível. |
setZIndex |
setZIndex([zIndex]) Parâmetros:
Valor de retorno: nenhum
Define o zIndex do Marker . Consulte os MarkerOptions.zIndex . |
Herdado:
addListener ,
bindTo ,
get ,
notify ,
set ,
setValues ,
unbind ,
unbindAll
|
Eventos | |
---|---|
animation_changed |
function() Argumentos: nenhum
Este evento é disparado quando a propriedade de animação Marker é alterada. |
click |
function(event) Argumentos:
Este evento é disparado quando o ícone Marker é clicado. |
clickable_changed |
function() Argumentos: nenhum
Este evento é disparado quando a propriedade clicável Marker é alterada. |
contextmenu |
function(event) Argumentos:
Este evento é disparado quando o evento contextmenu do DOM é disparado na Marker |
cursor_changed |
function() Argumentos: nenhum
Este evento é disparado quando a propriedade de cursor Marker é alterada. |
dblclick |
function(event) Argumentos:
Este evento é disparado quando o ícone Marker recebe um clique duplo. |
drag |
function(event) Argumentos:
Este evento é disparado repetidamente enquanto o usuário arrasta Marker . |
dragend |
function(event) Argumentos:
Este evento é disparado quando o usuário para de arrastar Marker . |
draggable_changed |
function() Argumentos: nenhum
Este evento é disparado quando a propriedade arrastável Marker é alterada. |
dragstart |
function(event) Argumentos:
Este evento é disparado quando o usuário começa a arrastar a Marker . |
flat_changed |
function() Argumentos: nenhum
Este evento é disparado quando a propriedade simples Marker é alterada. |
icon_changed |
function() Argumentos: nenhum
Este evento é disparado quando a propriedade do ícone Marker é alterada. |
mousedown |
function(event) Argumentos:
Este evento é disparado para um mousedown na Marker . |
mouseout |
function(event) Argumentos:
Este evento é disparado quando o mouse sai da área do ícone Marker . |
mouseover |
function(event) Argumentos:
Este evento é disparado quando o mouse entra na área do ícone Marker . |
mouseup |
function(event) Argumentos:
Este evento é disparado para um mouseup na Marker . |
position_changed |
function() Argumentos: nenhum
Este evento é disparado quando a propriedade de posição Marker é alterada. |
shape_changed |
function() Argumentos: nenhum
Este evento é disparado quando a propriedade da forma Marker é alterada. |
title_changed |
function() Argumentos: nenhum
Este evento é disparado quando a propriedade de título Marker é alterada. |
visible_changed |
function() Argumentos: nenhum
Este evento é disparado quando a propriedade visível Marker é alterada. |
zindex_changed |
function() Argumentos: nenhum
Este evento é disparado quando a propriedade zIndex Marker é alterada. |
|
function(event) Argumentos:
Este evento é disparado para um clique com o botão direito na Marker . |
MarkerOptions
Interface
google.maps.MarkerOptions
O objeto MarkerOptions é usado para definir as propriedades que podem ser definidas em um Marker.
Propriedades | |
---|---|
anchorPoint optional |
Tipo:
Point optional O deslocamento da posição do marcador para a dica de uma janela de informações que foi 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 for true , o marcador recebe eventos de mouse e de toque. |
|
Tipo:
string|CollisionBehavior optional Padrão:
null Defina um comportamento em caso de conflito de marcadores em mapas vetoriais. |
crossOnDrag optional |
Tipo:
boolean optional Padrão:
true Se for false , desativa a cruz que aparece abaixo do marcador ao arrastar. |
cursor optional |
Tipo:
string optional Padrão:
pointer Tipo de cursor do mouse a ser exibido ao passar o cursor. |
draggable optional |
Tipo:
boolean optional Padrão:
false Se ele for definido como true , o marcador poderá ser arrastado. |
icon optional |
Ícone para o primeiro plano. Se uma string for fornecida, ela vai 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 dele. O rótulo pode ser uma string ou um objeto MarkerLabel . Se fornecido e MarkerOptions.title não for fornecido, 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 para 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 receber Marker.setMap se não for informado na construção dele. |
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 o desempenho renderizando muitos marcadores como um único elemento estático. Isso é útil quando muitos marcadores são necessários. Leia mais sobre a otimização de marcadores. |
position optional |
Tipo:
LatLng|LatLngLiteral optional Define a posição do marcador. Um marcador pode ser construído, mas não exibido até que sua posição seja fornecida - por exemplo, por ações ou escolhas do usuário. Uma posição do marcador pode ser fornecida com Marker.setPosition se não for informada 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 para 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 |
Exibir o marcador somente se ele não se sobrepuser a outros marcadores. Se dois marcadores desse tipo se sobrepuserem, aquele com o zIndex mais alto será mostrado. Se eles tiverem o mesmo zIndex, aquele com a posição vertical mais abaixo na tela será mostrado. |
REQUIRED |
Sempre mostrar o marcador, independentemente do conflito. Esse é o comportamento padrão. |
REQUIRED_AND_HIDES_OPTIONAL |
Sempre exibir o marcador, independentemente do conflito, e ocultar todos os marcadores OPTIONAL_AND_HIDES_LOWER_PRIORITY ou rótulos que se sobrepuserem ao marcador. |
Interface Icon
Interface
google.maps.Icon
Uma estrutura que representa a imagem de um ícone de marcador.
Propriedades | |
---|---|
url |
Tipo:
string O URL da planilha de imagem ou sprite. |
anchor optional |
Tipo:
Point optional A posição na qual uma imagem deve ser ancorada em relação ao 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 rótulo de marcador. Um rótulo de marcador é uma string (geralmente um único caractere) que aparece dentro do marcador. Se você a estiver usando com um marcador personalizado, poderá reposicioná-la com a propriedade labelOrigin
na classe Icon
.
Propriedades | |
---|---|
text |
Tipo:
string O texto a 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 usando as outras propriedades de MarkerLabel . As classes CSS não devem ser usadas para alterar a posição nem a orientação do rótulo (por exemplo, com translações e rotações) se você também estiver usando o gerenciamento de conflito 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 de família de fontes de CSS). |
fontSize optional |
Tipo:
string optional Padrão:
'14px' O tamanho da fonte do texto do rótulo (equivalente à propriedade font-size de CSS). |
fontWeight optional |
Tipo:
string optional A espessura da fonte do texto do rótulo (equivalente à propriedade de peso de fonte do CSS). |
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 w3 AREA coords encontrada em http://www.w3.org/TR/REC-html40/struct/objects.html#adef-coords (link em inglês). O atributo coords é uma matriz de números inteiros que especifica a posição em pixels da forma em relação ao canto superior esquerdo da imagem de destino. As coordenadas dependem do valor de type da seguinte forma: - 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 Symbol
Interface
google.maps.Symbol
Descreve um símbolo, que consiste em um caminho vetorial com estilo. Um símbolo pode ser usado como o í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 do 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 uma IconSequence em que fixedRotation é false é girado em relação ao ângulo da borda. |
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 a escala, o símbolo pode ter qualquer tamanho. Para símbolos em uma polilinha, o padrão é a espessura do traço da polilinha. Após o dimensionamento, o símbolo deve estar dentro de um quadrado de 22 pixels de tamanho centralizado na âncora do símbolo. |
strokeColor optional |
Tipo:
string optional 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.Espessura do traço do símbolo. |
Constantes 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 de fechamento apontando para trás. |
BACKWARD_OPEN_ARROW |
Uma seta de abertura apontando para trás. |
CIRCLE |
Um círculo. |
FORWARD_CLOSED_ARROW |
Uma seta fechada apontando para frente. |
FORWARD_OPEN_ARROW |
Uma seta aberta apontando para 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 exibir uma animação.
Acesse chamando const {Animation} = await google.maps.importLibrary("marker")
. Consulte Bibliotecas na API Maps JavaScript.
Constantes | |
---|---|
BOUNCE |
O marcador salta até que a animação seja interrompida, chamando Marker.setAnimation com null . |
DROP |
O marcador cai do topo do mapa para seu local final. A animação será concluída quando o marcador parar, e Marker.getAnimation retornará null . Em geral, esse tipo de animação é especificado durante a criação do marcador. |