Places Widgets

Clase PlaceAutocompleteElement

Clase google.maps.places.PlaceAutocompleteElement

Aviso: Solo disponible en el canal v=beta.

PlaceAutocompleteElement es una subclase HTMLElement que proporciona un componente de IU para la API de Place Autocomplete.

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

Esta clase extiende HTMLElement.

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.

Constructor
PlaceAutocompleteElement	PlaceAutocompleteElement(options) Parámetros:  options:  PlaceAutocompleteElementOptions

Propiedades
componentRestrictions	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.
locationBias	Tipo:  LocationBias optional Un límite flexible o una pista para usar cuando se buscan lugares
locationRestriction	Tipo:  LocationRestriction optional Límites para restringir los resultados de la búsqueda.
name	Tipo:  string optional El nombre que se usará para el elemento de entrada. Para obtener más información, consulta https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name. Sigue el mismo comportamiento que el atributo de nombre para las entradas. Ten en cuenta que este es el nombre que se usará cuando envíes un formulario. Para obtener más información, consulta https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form. Atributo HTML: <gmp-placeautocomplete name="string"></gmp-placeautocomplete>
requestedLanguage	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. Atributo HTML: <gmp-place-autocomplete requested-language="string"></gmp-place-autocomplete>
requestedRegion	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"). Atributo HTML: <gmp-place-autocomplete requested-region="string"></gmp-place-autocomplete>
types	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. Atributo HTML: <gmp-place-autocomplete types="type1 type2 type3..."></gmp-place-autocomplete>

Partes
prediction-item	Elemento del menú desplegable de predicciones que representa una sola predicción.
prediction-item-icon	Icono que aparece a la izquierda de cada elemento de la lista de predicciones.
prediction-item-main-text	Es una parte del elemento de predicción que es el texto principal de la predicción. En el caso de las ubicaciones geográficas, contiene un nombre de lugar, como "Sídney", o un nombre y un número de una calle, como "10 King Street". De forma predeterminada, el texto de predict-item-main-text es de color negro. Si hay texto adicional en el elemento de predicción, estará fuera de este texto y heredará su estilo del elemento de predicción. Su color predeterminado es el gris. El texto adicional normalmente es una dirección.
prediction-item-match	La parte de la predicción mostrada que coincide con la entrada del usuario. De manera predeterminada, este texto coincidente se resalta en negrita. Ten en cuenta que el texto coincidente puede estar en cualquier lugar dentro del elemento de predicción. No es necesariamente parte de predict-item-main-text.
prediction-item-selected	El elemento que el usuario navega hacia él a través del teclado. Nota: Los elementos seleccionados se verán afectados por este estilo de pieza y también por los estilos de partes de elementos de predicción.
prediction-list	Elemento visual que contiene la lista de predicciones devueltas por el servicio de autocompletado de sitios. Esta lista aparece como una lista desplegable debajo de PlaceAutocompleteElement.

Métodos
addEventListener	Aviso: Solo disponible en el canal v=beta. addEventListener(type, listener[, options]) Parámetros:  type:  string Es una cadena que distingue mayúsculas de minúsculas, que representa el tipo de evento que se debe escuchar. listener:  EventListener|EventListenerObject Es el objeto que recibe una notificación. Debe ser una función o un objeto con el método handleEvent. options:  boolean|AddEventListenerOptions optional Consulta las opciones. Los eventos personalizados solo admiten capture y passive. Valor que se devuelve:  void Configura una función a la que se llamará cada vez que se entregue el evento especificado al destino. Consulta addEventListener.
removeEventListener	Aviso: Solo disponible en el canal v=beta. removeEventListener(type, listener[, options]) Parámetros:  type:  string Es una cadena que especifica el tipo de evento del que se quitará un objeto de escucha de eventos. listener:  EventListener|EventListenerObject Es el objeto de escucha de eventos del controlador de eventos que se quitará del destino del evento. options:  boolean|EventListenerOptions optional Consulta las opciones Valor que se devuelve:  void Elimina del destino un objeto de escucha de eventos registrado previamente con addEventListener. Consulta removeEventListener.

Eventos
gmp-placeselect	function(placeAutocompletePlaceSelectEvent) Argumentos:  placeAutocompletePlaceSelectEvent:  PlaceAutocompletePlaceSelectEvent Este evento se activa cuando un usuario selecciona una predicción del lugar. Contiene un objeto Place.
gmp-requesterror	function(placeAutocompleteRequestErrorEvent) Argumentos:  placeAutocompleteRequestErrorEvent:  PlaceAutocompleteRequestErrorEvent 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

Aviso: Solo disponible en el canal v=beta.

Opciones para construir un PlaceAutocompleteElement.

Propiedades
componentRestrictions optional	Tipo:  ComponentRestrictions optional Consulta PlaceAutocompleteElement.componentRestrictions
locationBias optional	Tipo:  LocationBias optional Consulta PlaceAutocompleteElement.locationBias
locationRestriction optional	Tipo:  LocationRestriction optional Consulta PlaceAutocompleteElement.locationRestriction
requestedLanguage optional	Tipo:  string optional Consulta PlaceAutocompleteElement.requestedLanguage
requestedRegion optional	Tipo:  string optional Consulta PlaceAutocompleteElement.requestedRegion
types optional	Tipo:  Array<string> optional Consulta PlaceAutocompleteElement.types

Clase PlaceAutocompletePlaceSelectEvent

Clase google.maps.places.PlaceAutocompletePlaceSelectEvent

Aviso: Solo disponible en el canal v=beta.

Este evento se crea después de que el usuario selecciona un lugar con el elemento de Place Autocomplete. Accede a la selección con event.place.

Esta clase extiende Event.

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

Propiedades
place	Aviso: Solo disponible en el canal v=beta. Tipo:  Place

Clase PlaceAutocompleteRequestErrorEvent

Clase google.maps.places.PlaceAutocompleteRequestErrorEvent

Aviso: Solo disponible en el canal v=beta.

PlaceAutocompleteElement emite este evento cuando hay un problema con la solicitud de red.

Esta clase extiende Event.

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

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.

Constructor
Autocomplete	Autocomplete(inputField[, opts]) Parámetros:  inputField:  HTMLInputElement Es el campo de texto <input> al que se debe adjuntar Autocomplete. opts:  Opciones de AutocompleteOptions optional. Crea una instancia nueva de Autocomplete que se adjunta al campo de texto de entrada especificado con las opciones determinadas.

Métodos
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:  bounds:  LatLngBounds|LatLngBoundsLiteral optional Son los límites de la personalización. 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:  restrictions:  ComponentRestrictions optional Son las restricciones de uso. 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:  fields:  Array<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:  options:  AutocompleteOptions optional Valor que se devuelve: Ninguno
setTypes	setTypes(types) Parámetros:  types:  Array<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

Eventos
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.

Propiedades
bounds optional	Tipo:  LatLngBounds|LatLngBoundsLiteral 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	Obsoleto: placeIdOnly dejó de estar disponible el 15 de enero de 2019 y se desactivará el 15 de enero de 2020. En su lugar, usa AutocompleteOptions.fields: fields: ['place_id', 'name', 'types']. 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 SearchBox

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.

Constructor
SearchBox	SearchBox(inputField[, opts]) Parámetros:  inputField:  HTMLInputElement opts:  SearchBoxOptions optional Crea una instancia nueva de SearchBox que se adjunta al campo de texto de entrada especificado con las opciones determinadas.

Métodos
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:  bounds:  LatLngBounds|LatLngBoundsLiteral optional 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

Eventos
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.

Propiedades
bounds optional	Tipo:  LatLngBounds|LatLngBoundsLiteral 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.