Places Widgets

Classe PlaceAutocompleteElement

Classe google.maps.places.PlaceAutocompleteElement

PlaceAutocompleteElement é uma subclasse de HTMLElement que fornece um componente de interface para a API Places Autocomplete.

Elemento personalizado:
<gmp-place-autocomplete name="string" requested-language="string" requested-region="string" types="type1 type2 type3..."></gmp-place-autocomplete>

Essa classe estende HTMLElement.

Essa classe implementa PlaceAutocompleteElementOptions.

Acesse chamando const {PlaceAutocompleteElement} = await google.maps.importLibrary("places"). Consulte Bibliotecas na API Maps JavaScript.
PlaceAutocompleteElement
PlaceAutocompleteElement(options)
Parâmetros: 
componentRestrictions
Tipo:  ComponentRestrictions optional
Restrições de componentes. As restrições de componentes são usadas para restringir as previsões somente àquelas dentro do componente pai. Por exemplo, o país.
locationBias
Tipo:  LocationBias optional
Um limite ou dica suave para usar ao pesquisar lugares.
locationRestriction
Tipo:  LocationRestriction optional
Limites para restringir os resultados da pesquisa.
name
Tipo:  string optional
O nome a ser usado para o elemento de entrada. Consulte https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name para ver mais detalhes. Segue o mesmo comportamento que o atributo de nome 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 para ver mais detalhes.
Atributo HTML:
  • <gmp-placeautocomplete name="string"></gmp-placeautocomplete>
requestedLanguage
Tipo:  string optional
Um identificador de idioma para o 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:
  • <gmp-place-autocomplete requested-language="string"></gmp-place-autocomplete>
requestedRegion
Tipo:  string optional
Um código de região que é usado para formatar os resultados e filtrar os resultados. Ele não restringe as sugestões para este 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:
  • <gmp-place-autocomplete requested-region="string"></gmp-place-autocomplete>
types
Tipo:  Array<string> optional
Os tipos de previsões a serem retornados. Para os tipos compatíveis, consulte o guia do desenvolvedor. Se nenhum tipo for especificado, todos os tipos serão retornados.
Atributo HTML:
  • <gmp-place-autocomplete types="type1 type2 type3..."></gmp-place-autocomplete>
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 tipo de texto de previsão-item-main-text é preto. Se houver algum texto adicional no item de previsão, ele vai ficar fora do texto de previsão-item-main-text e herdará o estilo de um item de previsão. 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 predicted-item. Ele não faz necessariamente parte do recurso de previsão-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 pelos estilos desta peça e também pelos estilos de peças 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.
BetaaddEventListener
addEventListener(type, listener[, options])
Parâmetros: 
  • type:  string é uma string que diferencia maiúsculas de minúsculas e representa o tipo de evento a ser detectado.
  • listener:  EventListener|EventListenerObject o objeto que recebe uma notificação. Precisa ser uma função ou um objeto com o método handleEvent
  • options:  boolean|AddEventListenerOptions optional Veja as opções. Os eventos personalizados oferecem suporte apenas a capture e passive.
Valor de retorno:  void
Configura uma função que será chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener
BetaremoveEventListener
removeEventListener(type, listener[, options])
Parâmetros: 
Valor de retorno:  void
Remove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener
gmp-placeselect
function(placeAutocompletePlaceSelectEvent)
Argumentos: 
Este evento é disparado quando um usuário seleciona uma previsão de lugar. Contém um objeto Place.
gmp-requesterror
function(placeAutocompleteRequestErrorEvent)
Argumentos: 
Este evento é disparado quando uma solicitação ao back-end é negada (por exemplo, há uma chave de API incorreta). Esse evento não aparece em uma bolha.

PlaceAutocompleteElementOptions

Interface google.maps.places.PlaceAutocompleteElementOptions

Opções para criar um PlaceAutocompleteElement.
componentRestrictions optional
Tipo:  ComponentRestrictions optional
Ver PlaceAutocompleteElement.componentRestrictions
locationBias optional
Tipo:  LocationBias optional
Ver PlaceAutocompleteElement.locationBias
locationRestriction optional
Tipo:  LocationRestriction optional
Ver PlaceAutocompleteElement.locationRestriction
requestedLanguage optional
Tipo:  string optional
Ver PlaceAutocompleteElement.requestedLanguage
requestedRegion optional
Tipo:  string optional
Ver PlaceAutocompleteElement.requestedRegion
types optional
Tipo:  Array<string> optional
Ver PlaceAutocompleteElement.types

Classe PlaceAutocompletePlaceSelectEvent

Classe google.maps.places.PlaceAutocompletePlaceSelectEvent

Esse evento é criado depois que o usuário seleciona um lugar com o elemento Place Autocomplete. Acesse a seleção com event.place.

Essa classe estende Event.

Acesse chamando const {PlaceAutocompletePlaceSelectEvent} = await google.maps.importLibrary("places"). Consulte Bibliotecas na API Maps JavaScript.
Betaplace
Tipo:  Place

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 chamando const {PlaceAutocompleteRequestErrorEvent} = await google.maps.importLibrary("places"). Consulte Bibliotecas na API Maps JavaScript.

Classe Autocomplete

Classe google.maps.places.Autocomplete

Um widget que fornece previsões de local com base na entrada de texto de um usuário. Ele é anexado a um elemento de entrada do tipo text e detecta a entrada de texto nesse campo. A lista de previsões é apresentada como uma lista suspensa, atualizada à medida que o texto é inserido.

Essa classe estende MVCObject.

Acesse chamando const {Autocomplete} = await google.maps.importLibrary("places"). Consulte Bibliotecas na API Maps JavaScript.
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 oferecidas.
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 polarizadas.
getFields
getFields()
Parâmetros: nenhum
Valor de retorno:  Array<string>|undefined
Retorna os campos a serem incluídos para o local na resposta de detalhes quando os detalhes são recuperados. Para ver 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 os detalhes tiverem sido recuperados. Caso contrário, retorna um objeto de stub do Place, 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 dentro da qual os resultados de lugar devem ser 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 do componente. As restrições de componentes são usadas para restringir as previsões somente àquelas dentro do componente pai. Por exemplo, o país.
setFields
setFields(fields)
Parâmetros: 
  • fields:  Array<string> optional
Valor de retorno: nenhum
Define os campos a serem incluídos para o lugar na resposta de detalhes quando os detalhes são recuperados. Para ver uma lista de campos, consulte PlaceResult.
setOptions
setOptions(options)
Parâmetros: 
Valor de retorno: nenhum
setTypes
setTypes(types)
Parâmetros: 
  • types:  Array<string> optional os tipos de previsões a serem incluídos.
Valor de retorno: nenhum
Define os tipos de previsões a serem retornados. Para os tipos compatíveis, consulte o guia do desenvolvedor. Se nenhum tipo for especificado, todos os tipos serão retornados.
Herdado: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll
place_changed
function()
Argumentos:  nenhum
Este evento é disparado quando um PlaceResult é disponibilizado para um lugar que o usuário selecionou.
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 do Place Details falhar, PlaceResult vai conter a entrada do usuário na propriedade name, sem outras propriedades definidas.

AutocompleteOptions

Interface google.maps.places.AutocompleteOptions

Opções que podem ser definidas em um objeto Autocomplete.
bounds optional
A área na qual os lugares serão pesquisados.
componentRestrictions optional
Tipo:  ComponentRestrictions optional
Restrições de componentes. As restrições de componentes são usadas para restringir as previsões somente àquelas dentro do componente pai. Por exemplo, o país.
fields optional
Tipo:  Array<string> optional
Campos a serem incluídos para o lugar na resposta de detalhes quando os detalhes forem recuperados, que serão cobrados. Se ['ALL'] for transmitido, todos os campos disponíveis serão retornados e faturados. Isso não é recomendado para implantações de produção. Para ver uma lista de campos, consulte PlaceResult. Campos aninhados podem ser especificados com caminhos de pontos (por exemplo, "geometry.location"). O padrão é ['ALL'].
placeIdOnly optional
Tipo:  boolean optional
Define se apenas IDs de lugar serão recuperados. O PlaceResult disponibilizado quando o evento place_changed é disparado terá apenas os campos place_id, types e name, com o place_id, os tipos e a descrição retornados pelo serviço de preenchimento automático. Essa configuração está desativada por padrão.
strictBounds optional
Tipo:  boolean optional
Um valor booleano, indicando que o widget de preenchimento automático só deve retornar os locais que estão dentro dos limites dele no momento em que a consulta é enviada. Definir strictBounds como false (que é o padrão) faz com que os resultados sejam direcionados, mas não restritos, a locais contidos nos limites.
types optional
Tipo:  Array<string> optional
Os tipos de previsões a serem retornados. Para os tipos compatíveis, consulte o guia do desenvolvedor. Se nenhum tipo for especificado, todos os tipos serão retornados.

Classe google.maps.places.SearchBox

Um widget que fornece previsões de consulta com base na entrada de texto de um usuário. Ele é anexado a um elemento de entrada do tipo text e detecta a entrada de texto nesse campo. A lista de previsões é apresentada como uma lista suspensa, atualizada à medida que o texto é inserido.

Essa classe estende MVCObject.

Acesse chamando const {SearchBox} = await google.maps.importLibrary("places"). Consulte Bibliotecas na API Maps JavaScript.
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 oferecidas.
getBounds
getBounds()
Parâmetros: nenhum
Valor de retorno:  LatLngBounds|undefined
Retorna os limites para os quais as previsões de consulta são polarizadas.
getPlaces
getPlaces()
Parâmetros: nenhum
Valor de retorno:  Array<PlaceResult>|undefined
Retorna 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 direcionar previsões de consulta. Os resultados serão direcionados apenas a essa área, e não totalmente restritos a ela.
Herdado: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll
places_changed
function()
Argumentos:  nenhum
Este evento é disparado quando o usuário seleciona uma consulta. getPlaces deve ser usado para buscar novos lugares.

SearchBoxOptions

Interface google.maps.places.SearchBoxOptions

Opções que podem ser definidas em um objeto SearchBox.
bounds optional
A área em que as previsões de consulta serão direcionadas. As previsões são direcionadas, mas não restritas, a consultas direcionadas a esses limites.