Places Widgets

Classe PlaceAutocompleteElement

Classe google.maps.places.PlaceAutocompleteElement

Implémentation de l'API AutocompleteView pour Places

Cette classe implémente PlaceAutocompleteElementOptions.

Accédez au compte 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 qui sauvegarde la vue.
inputElement
Élément d'entrée pour lequel afficher les termes de saisie semi-automatique.
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 d'é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

Interface google.maps.places.PlaceAutocompleteElementOptions

Options pour créer un PlaceAutocompleteElement.
inputElement
Élément d'entrée pour lequel afficher les termes de saisie semi-automatique.
componentRestrictions optional
Type:ComponentRestrictions optional
Restrictions appliquées aux composants. Les restrictions de composants 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 qui sauvegarde la vue.
locationBias optional
Type:LocationBias optional
Limite ou indice doux à utiliser lorsque vous recherchez des lieux.
locationRestriction optional
Type:LocationRestriction optional
Permet de limiter les résultats de recherche.
requestedLanguage optional
Type:string optional
Identifiant de la langue dans laquelle les résultats doivent être renvoyés, si possible. Les résultats dans la langue sélectionnée peuvent recevoir un meilleur classement, mais les suggestions ne sont pas limitées à cette langue. Consultez la liste des langues disponibles.
requestedRegion optional
Type:string optional
Code régional utilisé pour la mise en forme et le filtrage des résultats. Cela ne limite pas les suggestions à ce pays. Le code de région accepte une valeur à deux caractères associée à ccTLD ("domaine de premier niveau"). 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" (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.

Classe Autocomplete

Classe google.maps.places.Autocomplete

Widget fournissant des prédictions de lieu basées sur le texte saisi par l'utilisateur. Il est associé à 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 forme de liste déroulante. Elle est mise à jour à mesure que vous saisissez du texte.

Cette classe étend MVCObject.

Accédez au compte 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 d'entrée spécifié avec les options fournies.
getBounds
getBounds()
Paramètres:aucun
Valeur renvoyée:LatLngBounds|undefined limites de pondération.
Renvoie les limites auxquelles 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 "details" 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és par l'utilisateur si les informations ont été récupérées. Sinon, renvoie un objet bouchon Place, avec la propriété name définie sur la valeur actuelle du champ de saisie.
setBounds
setBounds(bounds)
Paramètres:
Valeur renvoyée:aucune
Définit la zone souhaitée dans laquelle renvoyer les 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 renvoyée:aucune
Définit les restrictions applicables au composant. Les restrictions de composants permettent de limiter les prédictions à celles du composant parent. Par exemple, le pays.
setFields
setFields(fields)
Paramètres:
  • fields:  Array<string> optional
Valeur renvoyée:aucune
Définit les champs à inclure pour le lieu dans la réponse détaillée lorsque les informations ont été récupérées. Pour obtenir la liste des champs, consultez PlaceResult.
setOptions
setOptions(options)
Paramètres:
Valeur renvoyée:aucune
setTypes
setTypes(types)
Paramètres:
  • types:  Array<string> optional types de prédictions à inclure.
Valeur renvoyée: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 en cas d'échec d'une requête Places Details, le PlaceResult contient l'entrée utilisateur dans la propriété name, sans aucune autre propriété définie.

Interface AutocompleteOptions

Interface google.maps.places.AutocompleteOptions

Options pouvant être définies sur un objet Autocomplete.
bounds optional
Zone dans laquelle rechercher des lieux.
componentRestrictions optional
Type:ComponentRestrictions optional
Restrictions appliquées aux composants. Les restrictions de composants 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 détails sont correctement récupérés (ils seront facturés). Si la valeur ['ALL'] est transmise, tous les champs disponibles sont renvoyés et facturés (non recommandé pour les déploiements de production). Pour obtenir la liste des champs, consultez PlaceResult. Les champs imbriqués peuvent être spécifiés à l'aide de points (par exemple, "geometry.location"). La valeur par défaut est ['ALL'].
placeIdOnly optional
Type:boolean optional
Indique si vous souhaitez uniquement récupérer les ID de lieu. Les champs PlaceResult disponibles pour le déclenchement de l'événement place_changed ne contiennent que les champs place_id, types et name, et les valeurs Place_id, types et description sont renvoyées 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 à l'intérieur des 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 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ête basées sur l'entrée de texte d'un utilisateur. Il est associé à 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 forme de liste déroulante. Elle est mise à jour à mesure que vous saisissez du texte.

Cette classe étend MVCObject.

Accédez au compte 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 d'entrée spécifié avec les options fournies.
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 et utilisée avec l'événement places_changed.
setBounds
setBounds(bounds)
Paramètres:
Valeur renvoyée:aucune
Définit la région à utiliser pour la pondération des requêtes. Les résultats ne seront pondérés que pour cette zone et ne seront pas limités à celle-ci.
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.

Interface SearchBoxOptions

Interface google.maps.places.SearchBoxOptions

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