Places Widgets

Classe PlaceAutocompleteElement

Classe google.maps.places.PlaceAutocompleteElement

Implémentation de l'API AutocompleteView pour Places

Cette classe implémente PlaceAutocompleteElementOptions.

Accédez à en appelant const {PlaceAutocompleteElement} = await google.maps.importLibrary("places"). Consultez Bibliothèques dans l'API Maps JavaScript.
PlaceAutocompleteElement
PlaceAutocompleteElement(options)
Paramètres:
element optional
Type:HTMLElement|SVGElement optional
Ce champ est en lecture seule. Élément DOM supportant la vue.
inputElement
Élément de saisie pour lequel les termes de saisie semi-automatique doivent être affichés.
Hérité: componentRestrictions, locationBias, locationRestriction, requestedLanguage, requestedRegion, types
addListener
addListener(eventName, handler)
Paramètres:
  • eventName:  string
  • handler:  Function
Valeur renvoyée:MapsEventListener
Ajoute la fonction d'écouteur donnée au nom de l'événement donné.
gmp-placeselect
function(place)
Arguments: 
Cet événement est déclenché lorsqu'un utilisateur sélectionne une prédiction de lieu. Renvoie un objet Place
gmp-requesterror
function()
Arguments:aucun
Cet événement est déclenché lorsqu'une requête au backend est refusée (par exemple, une clé API incorrecte). Cet événement ne s'affiche pas.

Interface PlaceAutocompleteElementOptions

google.maps.places.PlaceAutocompleteElementOptions interface

Options pour créer un PlaceAutocompleteElement.
inputElement
Élément de saisie pour lequel les termes de saisie semi-automatique doivent être affichés.
componentRestrictions optional
Type:ComponentRestrictions optional
Restrictions des composants. Les restrictions du composant permettent de limiter les prédictions à celles du composant parent. Par exemple, le pays.
element optional
Type:HTMLElement|SVGElement optional
Ce champ est en lecture seule. Élément DOM supportant la vue.
locationBias optional
Type:LocationBias optional
Limite flexible ou indice à utiliser lorsque vous recherchez des lieux.
locationRestriction optional
Type:LocationRestriction optional
Limite les résultats de recherche.
requestedLanguage optional
Type:string optional
Identifiant de la langue dans laquelle les résultats doivent être affichés, si possible. Il se peut que les résultats soient classés dans la langue sélectionnée, mais qu'ils ne soient pas limités à cette langue. Consultez la liste des langues disponibles.
requestedRegion optional
Type:string optional
Code de région utilisé pour le formatage et le filtrage des résultats. Il ne limite pas les suggestions à ce pays. Le code de région accepte une valeur ccTLD ("domaine de premier niveau") à deux caractères. La plupart des codes ccTLD sont identiques aux codes ISO 3166-1, à quelques exceptions près. Par exemple, le ccTLD du Royaume-Uni est "uk" (.co.uk) alors que son code ISO 3166-1 est "gb" (techniquement pour l'entité "Royaume-Uni de Grande-Bretagne et d'Irlande du Nord").
types optional
Type:Array<string> optional
Types de prédictions à renvoyer. Pour connaître les types compatibles, consultez le guide du développeur. Si aucun type n'est spécifié, tous les types sont renvoyés.

Autocomplete

Classe google.maps.places.Autocomplete

Widget fournissant des prédictions de lieu basées sur le texte saisi par l'utilisateur. Il s'associe à un élément d'entrée de type text et écoute l'entrée de texte dans ce champ. La liste des prédictions s'affiche sous la forme d'une liste déroulante. Elle est mise à jour à mesure que vous saisissez du texte.

Cette classe étend MVCObject.

Accédez à en appelant const {Autocomplete} = await google.maps.importLibrary("places"). Consultez Bibliothèques dans l'API Maps JavaScript.
Autocomplete
Autocomplete(inputField[, opts])
Paramètres:
Crée une instance de Autocomplete qui s'associe au champ de texte spécifié avec les options données.
getBounds
getBounds()
Paramètres:aucun
Valeur renvoyée:LatLngBounds|undefined limites de pondération.
Renvoie les limites sur lesquelles les prédictions sont biaisées.
getFields
getFields()
Paramètres:aucun
Valeur renvoyée:Array<string>|undefined
Renvoie les champs à inclure pour le lieu dans la réponse détaillée lorsque les détails ont été récupérés. Pour obtenir la liste des champs, consultez PlaceResult.
getPlace
getPlace()
Paramètres:aucun
Valeur renvoyée:PlaceResult lieu sélectionné par l'utilisateur.
Renvoie les détails du lieu sélectionné par l'utilisateur si les détails ont été récupérés. Sinon, elle renvoie un objet Place stub avec la propriété name définie sur la valeur actuelle du champ de saisie.
setBounds
setBounds(bounds)
Paramètres:
Valeur de retour:aucune
Définit la zone à privilégier pour le renvoi des résultats de lieu. Les résultats sont orientés vers cette zone, mais n'y sont pas restreints.
setComponentRestrictions
setComponentRestrictions(restrictions)
Paramètres:
Valeur de retour:aucune
Définit les restrictions liées aux composants. Les restrictions du composant permettent de limiter les prédictions à celles du composant parent. Par exemple, le pays.
setFields
setFields(fields)
Paramètres:
  • fields:  Array<string> optional
Valeur de retour:aucune
Définit les champs à inclure pour le lieu dans la réponse détaillée lorsque les détails ont été récupérés. Pour obtenir la liste des champs, consultez PlaceResult.
setOptions
setOptions(options)
Paramètres:
Valeur de retour:aucune
setTypes
setTypes(types)
Paramètres:
  • types:  Array<string> optional types de prédictions à inclure.
Valeur de retour:aucune
Définit les types de prédictions à renvoyer. Pour connaître les types compatibles, consultez le guide du développeur. Si aucun type n'est spécifié, tous les types sont renvoyés.
Hérité: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll
place_changed
function()
Arguments:aucun
Cet événement est déclenché lorsqu'un PlaceResult est disponible pour un lieu sélectionné par l'utilisateur.
Si l'utilisateur saisit le nom d'un lieu qui n'a pas été suggéré par la commande et appuie sur la touche Entrée, ou si une requête Places Details échoue, PlaceResult contient l'entrée utilisateur dans la propriété name, sans aucune autre propriété définie.

Interface AutocompleteOptions

google.maps.places.AutocompleteOptions interface

Options pouvant être définies sur un objet Autocomplete.
bounds optional
Zone de recherche de lieux.
componentRestrictions optional
Type:ComponentRestrictions optional
Restrictions des composants. Les restrictions du composant permettent de limiter les prédictions à celles du composant parent. Par exemple, le pays.
fields optional
Type:Array<string> optional
Champs à inclure pour le lieu dans la réponse détaillée lorsque les informations ont été récupérées, qui seront facturées. Si la valeur ['ALL'] est transmise, tous les champs disponibles sont renvoyés et facturés (non recommandé pour les déploiements en production). Pour obtenir la liste des champs, consultez PlaceResult. Vous pouvez spécifier des champs imbriqués à l'aide de points (par exemple, "geometry.location"). La valeur par défaut est ['ALL'].
placeIdOnly optional
Type:boolean optional
Indique si seuls les ID de lieu doivent être récupérés. Les résultats PlaceResult disponibles lors du déclenchement de l'événement place_changed ne contiennent que les champs "place_id", "types" et "name", et les champs "place_id", "types" et "description" sont renvoyés par le service Autocomplete. Désactivée par défaut.
strictBounds optional
Type:boolean optional
Valeur booléenne indiquant que le widget Autocomplete ne doit renvoyer que les lieux situés dans les limites du widget Autocomplete au moment de l'envoi de la requête. Si vous définissez strictBounds sur false (valeur par défaut), les résultats seront biaisés par rapport aux lieux contenus dans les limites (sans toutefois s'y limiter).
types optional
Type:Array<string> optional
Types de prédictions à renvoyer. Pour connaître les types compatibles, consultez le guide du développeur. Si aucun type n'est spécifié, tous les types sont renvoyés.

Classe google.maps.places.SearchBox

Widget fournissant des prédictions de requêtes basées sur le texte saisi par l'utilisateur. Il s'associe à un élément d'entrée de type text et écoute l'entrée de texte dans ce champ. La liste des prédictions s'affiche sous la forme d'une liste déroulante. Elle est mise à jour à mesure que vous saisissez du texte.

Cette classe étend MVCObject.

Accédez à en appelant const {SearchBox} = await google.maps.importLibrary("places"). Consultez Bibliothèques dans l'API Maps JavaScript.
SearchBox
SearchBox(inputField[, opts])
Paramètres:
Crée une instance de SearchBox qui s'associe au champ de texte spécifié avec les options données.
getBounds
getBounds()
Paramètres:aucun
Valeur renvoyée:LatLngBounds|undefined
Renvoie les limites auxquelles les prédictions de requête sont biaisées.
getPlaces
getPlaces()
Paramètres:aucun
Valeur renvoyée:Array<PlaceResult>|undefined
Renvoie la requête sélectionnée par l'utilisateur à utiliser avec l'événement places_changed.
setBounds
setBounds(bounds)
Paramètres:
Valeur de retour:aucune
Définit la région à utiliser pour la pondération des prédictions de requêtes. Les résultats seront uniquement orientés sur cette zone, et non exclusivement.
Hérité: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll
places_changed
function()
Arguments:aucun
Cet événement est déclenché lorsque l'utilisateur sélectionne une requête. getPlaces doit être utilisé pour obtenir de nouveaux lieux.

SearchBoxOptions

google.maps.places.SearchBoxOptions interface

Options pouvant être définies sur un objet SearchBox.
bounds optional
Zone vers laquelle pondérer les prédictions de requête. Les prédictions sont biaisées par rapport aux requêtes ciblant ces limites, mais n'y sont pas limitées.