Classe PlaceAutocompleteElement
Classe
google.maps.places.PlaceAutocompleteElement
PlaceAutocompleteElement é uma subclasse HTMLElement que fornece um componente de interface para a API Places Autocomplete. O
PlaceAutocompleteElement usa automaticamente AutocompleteSessionTokens internamente para agrupar as fases de consulta e seleção de uma pesquisa de preenchimento automático do usuário.
A primeira chamada para Place.fetchFields em um Place retornado por PlacePrediction.toPlace vai incluir automaticamente o token de sessão usado para buscar o PlacePrediction.
Consulte https://developers.google.com/maps/documentation/places/web-service/place-session-tokens para mais detalhes sobre como as sessões funcionam.
Elemento personalizado:
<gmp-place-autocomplete included-primary-types="type1 type2 type3..." included-region-codes="c1 c2 c3..." name="string" origin="lat,lng" requested-language="string" requested-region="string" unit-system="metric"></gmp-place-autocomplete>
Essa classe estende
HTMLElement.
Essa classe implementa
PlaceAutocompleteElementOptions.
Acesse ligando para const {PlaceAutocompleteElement} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
PlaceAutocompleteElement |
PlaceAutocompleteElement(options)Parâmetros:
|
Propriedades | |
|---|---|
includedPrimaryTypes |
Tipo:
Array<string> optionalIncluído o Tipo de lugar principal (por exemplo, "restaurant" ou "gas_station").
Um lugar só será retornado se o tipo principal dele estiver incluído nessa lista. É possível especificar até cinco valores. Se nenhum tipo for especificado, todos os tipos de lugar serão retornados. Atributo HTML:
|
includedRegionCodes |
Tipo:
Array<string> optionalInclui apenas resultados nas regiões especificadas, que podem ser até 15 códigos de região de dois caracteres do CLDR. Um conjunto vazio não restringe os resultados. Se
locationRestriction e includedRegionCodes estiverem definidos, os resultados vão estar na área de interseção.Atributo HTML:
|
locationBias |
Tipo:
LocationBias optionalUm limite ou dica flexível a ser usado ao pesquisar lugares. |
locationRestriction |
Tipo:
LocationRestriction optionalLimites para restringir os resultados da pesquisa. |
name |
Tipo:
string optionalO nome a ser usado para o elemento de entrada. Consulte https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name (link em inglês) para mais detalhes. Segue o mesmo comportamento do atributo "name" para entradas. Esse é o nome que será usado quando um formulário for enviado. Consulte https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form (link em inglês) para mais detalhes.
Atributo HTML:
|
origin |
Tipo:
LatLng|LatLngLiteral|LatLngAltitude|LatLngAltitudeLiteral optionalA origem de onde calcular a distância. Se não for especificada, a distância não será calculada. A altitude, se fornecida, não é usada no cálculo.
Atributo HTML:
|
requestedLanguage |
Tipo:
string optionalUm identificador do idioma em que os resultados devem ser retornados, se possível. Os resultados no idioma selecionado podem receber uma classificação mais alta, mas as sugestões não são restritas a esse idioma. Consulte a lista de idiomas compatíveis.
Atributo HTML:
|
requestedRegion |
Tipo:
string optionalUm código de região usado para formatação e filtragem de resultados. Ele não restringe as sugestões a esse país. O código regional aceita um valor de dois caracteres ccTLD ("domínio de nível superior"). A maioria dos códigos ccTLD é idêntica aos códigos ISO 3166-1, com algumas exceções notáveis. Por exemplo, o ccTLD do Reino Unido é "uk" (
.co.uk), enquanto o código ISO 3166-1 é "gb" (tecnicamente para a entidade "Reino Unido da Grã-Bretanha e Irlanda do Norte").Atributo HTML:
|
unitSystem |
Tipo:
UnitSystem optionalO sistema de unidades usado para mostrar distâncias. Se não for especificado, o sistema de unidades será determinado por "requestedRegion".
Atributo HTML:
|
Peças | |
|---|---|
prediction-item |
Um item no menu suspenso de previsões que representa uma única previsão. |
prediction-item-icon |
O ícone exibido à esquerda de cada item na lista de previsões. |
prediction-item-main-text |
Uma parte do item de previsão que é o texto principal da previsão. Para localizações geográficas, este item contém o nome de um lugar, como "São Paulo", ou o nome de uma rua e o número, como 'Avenida Paulista, 2013'. Por padrão, o texto principal do item de previsão é preto. Se houver outro texto no prediction-item, ele vai estar fora de prediction-item-main-text e herdar o estilo de prediction-item. A cor padrão é cinza. Normalmente, o texto adicional é um endereço. |
prediction-item-match |
A parte da previsão retornada que corresponde à entrada do usuário. Por padrão, esse texto correspondido é destacado com texto em negrito. O texto correspondente pode estar em qualquer lugar em prediction-item. Ele não necessariamente faz parte de prediction-item-main-text. |
prediction-item-selected |
O item quando o usuário navega até ele usando o teclado. Observação: os itens selecionados serão afetados por esses estilos de parte e também pelos estilos de parte do item de previsão. |
prediction-list |
O elemento visual contendo a lista de previsões retornadas pelo serviço Place Autocomplete. Ela aparece como uma lista suspensa abaixo do PlaceAutocompleteElement. |
Métodos | |
|---|---|
|
addEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidConfigura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener. |
|
removeEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidRemove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener. |
Eventos | |
|---|---|
gmp-error |
function(errorEvent)Argumentos:
Esse evento é disparado quando uma solicitação ao back-end é negada (por exemplo, chave de API incorreta). Esse evento não é propagado. |
gmp-select |
function(placePredictionSelectEvent)Argumentos:
Esse evento é acionado quando um usuário seleciona uma previsão de lugar. Contém um objeto PlacePrediction que pode ser convertido em um objeto Place. |
Interface PlaceAutocompleteElementOptions
Interface google.maps.places.PlaceAutocompleteElementOptions
Opções para construir um PlaceAutocompleteElement. Para a descrição de cada propriedade, consulte a propriedade com o mesmo nome na classe PlaceAutocompleteElement.
Propriedades | |
|---|---|
locationBias optional |
Tipo:
LocationBias optional |
locationRestriction optional |
Tipo:
LocationRestriction optional |
name optional |
Tipo:
string optional |
requestedLanguage optional |
Tipo:
string optional |
Classe PlacePredictionSelectEvent
Classe
google.maps.places.PlacePredictionSelectEvent
Esse evento é criado depois que o usuário seleciona um item de previsão com o PlaceAutocompleteElement. Acesse a seleção com event.placePrediction.
Converta placePrediction em um Place chamando PlacePrediction.toPlace.
Essa classe estende
Event.
Acesse ligando para const {PlacePredictionSelectEvent} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
|---|---|
placePrediction |
Tipo:
PlacePredictionConverta isso em um Place chamando PlacePrediction.toPlace. |
Classe PlaceAutocompleteRequestErrorEvent
Classe
google.maps.places.PlaceAutocompleteRequestErrorEvent
Esse evento é emitido pelo PlaceAutocompleteElement quando há um problema com a solicitação de rede.
Essa classe estende
Event.
Acesse ligando para const {PlaceAutocompleteRequestErrorEvent} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Classe PlaceContextualElement
Classe
google.maps.places.PlaceContextualElement
Um widget que usa o token de contexto para mostrar uma visualização contextual da resposta de embasamento com o Google Maps.
Elemento personalizado:
<gmp-place-contextual context-token="string"></gmp-place-contextual>
Essa classe estende
HTMLElement.
Essa classe implementa
PlaceContextualElementOptions.
Acesse ligando para const {PlaceContextualElement} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
|---|---|
contextToken |
Tipo:
string optionalO token de contexto.
Atributo HTML:
|
Métodos | |
|---|---|
|
addEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidConfigura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener. |
|
removeEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidRemove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener. |
Interface PlaceContextualElementOptions
Interface google.maps.places.PlaceContextualElementOptions
Opções de PlaceContextualElement.
Propriedades | |
|---|---|
contextToken optional |
Tipo:
string optionalO token de contexto fornecido pela resposta do embasamento com o Google Maps. |
Classe PlaceContextualListConfigElement
Classe
google.maps.places.PlaceContextualListConfigElement
Um elemento HTML que configura opções para a visualização de lista do elemento contextual de lugar.
Elemento personalizado:
<gmp-place-contextual-list-config layout="compact" map-hidden></gmp-place-contextual-list-config>
Essa classe estende
HTMLElement.
Essa classe implementa
PlaceContextualListConfigElementOptions.
Acesse ligando para const {PlaceContextualListConfigElement} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
|---|---|
layout |
Tipo:
PlaceContextualListLayout optionalO layout.
Atributo HTML:
|
mapHidden |
Tipo:
boolean optionalSe o mapa está oculto.
Atributo HTML:
|
Métodos | |
|---|---|
|
addEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidConfigura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener. |
|
removeEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidRemove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener. |
Interface PlaceContextualListConfigElementOptions
Interface google.maps.places.PlaceContextualListConfigElementOptions
Opções para PlaceContextualListConfigElement.
Propriedades | |
|---|---|
layout optional |
Tipo:
PlaceContextualListLayout optionalO layout. O padrão é PlaceContextualListLayout.VERTICAL. |
mapHidden optional |
Tipo:
boolean optionalSe o mapa está oculto. O padrão é mostrar o mapa (valor "false"). |
Constantes PlaceContextualListLayout
Constantes de google.maps.places.PlaceContextualListLayout
A lista de layouts que o elemento contextual de lugar oferece suporte para a visualização em lista.
Acesse ligando para const {PlaceContextualListLayout} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Constantes | |
|---|---|
COMPACT |
Layout de lista compacta: os itens são renderizados como links em uma única linha, com estouros em uma lista suspensa. |
VERTICAL |
Layout de lista vertical: os itens da lista são renderizados como cards em uma lista vertical. |
Classe PlaceDetailsElement
Classe
google.maps.places.PlaceDetailsElement
Um elemento HTML que mostra detalhes de um lugar. Use os métodos configureFromPlace() ou configureFromLocation() para especificar o conteúdo a ser renderizado. Para usar o elemento de detalhes do lugar, ative a API Places UI Kit no seu projeto no console do Google Cloud.
Elemento personalizado:
<gmp-place-details size="small"></gmp-place-details>
Essa classe estende
HTMLElement.
Essa classe implementa
PlaceDetailsElementOptions.
Acesse ligando para const {PlaceDetailsElement} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
PlaceDetailsElement |
PlaceDetailsElement([options])Parâmetros:
|
Propriedades | |
|---|---|
place |
Tipo:
Place optionalSomente leitura. Objeto Place que contém o ID, a localização e a janela de visualização do lugar renderizado no momento. |
size |
Tipo:
PlaceDetailsSize optionalA variante de tamanho do PlaceDetailsElement. Por padrão, o elemento vai mostrar
PlaceDetailsSize.X_LARGE.Atributo HTML:
|
Métodos | |
|---|---|
|
addEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidConfigura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener. |
configureFromLocation |
configureFromLocation(location)Parâmetros:
Valor de retorno:
Promise<void> uma promessa que é resolvida quando os dados de lugar são carregados e renderizados.Configura o widget de um LatLng usando a geocodificação inversa. |
configureFromPlace |
configureFromPlace(place)Parâmetros:
Valor de retorno:
Promise<void> uma promessa que é resolvida quando os dados de lugar são carregados e renderizados.Configura o widget com base em um objeto Place ou ID de lugar. |
|
removeEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidRemove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener. |
Eventos | |
|---|---|
gmp-load |
function(event)Argumentos:
Esse evento é acionado quando o elemento carrega e renderiza o conteúdo. Esse evento não é propagado. |
gmp-requesterror |
function(event)Argumentos:
Esse evento é disparado quando uma solicitação ao back-end é negada (por exemplo, chave de API incorreta). Esse evento não é propagado. |
Interface PlaceDetailsElementOptions
Interface google.maps.places.PlaceDetailsElementOptions
Opções de PlaceDetailsElement.
Propriedades | |
|---|---|
size optional |
Tipo:
PlaceDetailsSize optional |
Constantes PlaceDetailsSize
Constantes de google.maps.places.PlaceDetailsSize
Variantes de tamanho para PlaceDetailsElement.
Acesse ligando para const {PlaceDetailsSize} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Constantes | |
|---|---|
LARGE |
Variante grande, incluindo uma imagem grande, informações básicas e dados de contato. |
MEDIUM |
Variante média com uma imagem grande e informações básicas. |
SMALL |
Variante pequena com uma imagem pequena e informações básicas. |
X_LARGE |
Variante extragrande, incluindo uma colagem de fotos, avaliações e informações abrangentes sobre o lugar. |
Classe PlaceDetailsCompactElement
Classe
google.maps.places.PlaceDetailsCompactElement
Mostra detalhes de um lugar em um layout compacto. Adicione um PlaceDetailsPlaceRequestElement para especificar o lugar a ser renderizado. Adicione um PlaceContentConfigElement, PlaceStandardContentElement ou PlaceAllContentElement para especificar qual conteúdo renderizar.
Para usar esse elemento, ative a API Places UI Kit no projeto no console do Google Cloud.
Elemento personalizado:
<gmp-place-details-compact orientation="vertical" truncation-preferred></gmp-place-details-compact>
Essa classe estende
HTMLElement.
Essa classe implementa
PlaceDetailsCompactElementOptions.
Acesse ligando para const {PlaceDetailsCompactElement} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
PlaceDetailsCompactElement |
PlaceDetailsCompactElement([options])Parâmetros:
|
Propriedades | |
|---|---|
orientation |
Tipo:
PlaceDetailsOrientation optionalPadrão:
PlaceDetailsOrientation.VERTICALA variante de orientação (vertical ou horizontal) do elemento.
Atributo HTML:
|
place |
Tipo:
Place optionalSomente leitura. Objeto de lugar que contém o ID, a localização e a janela de visualização do lugar renderizado no momento. |
truncationPreferred |
Tipo:
booleanPadrão:
falseSe for verdadeiro, trunca o nome e o endereço do lugar para caber em uma linha em vez de quebrar.
Atributo HTML:
|
Propriedades de CSS | |
|---|---|
--gmp-mat-color-info |
Cor dos elementos da interface com sentimento informativo. Usado para o ícone de cadeira de rodas. |
--gmp-mat-color-negative |
Cor dos elementos da interface com sentimento negativo. Usado para o texto "Fechado" no status "Aberto agora". |
--gmp-mat-color-neutral-container |
Cor do contêiner para elementos de interface preenchidos neutros. Usado para marcadores de posição de imagem. |
--gmp-mat-color-on-secondary-container |
Cor do texto e dos ícones em relação à cor do contêiner secundário. Usado para texto e ícones no botão "Abrir no Maps". |
--gmp-mat-color-on-surface |
Cor para texto e ícones em qualquer cor de superfície. Usado para texto normal. |
--gmp-mat-color-on-surface-variant |
Cor de menor ênfase para texto e ícones em qualquer cor de superfície. Usado para texto menos enfatizado. |
--gmp-mat-color-outline-decorative |
Cor do contorno de elementos não interativos. Usado para a borda do elemento. |
--gmp-mat-color-positive |
Cor dos elementos da interface com sentimento positivo. Usado para o texto "Abrir" no status "Aberto agora". |
--gmp-mat-color-primary |
Cor do texto e dos ícones interativos em relação à cor da superfície. Usado para contagem de avaliações e links na caixa de diálogo de atribuição. |
--gmp-mat-color-secondary-container |
Cor de preenchimento menos proeminente em relação à superfície, para componentes recessivos, como botões tonais. Usado para o plano de fundo do botão "Abrir no Maps". |
--gmp-mat-color-surface |
Cor para planos de fundo. Usado para os planos de fundo do elemento e da caixa de diálogo de atribuição. |
--gmp-mat-font-body-medium |
Usado para o texto do corpo na caixa de diálogo de atribuição. |
--gmp-mat-font-body-small |
Usado para o endereço, a classificação, o tipo, o preço e o status de aberto agora do lugar. |
--gmp-mat-font-family |
Família de fontes básica usada em todo o texto. |
--gmp-mat-font-headline-medium |
Usado para o texto do cabeçalho na caixa de diálogo de atribuição. |
--gmp-mat-font-label-large |
Usado para o botão "Abrir no Maps" e links na caixa de diálogo de atribuição. |
--gmp-mat-font-title-small |
Usado para o nome do lugar. |
background-color |
Substitui a cor de plano de fundo do elemento. |
border |
Substitui a borda do elemento. |
border-radius |
Substitui o raio da borda do elemento. |
color-scheme |
Indica em qual esquema de cores esse elemento pode ser renderizado. Consulte a documentação do color-scheme para mais detalhes. O valor padrão é color-scheme: light dark. |
font-size |
Dimensiona todo o texto e os ícones no elemento, que são definidos internamente em ems. O valor padrão é 16px. |
Métodos | |
|---|---|
|
addEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidConfigura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener. |
|
removeEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidRemove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener. |
Eventos | |
|---|---|
gmp-error |
function(event)Argumentos:
Esse evento é disparado quando uma solicitação ao back-end é negada (por exemplo, chave de API incorreta). Esse evento não é propagado. |
gmp-load |
function(event)Argumentos:
Esse evento é acionado quando o elemento carrega e renderiza o conteúdo. Esse evento não é propagado. |
Interface PlaceDetailsCompactElementOptions
Interface google.maps.places.PlaceDetailsCompactElementOptions
Opções de PlaceDetailsCompactElement.
Propriedades | |
|---|---|
orientation optional |
Tipo:
PlaceDetailsOrientation optionalConsulte PlaceDetailsCompactElement.orientation. |
truncationPreferred optional |
Tipo:
boolean optional |
Constantes PlaceDetailsOrientation
Constantes de google.maps.places.PlaceDetailsOrientation
Variantes de orientação para PlaceDetailsCompactElement.
Acesse ligando para const {PlaceDetailsOrientation} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Constantes | |
|---|---|
HORIZONTAL |
Orientação horizontal. |
VERTICAL |
Orientação vertical. |
Classe PlaceDetailsPlaceRequestElement
Classe
google.maps.places.PlaceDetailsPlaceRequestElement
Configura um elemento compacto de detalhes do lugar para carregar dados com base em um objeto de lugar, ID ou nome do recurso. Adicione esse elemento como filho de um PlaceDetailsCompactElement para carregar dados do lugar especificado.
Elemento personalizado:
<gmp-place-details-place-request place="some-place-id"></gmp-place-details-place-request>
Essa classe estende
HTMLElement.
Essa classe implementa
PlaceDetailsPlaceRequestElementOptions.
Acesse ligando para const {PlaceDetailsPlaceRequestElement} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
PlaceDetailsPlaceRequestElement |
PlaceDetailsPlaceRequestElement([options])Parâmetros:
|
Propriedades | |
|---|---|
place |
Tipo:
Place optionalO objeto, ID ou nome do recurso do lugar para renderizar detalhes no elemento Compacto de detalhes do lugar. Essa propriedade reflete o atributo como um nome de recurso.
Atributo HTML:
|
Métodos | |
|---|---|
|
addEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidConfigura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener. |
|
removeEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidRemove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener. |
Interface PlaceDetailsPlaceRequestElementOptions
Interface google.maps.places.PlaceDetailsPlaceRequestElementOptions
Opções de PlaceDetailsPlaceRequestElement.
Propriedades | |
|---|---|
place optional |
Tipo:
Place|string optional |
Classe PlaceContentConfigElement
Classe
google.maps.places.PlaceContentConfigElement
Configura o conteúdo a ser mostrado por um elemento compacto de detalhes do lugar. Adicione esse elemento como filho de um PlaceDetailsCompactElement para usá-lo. Adicione qualquer um dos seguintes elementos ao PlaceContentConfigElement para mostrar o conteúdo correspondente:
PlaceMediaElement, PlaceAddressElement, PlaceRatingElement, PlaceTypeElement, PlacePriceElement, PlaceAccessibleEntranceIconElement, PlaceOpenNowStatusElement, PlaceAttributionElement
. A ordem dos filhos não importa. O elemento renderiza o conteúdo em uma ordem padrão que não pode ser personalizada.
Elemento personalizado:
<gmp-place-content-config></gmp-place-content-config>
Essa classe estende
HTMLElement.
Essa classe implementa
PlaceContentConfigElementOptions.
Acesse ligando para const {PlaceContentConfigElement} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
PlaceContentConfigElement |
PlaceContentConfigElement([options])Parâmetros:
|
Métodos | |
|---|---|
|
addEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidConfigura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener. |
|
removeEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidRemove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener. |
Interface PlaceContentConfigElementOptions
Interface google.maps.places.PlaceContentConfigElementOptions
Opções de PlaceContentConfigElement.
Classe PlaceMediaElement
Classe
google.maps.places.PlaceMediaElement
Configura um elemento compacto de detalhes do lugar para mostrar a mídia de um lugar, como fotos. Adicione esse elemento como filho de um PlaceContentConfigElement para usá-lo.
Elemento personalizado:
<gmp-place-media lightbox-preferred></gmp-place-media>
Essa classe estende
HTMLElement.
Essa classe implementa
PlaceMediaElementOptions.
Acesse ligando para const {PlaceMediaElement} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
PlaceMediaElement |
PlaceMediaElement([options])Parâmetros:
|
Propriedades | |
|---|---|
lightboxPreferred |
Tipo:
boolean optionalPadrão:
falseSe a caixa de luz de mídia deve ser ativada ou desativada, nos casos em que as duas opções são compatíveis.
Atributo HTML:
|
Métodos | |
|---|---|
|
addEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidConfigura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener. |
|
removeEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidRemove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener. |
Interface PlaceMediaElementOptions
Interface google.maps.places.PlaceMediaElementOptions
Opções de PlaceMediaElement.
Propriedades | |
|---|---|
lightboxPreferred optional |
Tipo:
boolean optionalConsulte PlaceMediaElement.lightboxPreferred. |
Classe PlaceAddressElement
Classe
google.maps.places.PlaceAddressElement
Configura um elemento compacto de detalhes do lugar para mostrar o endereço de um lugar. Adicione esse elemento como filho de um PlaceContentConfigElement para usá-lo.
Elemento personalizado:
<gmp-place-address></gmp-place-address>
Essa classe estende
HTMLElement.
Essa classe implementa
PlaceAddressElementOptions.
Acesse ligando para const {PlaceAddressElement} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
PlaceAddressElement |
PlaceAddressElement([options])Parâmetros:
|
Métodos | |
|---|---|
|
addEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidConfigura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener. |
|
removeEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidRemove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener. |
Interface PlaceAddressElementOptions
Interface google.maps.places.PlaceAddressElementOptions
Opções de PlaceAddressElement.
Classe PlaceRatingElement
Classe
google.maps.places.PlaceRatingElement
Configura um elemento compacto de detalhes do lugar para mostrar a classificação de um lugar. Adicione esse elemento como filho de um PlaceContentConfigElement para usá-lo.
Elemento personalizado:
<gmp-place-rating></gmp-place-rating>
Essa classe estende
HTMLElement.
Essa classe implementa
PlaceRatingElementOptions.
Acesse ligando para const {PlaceRatingElement} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
PlaceRatingElement |
PlaceRatingElement([options])Parâmetros:
|
Métodos | |
|---|---|
|
addEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidConfigura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener. |
|
removeEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidRemove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener. |
Interface PlaceRatingElementOptions
Interface google.maps.places.PlaceRatingElementOptions
Opções de PlaceRatingElement.
Classe PlaceTypeElement
Classe
google.maps.places.PlaceTypeElement
Configura um elemento compacto de detalhes do lugar para mostrar o tipo de um lugar. Adicione esse elemento como filho de um PlaceContentConfigElement para usá-lo.
Elemento personalizado:
<gmp-place-type></gmp-place-type>
Essa classe estende
HTMLElement.
Essa classe implementa
PlaceTypeElementOptions.
Acesse ligando para const {PlaceTypeElement} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
PlaceTypeElement |
PlaceTypeElement([options])Parâmetros:
|
Métodos | |
|---|---|
|
addEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidConfigura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener. |
|
removeEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidRemove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener. |
Interface PlaceTypeElementOptions
Interface google.maps.places.PlaceTypeElementOptions
Opções de PlaceTypeElement.
Classe PlacePriceElement
Classe
google.maps.places.PlacePriceElement
Configura um elemento compacto de detalhes do lugar para mostrar o nível de preço ou a faixa de preço de um lugar. Adicione esse elemento como filho de um PlaceContentConfigElement para usá-lo.
Elemento personalizado:
<gmp-place-price></gmp-place-price>
Essa classe estende
HTMLElement.
Essa classe implementa
PlacePriceElementOptions.
Acesse ligando para const {PlacePriceElement} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
PlacePriceElement |
PlacePriceElement([options])Parâmetros:
|
Métodos | |
|---|---|
|
addEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidConfigura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener. |
|
removeEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidRemove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener. |
Interface PlacePriceElementOptions
Interface google.maps.places.PlacePriceElementOptions
Opções de PlacePriceElement.
Classe PlaceAccessibleEntranceIconElement
Classe
google.maps.places.PlaceAccessibleEntranceIconElement
Configura um elemento compacto de detalhes do lugar para mostrar um ícone de cadeira de rodas se o local tiver uma entrada acessível. Adicione esse elemento como filho de um PlaceContentConfigElement para usá-lo.
Elemento personalizado:
<gmp-place-accessible-entrance-icon></gmp-place-accessible-entrance-icon>
Essa classe estende
HTMLElement.
Essa classe implementa
PlaceAccessibleEntranceIconElementOptions.
Acesse ligando para const {PlaceAccessibleEntranceIconElement} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
PlaceAccessibleEntranceIconElement |
PlaceAccessibleEntranceIconElement([options])Parâmetros:
|
Métodos | |
|---|---|
|
addEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidConfigura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener. |
|
removeEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidRemove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener. |
Interface PlaceAccessibleEntranceIconElementOptions
Interface google.maps.places.PlaceAccessibleEntranceIconElementOptions
Opções de PlaceAccessibleEntranceIconElement.
Classe PlaceOpenNowStatusElement
Classe
google.maps.places.PlaceOpenNowStatusElement
Configura um elemento compacto de detalhes do lugar para mostrar o status atual de aberto ou fechado de um lugar. Adicione esse elemento como filho de um PlaceContentConfigElement para usá-lo.
Elemento personalizado:
<gmp-place-open-now-status></gmp-place-open-now-status>
Essa classe estende
HTMLElement.
Essa classe implementa
PlaceOpenNowStatusElementOptions.
Acesse ligando para const {PlaceOpenNowStatusElement} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
PlaceOpenNowStatusElement |
PlaceOpenNowStatusElement([options])Parâmetros:
|
Métodos | |
|---|---|
|
addEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidConfigura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener. |
|
removeEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidRemove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener. |
Interface PlaceOpenNowStatusElementOptions
Interface google.maps.places.PlaceOpenNowStatusElementOptions
Opções de PlaceOpenNowStatusElement.
Classe PlaceAttributionElement
Classe
google.maps.places.PlaceAttributionElement
Permite a personalização do texto de atribuição do Google Maps em um elemento compacto de detalhes do lugar. Adicione esse elemento como filho de um PlaceContentConfigElement para usá-lo. Se esse elemento for omitido, a atribuição ainda será mostrada com as cores padrão.
Elemento personalizado:
<gmp-place-attribution dark-scheme-color="white" light-scheme-color="white"></gmp-place-attribution>
Essa classe estende
HTMLElement.
Essa classe implementa
PlaceAttributionElementOptions.
Acesse ligando para const {PlaceAttributionElement} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
PlaceAttributionElement |
PlaceAttributionElement([options])Parâmetros:
|
Propriedades | |
|---|---|
darkSchemeColor |
Tipo:
AttributionColor optionalPadrão:
AttributionColor.WHITEA cor da atribuição do Google Maps no modo escuro.
Atributo HTML:
|
lightSchemeColor |
Tipo:
AttributionColor optionalPadrão:
AttributionColor.GRAYA cor da atribuição do Google Maps no modo claro.
Atributo HTML:
|
Métodos | |
|---|---|
|
addEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidConfigura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener. |
|
removeEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidRemove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener. |
Interface PlaceAttributionElementOptions
Interface google.maps.places.PlaceAttributionElementOptions
Opções de PlaceAttributionElement.
Propriedades | |
|---|---|
darkSchemeColor optional |
Tipo:
AttributionColor optionalConsulte PlaceAttributionElement.darkSchemeColor. |
lightSchemeColor optional |
Tipo:
AttributionColor optionalConsulte PlaceAttributionElement.lightSchemeColor. |
Constantes AttributionColor
Constantes de google.maps.places.AttributionColor
Opções de cores para o texto de atribuição do Google Maps. A atribuição pode ser personalizada para usar qualquer uma dessas cores.
Acesse ligando para const {AttributionColor} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Constantes | |
|---|---|
BLACK |
Texto de atribuição preto. |
GRAY |
Texto de atribuição em cinza. |
WHITE |
Texto de atribuição branco. |
Classe PlaceAllContentElement
Classe
google.maps.places.PlaceAllContentElement
Configura um elemento compacto de detalhes do lugar para mostrar todo o conteúdo disponível. Adicione esse elemento como filho de um PlaceDetailsCompactElement para usá-lo.
Elemento personalizado:
<gmp-place-all-content></gmp-place-all-content>
Essa classe estende
HTMLElement.
Essa classe implementa
PlaceAllContentElementOptions.
Acesse ligando para const {PlaceAllContentElement} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
PlaceAllContentElement |
PlaceAllContentElement([options])Parâmetros:
|
Métodos | |
|---|---|
|
addEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidConfigura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener. |
|
removeEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidRemove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener. |
Interface PlaceAllContentElementOptions
Interface google.maps.places.PlaceAllContentElementOptions
Opções de PlaceAllContentElement.
Classe PlaceStandardContentElement
Classe
google.maps.places.PlaceStandardContentElement
Configura um elemento compacto de detalhes do lugar para mostrar um conjunto padrão de conteúdo (mídia, classificação, tipo, preço, ícone de entrada acessível e status "aberto agora"). Adicione esse elemento como filho de um PlaceDetailsCompactElement para usá-lo.
Elemento personalizado:
<gmp-place-standard-content></gmp-place-standard-content>
Essa classe estende
HTMLElement.
Essa classe implementa
PlaceStandardContentElementOptions.
Acesse ligando para const {PlaceStandardContentElement} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
PlaceStandardContentElement |
PlaceStandardContentElement([options])Parâmetros:
|
Métodos | |
|---|---|
|
addEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidConfigura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener. |
|
removeEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidRemove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener. |
Interface PlaceStandardContentElementOptions
Interface google.maps.places.PlaceStandardContentElementOptions
Opções de PlaceStandardContentElement.
Classe PlaceListElement
Classe
google.maps.places.PlaceListElement
Um elemento HTML que mostra os resultados de uma pesquisa de lugar em uma lista. Use os métodos configureFromSearchByTextRequest() ou configureFromSearchNearbyRequest() para especificar a solicitação de renderização dos resultados. Para usar o elemento de lista de lugares, ative a API Places UI Kit no projeto no console do Google Cloud.
Elemento personalizado:
<gmp-place-list selectable></gmp-place-list>
Essa classe estende
HTMLElement.
Essa classe implementa
PlaceListElementOptions.
Acesse ligando para const {PlaceListElement} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
PlaceListElement |
PlaceListElement([options])Parâmetros:
|
Propriedades | |
|---|---|
places |
Somente leitura. Matriz de objetos Place que contém os IDs, locais e viewports dos lugares renderizados no momento. |
selectable |
Tipo:
booleanSe os itens da lista podem ser selecionados. Se for verdadeiro, os itens da lista serão botões que vão disparar o evento
gmp-placeselect quando forem clicados. A navegação e a seleção acessíveis pelo teclado também são compatíveis.Atributo HTML:
|
Métodos | |
|---|---|
|
addEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidConfigura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener. |
configureFromSearchByTextRequest |
configureFromSearchByTextRequest(request)Parâmetros:
Valor de retorno:
Promise<void> uma promessa que é resolvida quando os dados de lugar são carregados e renderizados.Configura o widget para renderizar resultados da pesquisa de um pedido da API Places Text Search. |
configureFromSearchNearbyRequest |
configureFromSearchNearbyRequest(request)Parâmetros:
Valor de retorno:
Promise<void> uma promessa que é resolvida quando os dados de lugar são carregados e renderizados.Configura o widget para renderizar resultados da pesquisa de um pedido da API Places Nearby Search. |
|
removeEventListener(type, listener[, options])Parâmetros:
Valor de retorno:
voidRemove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener. |
Eventos | |
|---|---|
gmp-load |
function(event)Argumentos:
Esse evento é acionado quando o elemento carrega e renderiza o conteúdo. Esse evento não é propagado. |
gmp-placeselect |
function(event)Argumentos:
Esse evento é acionado quando um usuário seleciona um lugar. Contém um objeto Place e o índice do lugar selecionado na lista. |
gmp-requesterror |
function(event)Argumentos:
Esse evento é disparado quando uma solicitação ao back-end é negada (por exemplo, chave de API incorreta). Esse evento não é propagado. |
Interface PlaceListElementOptions
Interface google.maps.places.PlaceListElementOptions
Opções de PlaceListElement.
Propriedades | |
|---|---|
selectable optional |
Tipo:
boolean optional |
Classe PlaceListPlaceSelectEvent
Classe
google.maps.places.PlaceListPlaceSelectEvent
Esse evento é emitido pelo PlaceListElement quando o usuário seleciona um lugar.
Essa classe estende
Event.
Acesse ligando para const {PlaceListPlaceSelectEvent} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
|---|---|
index |
Tipo:
numberO índice da lista do lugar selecionado. |
place |
Tipo:
PlaceUm objeto Place que contém o ID, a localização e a janela de visualização do lugar selecionado. |
Classe Autocomplete
Classe
google.maps.places.Autocomplete
Um widget que fornece previsões de lugares com base na entrada de texto de um usuário. Ele se conecta a um elemento de entrada do tipo text e aguarda a entrada de texto nesse campo. A lista de previsões é apresentada como um menu suspenso e é atualizada conforme o texto é inserido.
Essa classe estende
MVCObject.
Acesse ligando para const {Autocomplete} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
Autocomplete |
Autocomplete(inputField[, opts])Parâmetros:
Cria uma nova instância de Autocomplete que é anexada ao campo de texto de entrada especificado com as opções fornecidas. |
Métodos | |
|---|---|
getBounds |
getBounds()Parâmetros:nenhum
Valor de retorno:
LatLngBounds|undefined os limites de polarização.Retorna os limites para os quais as previsões são tendenciosas. |
getFields |
getFields()Parâmetros:nenhum
Valor de retorno:
Array<string>|undefinedRetorna os campos a serem incluídos para o lugar na resposta de detalhes quando eles são recuperados com sucesso. Para uma lista de campos, consulte PlaceResult. |
getPlace |
getPlace()Parâmetros:nenhum
Valor de retorno:
PlaceResult o lugar selecionado pelo usuário.Retorna os detalhes do lugar selecionado pelo usuário se eles foram recuperados. Caso contrário, retorna um objeto Place stub, com a propriedade name definida como o valor atual do campo de entrada. |
setBounds |
setBounds(bounds)Parâmetros:
Valor de retorno:nenhum
Define a área preferida em que os resultados de lugar serão retornados. Os resultados são direcionados, mas não restritos, a essa área. |
setComponentRestrictions |
setComponentRestrictions(restrictions)Parâmetros:
Valor de retorno:nenhum
Define as restrições de componente. As restrições de componente são usadas para restringir as previsões apenas àquelas dentro do componente principal. Por exemplo, o país. |
setFields |
setFields(fields)Parâmetros:
Valor de retorno:nenhum
Define os campos a serem incluídos para o lugar na resposta de detalhes quando eles são recuperados com sucesso. Para uma lista de campos, consulte PlaceResult. |
setOptions |
setOptions(options)Parâmetros:
Valor de retorno:nenhum
|
setTypes |
setTypes(types)Parâmetros:
Valor de retorno:nenhum
Define os tipos de previsões a serem retornadas. Para saber os tipos compatíveis, consulte o guia do desenvolvedor. Se nenhum tipo for especificado, todos serão retornados. |
Herdado:addListener,
bindTo,
get,
notify,
set,
setValues,
unbind,
unbindAll
| |
Eventos | |
|---|---|
place_changed |
function()Argumentos: nenhum
Esse evento é acionado quando um PlaceResult é disponibilizado para um lugar selecionado pelo usuário. Se o usuário inserir o nome de um lugar que não foi sugerido pelo controle e pressionar a tecla "Enter", ou se uma solicitação de detalhes de lugar falhar, o PlaceResult vai conter a entrada do usuário na propriedade name, sem outras propriedades definidas. |
Interface AutocompleteOptions
Interface google.maps.places.AutocompleteOptions
As opções que podem ser definidas em um objeto Autocomplete.
Propriedades | |
|---|---|
bounds optional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optionalA área em que os lugares serão pesquisados. |
componentRestrictions optional |
Tipo:
ComponentRestrictions optionalAs restrições de componentes. As restrições de componente são usadas para restringir as previsões apenas àquelas dentro do componente principal. Por exemplo, o país. |
fields optional |
Tipo:
Array<string> optionalCampos a serem incluídos para o lugar na resposta de detalhes quando eles são recuperados com sucesso, o que será cobrado. Se ['ALL'] for transmitido, todos os campos disponíveis serão retornados e faturados, o que não é recomendado para implantações de produção. Para uma lista de campos, consulte PlaceResult. Os campos aninhados podem ser especificados com caminhos de ponto (por exemplo, "geometry.location"). O padrão é ['ALL']. |
|
Tipo:
boolean optionalSe é necessário recuperar apenas IDs de lugar. O PlaceResult disponibilizado quando o evento "place_changed" é acionado só tem os campos "place_id", "types" e "name", com o "place_id", "types" e "description" retornados pelo serviço Autocomplete. Essa configuração está desativada por padrão. |
strictBounds optional |
Tipo:
boolean optionalUm valor booleano que indica que o widget Autocomplete só deve retornar os lugares que estão dentro dos limites dele no momento em que a consulta é enviada. Definir strictBounds como false (que é o padrão) vai direcionar os resultados, mas não restringir, a lugares contidos nos limites. |
types optional |
Tipo:
Array<string> optionalOs tipos de previsões a serem retornadas. Para saber os tipos compatíveis, consulte o guia do desenvolvedor. Se nenhum tipo for especificado, todos serão retornados. |
Classe SearchBox
Classe
google.maps.places.SearchBox
Um widget que fornece previsões de consultas com base na entrada de texto de um usuário. Ele se conecta a um elemento de entrada do tipo text e aguarda a entrada de texto nesse campo. A lista de previsões é apresentada como um menu suspenso e é atualizada conforme o texto é inserido.
Essa classe estende
MVCObject.
Acesse ligando para const {SearchBox} = await google.maps.importLibrary("places").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
SearchBox |
SearchBox(inputField[, opts])Parâmetros:
Cria uma nova instância de SearchBox que é anexada ao campo de texto de entrada especificado com as opções fornecidas. |
Métodos | |
|---|---|
getBounds |
getBounds()Parâmetros:nenhum
Valor de retorno:
LatLngBounds|undefinedRetorna os limites para os quais as previsões de consulta são tendenciosas. |
getPlaces |
getPlaces()Parâmetros:nenhum
Valor de retorno:
Array<PlaceResult>|undefinedRetorna a consulta selecionada pelo usuário para ser usada com o evento places_changed. |
setBounds |
setBounds(bounds)Parâmetros:
Valor de retorno:nenhum
Define a região a ser usada para influenciar as previsões de consultas. Os resultados serão direcionados, mas não restritos, a essa área. |
Herdado:addListener,
bindTo,
get,
notify,
set,
setValues,
unbind,
unbindAll
| |
Eventos | |
|---|---|
places_changed |
function()Argumentos: nenhum
Esse evento é acionado quando o usuário seleciona uma consulta. getPlaces deve ser usado para receber novos lugares. |
Interface SearchBoxOptions
Interface google.maps.places.SearchBoxOptions
As opções que podem ser definidas em um objeto SearchBox.
Propriedades | |
|---|---|
bounds optional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optionalA área para direcionar as previsões de consulta. As previsões são direcionadas, mas não restritas, a consultas que visam esses limites. |