Places Widgets

Classe PlaceAutocompleteElement

Classe google.maps.places.PlaceAutocompleteElement

  • PlaceAutocompleteElement é uma subclasse HTMLElement que fornece um componente de IU para a API Places Autocomplete. Depois de carregar a biblioteca places, uma entrada com a funcionalidade de preenchimento automático poderá ser criada em HTML. Por exemplo: 
    <gmp-placeautocomplete ></gmp-placeautocomplete>

Elemento personalizado:
<gmp-placeautocomplete></gmp-placeautocomplete>

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:
inputElement
O elemento de entrada para mostrar os preenchimentos automáticos.
Herdadas:componentRestrictions, locationBias, locationRestriction, requestedLanguage, requestedRegion, types
BetaaddEventListener
addEventListener(type, listener[, options])
Parâmetros:
  • type:  string uma string que diferencia maiúsculas de minúsculas que 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 Consulte as opções. Os eventos personalizados são compatíveis apenas com capture e passive.
Valor de retorno:  void
Configura uma função que vai ser chamada sempre que o evento especificado for entregue ao destino. Consulte addEventListener
BetaremoveEventListener
removeEventListener(type, listener[, options])
Parâmetros:
  • type:  string é uma string que especifica o tipo de evento do qual remover um listener de eventos.
  • listener:  EventListener|EventListenerObject o listener de eventos do manipulador de eventos a ser removido do destino do evento.
  • options:  boolean|EventListenerOptions optional Consulte as opções
Valor de retorno:  void
Remove do destino um listener de eventos registrado anteriormente com addEventListener. Consulte removeEventListener

Interface PlaceAutocompleteElementOptions

Interface google.maps.places.PlaceAutocompleteElementOptions

Opções para criar um PlaceAutocompleteElement.
inputElement
O elemento de entrada para mostrar os 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 somente àquelas dentro do componente pai. Por exemplo, o país.
locationBias optional
Tipo:LocationBias optional
Limite ou dica suave para usar ao pesquisar lugares.
locationRestriction optional
Tipo:LocationRestriction optional
Limites para restringir os resultados da pesquisa.
requestedLanguage optional
Tipo:string optional
Um identificador 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.
requestedRegion optional
Tipo:string optional
Um código de região que é usado para a formatação de resultados e para a filtragem de resultados. Isso não restringe as sugestões a este país. O código da região 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").
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 eles vão ser retornados.

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.
Alphaplace
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 lugares com base na entrada de texto do usuário. Ele se anexa a um elemento de entrada do tipo text e detecta entradas 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 fornecidas.
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 enviesadas.
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 conferir 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 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 local na resposta de detalhes quando os detalhes são recuperados. Para conferir 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 eles vão ser retornados.
Herdadas: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.

Interface AutocompleteOptions

Interface google.maps.places.AutocompleteOptions

Opções que podem ser definidas em um objeto Autocomplete.
bounds optional
A área na qual pesquisar locais.
componentRestrictions optional
Tipo:ComponentRestrictions optional
As restrições do componente. As restrições de componentes são usadas para restringir 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 local na resposta de detalhes quando os detalhes forem recuperados, 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 conferir 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 lugares devem ser recuperados. O PlaceResult disponibilizado quando o evento place_change é acionado tem apenas os campos place_id, tipos e nome, com place_id, tipos e 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 eles vão ser retornados.

Classe google.maps.places.SearchBox

Um widget que oferece previsões de consulta com base na entrada de texto do usuário. Ele se anexa a um elemento de entrada do tipo text e detecta entradas 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 fornecidas.
getBounds
getBounds()
Parâmetros:nenhum
Valor de retorno:  LatLngBounds|undefined
Retorna os limites para os quais as previsões de consulta são enviesadas.
getPlaces
getPlaces()
Parâmetros:nenhum
Valor de retorno:  Array<PlaceResult>|undefined
Retorna a consulta selecionada pelo usuário que será usada com o evento places_changed.
setBounds
setBounds(bounds)
Parâmetros:
Valor de retorno: nenhum
Define a região a ser usada para polarizar previsões de consulta. Os resultados serão direcionados apenas a essa área, e não totalmente restritos a ela.
Herdadas: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 conseguir novos lugares.

SearchBoxOptions

Interface google.maps.places.SearchBoxOptions

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