Places Widgets

PlaceAutocompleteElement

Classe google.maps.places.PlaceAutocompleteElement

Implementação da AutocompleteView para a API Places

Essa classe implementa PlaceAutocompleteElementOptions.

Acesse chamando const {PlaceAutocompleteElement} = await google.maps.importLibrary("places"). Consulte Bibliotecas na API Maps JavaScript.
PlaceAutocompleteElement
PlaceAutocompleteElement(options)
Parâmetros: 
element optional
Tipo:  HTMLElement|SVGElement optional
Este campo é somente leitura. O elemento DOM que sustenta a visualização.
inputElement
O elemento de entrada para mostrar preenchimentos automáticos.
Herdada: componentRestrictions, locationBias, locationRestriction, requestedLanguage, requestedRegion, types
addListener
addListener(eventName, handler)
Parâmetros: 
  • eventName:  string
  • handler:  Function
Valor de retorno:  MapsEventListener
Adiciona a função de escuta especificada ao nome de evento especificado.
gmp-placeselect
function(place)
Argumentos: 
Este evento é acionado quando um usuário seleciona uma previsão de local. Retorna um objeto de local.
gmp-requesterror
function()
Argumentos:  nenhum
Este evento é acionado quando uma solicitação para o back-end foi negada (por exemplo, chave de API incorreta). Este evento não é exibido em um balão.

PlaceAutocompleteElementOptions.

Interface google.maps.places.PlaceAutocompleteElementOptions

Opções para construir um PlaceAutocompleteElement.
inputElement
O elemento de entrada para mostrar preenchimentos automáticos.
componentRestrictions optional
Tipo:  ComponentRestrictions optional
As restrições do componente. As restrições de componentes são usadas para restringir previsões apenas àquelas dentro do componente pai. Por exemplo, o país.
element optional
Tipo:  HTMLElement|SVGElement optional
Este campo é somente leitura. O elemento DOM que sustenta a visualização.
locationBias optional
Tipo:  LocationBias optional
Um limite flexível ou uma dica para usar ao pesquisar lugares.
locationRestriction optional
Tipo:  LocationRestriction optional
Limites para restringir os resultados da pesquisa.
requestedLanguage optional
Tipo:  string optional
Um identificador de idioma para o idioma no qual 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.
requestedRegion optional
Tipo:  string optional
Um código de região que é usado para formatação e filtragem de resultados. Isso não restringe as sugestões a este país. O código de região aceita um valor de ccTLD ("domínio de nível superior") de dois caracteres. 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").
types optional
Tipo:  Array<string> optional
Os tipos de previsões a serem retornadas. Para tipos suportados, consulte o guia do desenvolvedor. Se nenhum tipo for especificado, todos os tipos serão retornados.

Autocomplete

Classe google.maps.places.Autocomplete

Um widget que fornece previsões de lugar com base na entrada de texto de um usuário. Ele anexa 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 e é atualizada conforme 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 tendenciosas.
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 forem recuperados. 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 os detalhes foram recuperados. Caso contrário, retorna um objeto stub de lugar, 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 preferencial 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 previsões apenas à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 no local na resposta de detalhes quando os detalhes forem recuperados. Para 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ão a serem incluídos.
Valor de retorno: nenhum
Define os tipos de previsões a serem retornados. Para tipos suportados, consulte o guia do desenvolvedor. Se nenhum tipo for especificado, todos os tipos serão retornados.
Herdada: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll
place_changed
function()
Argumentos:  nenhum
Este evento é acionado 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, o PlaceResult conterá a entrada do usuário na propriedade name, sem outras propriedades definidas.

AutocompleteOptions.

Interface google.maps.places.AutocompleteOptions

As opções que podem ser definidas em um objeto Autocomplete.
bounds optional
A área na qual pesquisar lugares.
componentRestrictions optional
Tipo:  ComponentRestrictions optional
As restrições do componente. As restrições de componentes são usadas para restringir previsões apenas àquelas dentro do componente pai. Por exemplo, o país.
fields optional
Tipo:  Array<string> optional
Campos a serem incluídos para o local 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 uma lista de campos, consulte PlaceResult. Os campos aninhados podem ser especificados com caminhos de ponto (por exemplo, "geometry.location"). O padrão é ['ALL'].
placeIdOnly optional
Tipo:  boolean optional
Se deve recuperar apenas IDs de lugares. O PlaceResult disponibilizado quando o evento place_changed é disparado terá apenas o campo place_id, types e name, com o place_id, os tipos e a descrição retornados pelo serviço Autocomplete. Desativado por padrão.
strictBounds optional
Tipo:  boolean optional
Um valor booliano que indica que o widget Autocomplete só deve retornar os locais que estão dentro dos limites do widget Autocomplete no momento em que a consulta é enviada. Definir strictBounds como false (que é o padrão) fará com que os resultados sejam direcionados para locais contidos nos limites, mas não restritos a eles.
types optional
Tipo:  Array<string> optional
Os tipos de previsões a serem retornadas. Para tipos suportados, 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 anexa 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 e é atualizada conforme 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 tendenciosas.
getPlaces
getPlaces()
Parâmetros: nenhum
Valor de retorno:  Array<PlaceResult>|undefined
Retorna a consulta selecionada pelo usuário a 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 consulta. Os resultados serão direcionados apenas para essa área e não ficarão totalmente restritos a ela.
Herdada: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll
places_changed
function()
Argumentos:  nenhum
Este evento é acionado quando o usuário seleciona uma consulta. Use getPlaces para conseguir novos lugares.

SearchBoxOptions.

Interface google.maps.places.SearchBoxOptions

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