Places Widgets

Clase PlaceAutocompleteElement

Clase google.maps.places.PlaceAutocompleteElement

Implementación de AutocompleteView para la API de Places

Esta clase implementa PlaceAutocompleteElementOptions.

Para acceder, llama a const {PlaceAutocompleteElement} = await google.maps.importLibrary("places"). Consulta el artículo Bibliotecas de la API de Maps JavaScript.

PlaceAutocompleteElement
PlaceAutocompleteElement(options)
Parámetros: 
element optional
Tipo:  HTMLElement|SVGElement optional
Este campo es de solo lectura. El elemento DOM que respalda la vista.
inputElement
El elemento de entrada para el que se muestran los autocompletados.
Heredado: componentRestrictions, locationBias, locationRestriction, requestedLanguage, requestedRegion y types
addListener
addListener(eventName, handler)
Parámetros: 
  • eventNamestring
  • handlerFunction
Valor que se devuelve:  MapsEventListener
Agrega la función de objeto de escucha determinada al nombre del evento determinado.
gmp-placeselect
function(place)
Argumentos: 
Este evento se activa cuando un usuario selecciona una predicción del lugar. Muestra un objeto de lugar.
gmp-requesterror
function()
Argumentos: Ninguno
Este evento se activa cuando se rechaza una solicitud al backend (p.ej., una clave de API incorrecta). Este evento no se muestra en una burbuja.

PlaceAutocompleteElementOptions

Interfaz de google.maps.places.PlaceAutocompleteElementOptions

Opciones para construir un PlaceAutocompleteElement.

inputElement
El elemento de entrada para el que se muestran los autocompletados.
componentRestrictions optional
Tipo:  ComponentRestrictions optional
Las restricciones del componente. Las restricciones de componentes se usan para restringir las predicciones solo a aquellas que se encuentran dentro del componente superior. Por ejemplo, el país.
element optional
Tipo:  HTMLElement|SVGElement optional
Este campo es de solo lectura. El elemento DOM que respalda la vista.
locationBias optional
Tipo:  LocationBias optional
Un límite flexible o una pista para usar cuando se buscan lugares
locationRestriction optional
Tipo:  LocationRestriction optional
Límites para restringir los resultados de la búsqueda.
requestedLanguage optional
Tipo:  string optional
Un identificador de idioma para el idioma en el que se deben mostrar los resultados, si es posible. Es posible que los resultados en el idioma seleccionado tengan una clasificación más alta, pero las sugerencias no se limitan a este idioma. Consulta la lista de idiomas compatibles.
requestedRegion optional
Tipo:  string optional
Es el código de región que se usa para dar formato a los resultados y filtrarlos. No restringe las sugerencias a este país. El código de región acepta un valor de ccTLD ("dominio de nivel superior") de dos caracteres. La mayoría de los códigos ccTLD son idénticos a los códigos ISO 3166-1, con algunas excepciones notables. Por ejemplo, el ccTLD del Reino Unido es "uk" (.co.uk), mientras que su código ISO 3166-1 es "gb" (técnicamente para la entidad del "Reino Unido de Gran Bretaña e Irlanda del Norte").
types optional
Tipo:  Array<string> optional
Los tipos de predicciones que se mostrarán. Para conocer los tipos compatibles, consulta la guía para desarrolladores. Si no se especifican tipos, se mostrarán todos los tipos.

Clase Autocomplete

Clase google.maps.places.Autocomplete

Un widget que proporciona predicciones de Places basadas en la entrada de texto del usuario. Se adjunta a un elemento de entrada de tipo text y detecta la entrada de texto en ese campo. La lista de predicciones se presenta como una lista desplegable y se actualiza a medida que se ingresa el texto.

Esta clase extiende MVCObject.

Para acceder, llama a const {Autocomplete} = await google.maps.importLibrary("places"). Consulta el artículo Bibliotecas de la API de Maps JavaScript.

Autocomplete
Autocomplete(inputField[, opts])
Parámetros: 
Crea una instancia nueva de Autocomplete que se adjunta al campo de texto de entrada especificado con las opciones determinadas.
getBounds
getBounds()
Parámetros: Ninguno
Valor que se muestra:  LatLngBounds|undefined Son los límites de personalización.
Muestra los límites a los que se personalizan las predicciones.
getFields
getFields()
Parámetros: Ninguno
Valor que se devuelve:  Array<string>|undefined
Muestra los campos que se incluirán para el lugar en la respuesta de detalles cuando estos se recuperen correctamente. Para obtener una lista de campos, consulta PlaceResult.
getPlace
getPlace()
Parámetros: Ninguno
Valor que se devuelve:  PlaceResult Es el lugar que seleccionó el usuario.
Muestra los detalles del lugar seleccionado por el usuario si estos se recuperaron correctamente. De lo contrario, muestra un objeto Place de stub, con la propiedad name establecida en el valor actual del campo de entrada.
setBounds
setBounds(bounds)
Parámetros: 
Valor que se devuelve: Ninguno
Establece el área preferida dentro de la cual se muestran resultados de lugares. Los resultados se personalizan, aunque no de manera exclusiva, en esta área.
setComponentRestrictions
setComponentRestrictions(restrictions)
Parámetros: 
Valor que se devuelve: Ninguno
Establece las restricciones del componente. Las restricciones de componentes se usan para restringir las predicciones solo a aquellas que se encuentran dentro del componente superior. Por ejemplo, el país.
setFields
setFields(fields)
Parámetros: 
  • fieldsArray<string> optional
Valor que se devuelve: Ninguno
Establece los campos que se incluirán para el lugar en la respuesta de detalles cuando los detalles se recuperen correctamente. Para obtener una lista de campos, consulta PlaceResult.
setOptions
setOptions(options)
Parámetros: 
Valor que se devuelve: Ninguno
setTypes
setTypes(types)
Parámetros: 
  • typesArray<string> optional Son los tipos de predicciones que se incluirán.
Valor que se devuelve: Ninguno
Configura los tipos de predicciones que se mostrarán. Para conocer los tipos compatibles, consulta la guía para desarrolladores. Si no se especifican tipos, se mostrarán todos los tipos.
Heredado: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll
place_changed
function()
Argumentos: Ninguno
Este evento se activa cuando un PlaceResult está disponible para un lugar que el usuario seleccionó.
Si el usuario ingresa el nombre de un lugar que el control no sugirió y presiona la tecla Intro, o bien si falla una solicitud a Place Details, PlaceResult contendrá la entrada del usuario en la propiedad name, sin otras propiedades definidas.

AutocompleteOptions.

Interfaz de google.maps.places.AutocompleteOptions

Opciones que se pueden configurar en un objeto Autocomplete.

bounds optional
Es el área en la que se buscan los lugares.
componentRestrictions optional
Tipo:  ComponentRestrictions optional
Las restricciones del componente. Las restricciones de componentes se usan para restringir las predicciones solo a aquellas que se encuentran dentro del componente superior. Por ejemplo, el país.
fields optional
Tipo:  Array<string> optional
Campos que se incluirán para el lugar en la respuesta de detalles cuando se recuperen correctamente los detalles, que se facturarán. Si se pasa ['ALL'], se mostrarán y se facturarán todos los campos disponibles (esto no se recomienda para las implementaciones de producción). Para obtener una lista de campos, consulta PlaceResult. Los campos anidados se pueden especificar con rutas de puntos (por ejemplo, "geometry.location"). El valor predeterminado es ['ALL'].
placeIdOnly optional
Tipo:  boolean optional
Indica si se deben recuperar solo los IDs de lugar. El PlaceResult que se pone a disposición cuando se activa el evento place_changed solo tendrá los campos place_id, types y name, con los place_id, types y description devueltos por el servicio Autocomplete. Están inhabilitados de forma predeterminada.
strictBounds optional
Tipo:  boolean optional
Un valor booleano, que indica que el widget de Autocomplete solo debe mostrar los sitios que están dentro de los límites del widget de Autocomplete en el momento en que se envía la consulta. Si configuras strictBounds en false (que es la opción predeterminada), los resultados se personalizarán, aunque no de manera exclusiva, en los lugares que se encuentran dentro de los límites.
types optional
Tipo:  Array<string> optional
Los tipos de predicciones que se mostrarán. Para conocer los tipos compatibles, consulta la guía para desarrolladores. Si no se especifican tipos, se mostrarán todos los tipos.

Clase google.maps.places.SearchBox

Un widget que proporciona predicciones de consulta basadas en la entrada de texto del usuario. Se adjunta a un elemento de entrada de tipo text y detecta la entrada de texto en ese campo. La lista de predicciones se presenta como una lista desplegable y se actualiza a medida que se ingresa el texto.

Esta clase extiende MVCObject.

Para acceder, llama a const {SearchBox} = await google.maps.importLibrary("places"). Consulta el artículo Bibliotecas de la API de Maps JavaScript.

SearchBox
SearchBox(inputField[, opts])
Parámetros: 
Crea una instancia nueva de SearchBox que se adjunta al campo de texto de entrada especificado con las opciones determinadas.
getBounds
getBounds()
Parámetros: Ninguno
Valor que se devuelve:  LatLngBounds|undefined
Muestra los límites a los que se personalizan las predicciones de consulta.
getPlaces
getPlaces()
Parámetros: Ninguno
Valor que se devuelve:  Array<PlaceResult>|undefined
Muestra la consulta que seleccionó el usuario para usarla con el evento places_changed.
setBounds
setBounds(bounds)
Parámetros: 
Valor que se devuelve: Ninguno
Establece la región que se usará para personalizar las predicciones de consulta. Los resultados se orientarán solo a esta área y no se restringirán por completo a ella.
Heredado: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll
places_changed
function()
Argumentos: Ninguno
Este evento se activa cuando el usuario selecciona una búsqueda. Se debe usar getPlaces para obtener lugares nuevos.

SearchBoxOptions

Interfaz de google.maps.places.SearchBoxOptions

Opciones que se pueden configurar en un objeto SearchBox.

bounds optional
El área hacia la cual se personalizan las predicciones de consultas. Las predicciones se personalizan, aunque no de manera exclusiva, respecto de las búsquedas que se orientan a estos límites.