Classe Marker
classe
google.maps.Marker
estende MVCObject
biblioteca "marker"
const {Marker} = await google.maps.importLibrary("marker");
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|undefinedRecebe a animação em execução no momento. |
getClickable |
getClickable()Parâmetros: nenhum
Valor de retorno:
boolean True se o marcador for clicável.Verifica se o é clicável. |
getCursor |
getCursor()Parâmetros: nenhum
Valor de retorno:
string|null|undefinedRecebe o tipo de cursor do mouse mostrado ao passar o cursor. |
getDraggable |
getDraggable()Parâmetros: nenhum
Valor de retorno:
boolean True se o marcador for arrastável.Recebe o status de arrastável do . |
getIcon |
getIcon()Parâmetros: nenhum
Acesse o ícone do . Consulte os MarkerOptions.icon. |
getLabel |
getLabel()Parâmetros: nenhum
Valor de retorno:
MarkerLabel|string|null|undefinedEncontre o rótulo do . Consulte os MarkerOptions.label. |
getMap |
getMap()Parâmetros: nenhum
Valor de retorno:
Map|StreetViewPanorama|nullAcessar o mapa ou o panorama em que o é renderizado. |
getOpacity |
getOpacity()Parâmetros: nenhum
Valor de retorno:
number|null|undefined um número entre 0,0 e 1,0.Recebe a opacidade do . |
getPosition |
getPosition()Parâmetros: nenhum
Valor de retorno:
LatLng|null|undefinedAcesse a posição do . |
getShape |
getShape()Parâmetros: nenhum
Valor de retorno:
MarkerShape|null|undefined |
getTitle |
getTitle()Parâmetros: nenhum
Valor de retorno:
string|null|undefinedRecebe o título da dica de . Consulte os MarkerOptions.title. |
getVisible |
getVisible()Parâmetros: nenhum
Valor de retorno:
boolean True se o marcador estiver visível.Confira a visibilidade do . |
getZIndex |
getZIndex()Parâmetros: nenhum
Valor de retorno:
number|null|undefined zIndex do marcador.Recebe o zIndex do . 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 atualmente aceitas são: Animation.BOUNCE, Animation.DROP. Transmitir null vai interromper qualquer animação. |
setClickable |
setClickable(flag)Parâmetros:
Valor de retorno: nenhum
Define se o é clicável. |
setCursor |
setCursor([cursor])Parâmetros:
Valor de retorno: nenhum
Define o tipo de cursor do mouse mostrado ao passar o cursor. |
setDraggable |
setDraggable(flag)Parâmetros:
Valor de retorno: nenhum
Define se o é arrastável. |
setIcon |
setIcon([icon])Valor de retorno: nenhum
Defina o ícone para o . Consulte os MarkerOptions.icon. |
setLabel |
setLabel([label])Parâmetros:
Valor de retorno: nenhum
Defina o rótulo para o . Consulte os MarkerOptions.label. |
setMap |
setMap(map)Parâmetros:
Valor de retorno: nenhum
Renderiza o 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 do . |
setOptions |
setOptions(options)Parâmetros:
Valor de retorno: nenhum
Defina as opções para o . |
setPosition |
setPosition([latlng])Parâmetros:
Valor de retorno: nenhum
Defina a posição do . |
setShape |
setShape([shape])Parâmetros:
Valor de retorno: nenhum
|
setTitle |
setTitle([title])Parâmetros:
Valor de retorno: nenhum
Defina o título da dica de . Consulte os MarkerOptions.title. |
setVisible |
setVisible(visible)Parâmetros:
Valor de retorno: nenhum
Defina se o está visível. |
setZIndex |
setZIndex([zIndex])Parâmetros:
Valor de retorno: nenhum
Defina o zIndex do . Consulte os MarkerOptions.zIndex. |
Herdado:
addListener,
bindTo,
get,
notify,
set,
setValues,
unbind,
unbindAll
| |
Eventos | |
|---|---|
animation_changed |
function()Argumentos: nenhum
Esse evento é disparado quando a propriedade de animação muda. |
click |
function(event)Argumentos:
Esse evento é acionado quando o ícone é clicado. |
clickable_changed |
function()Argumentos: nenhum
Esse evento é disparado quando a propriedade clicável muda. |
contextmenu |
function(event)Argumentos:
Esse evento é acionado quando o evento contextmenu do DOM é acionado no . |
cursor_changed |
function()Argumentos: nenhum
Esse evento é disparado quando a propriedade do cursor muda. |
dblclick |
function(event)Argumentos:
Este evento é acionado quando o ícone é clicado duas vezes. |
drag |
function(event)Argumentos:
Esse evento é disparado repetidamente enquanto o usuário arrasta o . |
dragend |
function(event)Argumentos:
Esse evento é disparado quando o usuário para de arrastar o . |
draggable_changed |
function()Argumentos: nenhum
Esse evento é disparado quando a propriedade arrastável muda. |
dragstart |
function(event)Argumentos:
Esse evento é disparado quando o usuário começa a arrastar o . |
flat_changed |
function()Argumentos: nenhum
Esse evento é acionado quando a propriedade simples muda. |
icon_changed |
function()Argumentos: nenhum
Esse evento é disparado quando a propriedade do ícone muda. |
mousedown |
function(event)Argumentos:
Esse evento é acionado para um mousedown no . |
mouseout |
function(event)Argumentos:
Esse evento é acionado quando o mouse sai da área do ícone . |
mouseover |
function(event)Argumentos:
Esse evento é acionado quando o mouse entra na área do ícone . |
mouseup |
function(event)Argumentos:
Esse evento é acionado para um mouseup no . |
position_changed |
function()Argumentos: nenhum
Esse evento é disparado quando a propriedade de posição muda. |
shape_changed |
function()Argumentos: nenhum
Esse evento é acionado quando a propriedade de forma muda. |
title_changed |
function()Argumentos: nenhum
Esse evento é disparado quando a propriedade de título muda. |
visible_changed |
function()Argumentos: nenhum
Esse evento é disparado quando a propriedade visível muda. |
zindex_changed |
function()Argumentos: nenhum
Esse evento é disparado quando a propriedade zIndex do muda. |
|
function(event)Argumentos:
Esse evento é disparado quando o usuário clica com o botão direito do mouse no . |
Interface MarkerOptions
interface
google.maps.MarkerOptions
Objeto MarkerOptions usado para definir as propriedades que podem ser definidas em um marcador.
Propriedades | |
|---|---|
anchorPoint
opcional |
Tipo:
Point optionalO deslocamento da posição do marcador até a ponta de um InfoWindow que foi aberto com o marcador como âncora. |
animation
opcional |
Tipo:
Animation optionalPadrão:
nullQual animação deve ser reproduzida quando o marcador for adicionado a um mapa. |
clickable
opcional |
Tipo:
boolean optionalPadrão:
trueSe true, o marcador recebe eventos de mouse e de toque. |
opcional |
Tipo:
string|CollisionBehavior optionalPadrão:
nullDefina um comportamento em caso de conflito para marcadores em mapas vetoriais. |
crossOnDrag
opcional |
Tipo:
boolean optionalPadrão:
trueSe for false, desativa a cruz que aparece abaixo do marcador ao arrastar. |
cursor
opcional |
Tipo:
string optionalPadrão:
pointerTipo de cursor do mouse que aparece na focalização. |
draggable
opcional |
Tipo:
boolean optionalPadrão:
falseSe for true, o marcador poderá ser arrastado. Observação: se você definir como true, o marcador será clicável mesmo que clickable esteja definido como false. |
icon
opcional |
Ícone do primeiro plano. Se uma string for fornecida, ela será tratada como se fosse um Icon com a string como url. |
label
opcional |
Tipo:
string|MarkerLabel optionalPadrão:
nullAdiciona 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 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 em marcadores não otimizados. |
map
opcional |
Tipo:
Map|StreetViewPanorama optionalMapa 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
opcional |
Tipo:
number optionalPadrão: 1.0
Um número entre 0,0 (transparente) e 1,0 (opaco). |
optimized
opcional |
Tipo:
boolean optionalA otimização melhora a performance ao renderizar vários marcadores como um único elemento estático. Isso é útil quando muitos marcadores são necessários. Leia mais sobre a otimização de marcadores. Observação: essa otimização não tem efeito para marcadores em mapas vetoriais. |
position
opcional |
Tipo:
LatLng|LatLngLiteral optionalDefine a posição do marcador. Um marcador pode ser construído, mas não exibido até que a posição dele seja fornecida, por exemplo, pelas ações ou escolhas de um usuário. Uma posição de marcador pode ser fornecida com Marker.setPosition se não for fornecida na construção do marcador. |
shape
opcional |
Tipo:
MarkerShape optionalDefinição da região no mapa de imagem usada para os eventos de arrastar/clicar. |
title
opcional |
Tipo:
string optionalPadrão:
undefinedtexto 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
opcional |
Tipo:
boolean optionalPadrão:
trueSe for true, o marcador ficará visível. |
zIndex
opcional |
Tipo:
number optionalTodos 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
biblioteca "marker"
Essas constantes também podem ser usadas como strings. No TypeScript, os literais de string são definidos pelo tipo CollisionBehaviorString.
const {CollisionBehavior} = await google.maps.importLibrary("marker");
Constantes | |
|---|---|
OPTIONAL_AND_HIDES_LOWER_PRIORITY |
Só mostrar o marcador se ele não se sobrepuser a outros elementos. Em caso de conflito, o marcador com o maior zIndex vai aparecer. 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 mostrar o marcador, independentemente do conflito, e ocultar todos os marcadores OPTIONAL_AND_HIDES_LOWER_PRIORITY ou rótulos que se sobrepuserem a ele. |
Interface Icon
interface
google.maps.Icon
Uma estrutura que representa uma imagem de ícone de marcador.
Propriedades | |
|---|---|
url |
Tipo:
stringO URL da planilha de imagem ou sprite. |
anchor
opcional |
Tipo:
Point optionalA posição em que uma imagem será fixada 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
opcional |
Tipo:
Point optionalA 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 fica no ponto central da imagem. |
origin
opcional |
Tipo:
Point optionalA posição da imagem em um sprite, se houver. Por padrão, a origem fica no canto superior esquerdo da imagem (0, 0). |
scaledSize
opcional |
Tipo:
Size optionalO tamanho da imagem inteira após o dimensionamento, se houver. Use esta propriedade para aumentar/reduzir uma imagem ou um sprite. |
size
opcional |
Tipo:
Size optionalO 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ê estiver usando um marcador personalizado, poderá reposicioná-lo com a propriedade labelOrigin na classe Icon.
Propriedades | |
|---|---|
text |
Tipo:
stringO texto que será exibido no rótulo. |
className
opcional |
Tipo:
string optionalPadrã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 ou a orientação do marcador (por exemplo, usando translações e rotações) se você também estiver usando o gerenciamento de colisão de marcadores. |
color
opcional |
Tipo:
string optionalPadrão:
'black'A cor do texto do rótulo. |
fontFamily
opcional |
Tipo:
string optionalA família de fontes do texto do rótulo (equivalente à propriedade CSS font-family). |
fontSize
opcional |
Tipo:
string optionalPadrão:
'14px'O tamanho da fonte do texto do rótulo (equivalente à propriedade CSS font-size). |
fontWeight
opcional |
Tipo:
string optionalA espessura da fonte do texto do rótulo (equivalente à propriedade CSS font-weight). |
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 | |
|---|---|
type |
Tipo:
stringDescreve o tipo da forma e pode ser circle, poly ou rect. |
coords
opcional |
Tipo:
Array<number> optionalO formato desse atributo depende do valor de type e segue a especificação AREA coords do W3, que pode ser encontrada 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 em pixels 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. |
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|stringO 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
opcional |
Tipo:
Point optionalPadrã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
opcional |
Tipo:
string optionalA 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
opcional |
Tipo:
number optionalPadrão:
0A opacidade do preenchimento do símbolo. |
labelOrigin
opcional |
Tipo:
Point optionalPadrã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
opcional |
Tipo:
number optionalPadrão:
0O â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
opcional |
Tipo:
number optionalO 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. Após o dimensionamento, o símbolo precisa ficar dentro de um quadrado de 22 pixels centralizado na âncora do símbolo. |
strokeColor
opcional |
Tipo:
string optionalA 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
opcional |
Tipo:
number optionalA 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
opcional |
Tipo:
number optionalPadrão: o
Symbol.scale do símbolo.A espessura do traço do símbolo. |
Constantes SymbolPath
constantes
google.maps.SymbolPath
biblioteca "core"
Caminhos de símbolos integrados.
const {SymbolPath} = await google.maps.importLibrary("core");
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
biblioteca "marker"
Animações que podem ser executadas em um marcador. Use o método Marker.setAnimation em Marker ou a opção MarkerOptions.animation para reproduzir uma animação.
const {Animation} = await google.maps.importLibrary("marker");
Constantes | |
|---|---|
BOUNCE |
O marcador salta 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 retorna null. Geralmente, esse tipo de animação é especificado durante a criação do marcador. |