Classe 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 é 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 e é atualizada conforme o texto é inserido.
Essa classe estende
MVCObject
.
Requer o parâmetro de URL &libraries=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 oferecidas. |
Métodos | |
---|---|
getBounds |
getBounds() Parâmetros:nenhum
Valor de retorno:
LatLngBounds|undefined os limites de polarização.Retorna os limites pelos 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 no lugar na resposta de detalhes quando os detalhes forem 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 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 de preferência para retornar os resultados de lugar. Os resultados são direcionados a essa área, mas não estão restritos a ela. |
setComponentRestrictions |
setComponentRestrictions(restrictions) Parâmetros:
Valor de retorno: nenhum
Define as restrições do componente. As restrições são usadas para restringir previsões apenas àquelas dentro do componente pai. Por exemplo, o país. |
setFields |
setFields(fields) Parâmetros:
Valor de retorno: nenhum
Define os campos a serem incluídos no lugar na resposta quando os detalhes forem recuperados. Para ver 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ão a serem retornados. Para saber os tipos compatíveis, consulte o Guia do desenvolvedor. Se nenhum tipo for especificado, todos serão retornados. |
Herdadas:
addListener ,
bindTo ,
get ,
notify ,
set ,
setValues ,
unbind ,
unbindAll
|
Eventos | |
---|---|
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. |
Interface AutocompleteOptions
Interface google.maps.places.AutocompleteOptions
As opções que podem ser definidas em um objeto Autocomplete
.
Requer o parâmetro de URL &libraries=places
. Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
---|---|
bounds optional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optional A área na qual pesquisar lugares. |
componentRestrictions optional |
Tipo:
ComponentRestrictions optional As restrições do componente. As restrições 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 no lugar na resposta de detalhes quando os detalhes forem recuperados, que serão faturados. 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 . Os campos aninhados podem ser especificados com pontos (por exemplo, "geometry.location" ). O padrão é ['ALL'] . |
|
Tipo:
boolean optional Define se é necessário recuperar apenas os IDs de lugar. 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 Autocomplete. Desativado por padrão. |
strictBounds optional |
Tipo:
boolean optional Um valor booleano, que indica que o widget do Autocomplete só deve retornar os lugares que estão dentro dos limites do widget no momento em que a consulta é enviada. Definir strictBounds como false (o padrão) fará com que os resultados sejam direcionados para locais contidos nos limites, mas sem restrições. |
types optional |
Tipo:
Array<string> optional 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. |
Classe SearchBox
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 e é atualizada conforme o texto é inserido.
Essa classe estende
MVCObject
.
Requer o parâmetro de URL &libraries=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 oferecidas. |
Métodos | |
---|---|
getBounds |
getBounds() Parâmetros: nenhum
Valor de retorno:
LatLngBounds|undefined Retorna os limites para onde 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 polarizar as previsões de consulta. Os resultados são direcionados apenas para essa área e não são totalmente restritos a ela. |
Herdadas:
addListener ,
bindTo ,
get ,
notify ,
set ,
setValues ,
unbind ,
unbindAll
|
Eventos | |
---|---|
places_changed |
function() Argumentos: nenhum
Este evento é acionado quando o usuário seleciona uma consulta. Use getPlaces para acessar novos lugares. |
SearchBoxOptions.
Interface google.maps.places.SearchBoxOptions
As opções que podem ser definidas em um objeto SearchBox
.
Requer o parâmetro de URL &libraries=places
. Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
---|---|
bounds optional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optional A área na qual a polarização das previsões de consulta. As previsões são tendenciosas, mas não restritas, às consultas direcionadas a esses limites. |