Places Widgets

Classe PlaceAutocompleteElement

Classe google.maps.places.PlaceAutocompleteElement

PlaceAutocompleteElement est une sous-classe HTMLElement qui fournit un composant d'interface utilisateur pour l'API Places Autocomplete.

Élément personnalisé:
<gmp-place-autocomplete name="string" requested-language="string" requested-region="string" types="type1 type2 type3..."></gmp-place-autocomplete>

Cette classe étend HTMLElement.

Cette classe implémente PlaceAutocompleteElementOptions.

Pour y accéder, appelez const {PlaceAutocompleteElement} = await google.maps.importLibrary("places"). Consultez Bibliothèques dans l'API Maps JavaScript.
PlaceAutocompleteElement
PlaceAutocompleteElement(options)
Paramètres: 
componentRestrictions
Type:ComponentRestrictions optional
Restrictions des composants. Les restrictions de composant permettent de limiter les prédictions à celles du composant parent. Par exemple, le pays.
locationBias
Type:LocationBias optional
Limite ou indice doux à utiliser pour rechercher des lieux.
locationRestriction
Type:LocationRestriction optional
Limites permettant de limiter les résultats de recherche.
name
Type:string optional
Nom à utiliser pour l'élément d'entrée. Pour en savoir plus, consultez la page https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name. Suit le même comportement que l'attribut "name" pour les entrées. Notez qu'il s'agit du nom qui sera utilisé lors de l'envoi d'un formulaire. Pour en savoir plus, consultez la page https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form.
Attribut HTML:
  • <gmp-placeautocomplete name="string"></gmp-placeautocomplete>
requestedLanguage
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 obtenir un meilleur classement, mais les suggestions ne sont pas limitées à cette langue. Consultez la liste des langues disponibles.
Attribut HTML:
  • <gmp-place-autocomplete requested-language="string"></gmp-place-autocomplete>
requestedRegion
Type:string optional
Code de région utilisé pour la mise en forme et le filtrage des résultats. Les suggestions ne sont pas limitées à ce pays. Le code régional 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), tandis que son code ISO 3166-1 est "gb" (techniquement pour l'entité "Royaume-Uni de Grande-Bretagne et d'Irlande du Nord").
Attribut HTML:
  • <gmp-place-autocomplete requested-region="string"></gmp-place-autocomplete>
types
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.
Attribut HTML:
  • <gmp-place-autocomplete types="type1 type2 type3..."></gmp-place-autocomplete>
prediction-item
Élément de la liste déroulante des prédictions qui représente une seule prédiction.
prediction-item-icon
Icône affichée à gauche de chaque élément dans la liste des prédictions.
prediction-item-main-text
Une partie de l'élément de prédiction qui est le texte principal de la prédiction. Pour les emplacements géographiques, ce champ contient le nom du lieu, comme "Sydney", ou le nom et le numéro d'une rue, comme "10 King Street". Par défaut, le texte "predict-item-main-text" apparaît en noir. Si l'élément de prédiction contient du texte supplémentaire, il se trouve en dehors de l'élément de prédiction et du texte principal, et hérite son style de l'élément de prédiction. Par défaut, il apparaît en gris. Le texte additionnel est généralement une adresse.
prediction-item-match
Partie de la prédiction renvoyée qui correspond à ce qu'a saisi l'utilisateur. Par défaut, le texte correspondant apparaît en gras. Notez que le texte correspondant peut se trouver n'importe où dans l'élément de prédiction. Il ne fait pas nécessairement partie du texte "prédiction-item-main-text".
prediction-item-selected
Élément lorsque l'utilisateur y accède à l'aide du clavier. Remarque: Les éléments sélectionnés seront affectés à la fois par ces styles de pièce et par les styles de pièce de l'élément de prédiction.
prediction-list
Élément visuel contenant la liste des prédictions renvoyées par le service Place Autocomplete. Cette liste s'affiche sous la forme d'une liste déroulante sous PlaceAutocompleteElement.
BetaaddEventListener
addEventListener(type, listener[, options])
Paramètres: 
  • type:  string Chaîne sensible à la casse représentant le type d'événement à écouter.
  • listener:  EventListener|EventListenerObject objet qui reçoit une notification. Il doit s'agir d'une fonction ou d'un objet utilisant la méthode handleEvent
  • options:  boolean|AddEventListenerOptions optional Voir les options. Les événements personnalisés ne sont compatibles qu'avec capture et passive.
Valeur renvoyée:  void
Configure une fonction qui sera appelée chaque fois que l'événement spécifié est envoyé à la cible. Découvrez addEventListener.
BetaremoveEventListener
removeEventListener(type, listener[, options])
Paramètres: 
  • type:  string Chaîne spécifiant le type d'événement pour lequel supprimer un écouteur d'événements.
  • listener:  EventListener|EventListenerObject Écouteur d'événements du gestionnaire d'événements à supprimer de la cible de l'événement.
  • options:  boolean|EventListenerOptions optional Voir les options
Valeur renvoyée:  void
Supprime un écouteur d'événements précédemment enregistré avec addEventListener de la cible. Consultez removeEventListener.
gmp-placeselect
function(placeAutocompletePlaceSelectEvent)
Arguments: 
Cet événement est déclenché lorsqu'un utilisateur sélectionne une prédiction de lieu. Contient un objet Place.
gmp-requesterror
function(placeAutocompleteRequestErrorEvent)
Arguments: 
Cet événement est déclenché lorsqu'une requête adressée au backend a été refusée (clé API incorrecte, par exemple). Cet événement n'apparaît pas dans des bulles.

Interface PlaceAutocompleteElementOptions

Interface google.maps.places.PlaceAutocompleteElementOptions

Options de construction d'un élément PlaceAutocompleteElement.
componentRestrictions optional
Type:ComponentRestrictions optional
Voir PlaceAutocompleteElement.componentRestrictions
locationBias optional
Type:LocationBias optional
Voir PlaceAutocompleteElement.locationBias
locationRestriction optional
Type:LocationRestriction optional
Voir PlaceAutocompleteElement.locationRestriction
requestedLanguage optional
Type:string optional
Voir PlaceAutocompleteElement.requestedLanguage
requestedRegion optional
Type:string optional
Voir PlaceAutocompleteElement.requestedRegion
types optional
Type:Array<string> optional
Voir PlaceAutocompleteElement.types

Classe PlaceAutocompletePlaceSelectEvent

Classe google.maps.places.PlaceAutocompletePlaceSelectEvent

Cet événement est créé une fois que l'utilisateur a sélectionné un lieu avec l'élément Place Autocomplete. Accédez à la sélection avec event.place.

Cette classe étend Event.

Pour y accéder, appelez const {PlaceAutocompletePlaceSelectEvent} = await google.maps.importLibrary("places"). Consultez Bibliothèques dans l'API Maps JavaScript.
Betaplace
Type:Place

Classe PlaceAutocompleteRequestErrorEvent

Classe google.maps.places.PlaceAutocompleteRequestErrorEvent

Cet événement est émis par PlaceAutocompleteElement en cas de problème avec la requête réseau.

Cette classe étend Event.

Pour y accéder, appelez const {PlaceAutocompleteRequestErrorEvent} = await google.maps.importLibrary("places"). Consultez Bibliothèques dans l'API Maps JavaScript.

Classe Autocomplete

Classe google.maps.places.Autocomplete

Widget qui fournit des prédictions de lieu en fonction du texte saisi par l'utilisateur. Il s'associe à un élément d'entrée de type text et écoute le texte saisi dans ce champ. La liste des prédictions se présente sous la forme d'une liste déroulante et est mise à jour à mesure que du texte est saisi.

Cette classe étend MVCObject.

Pour y accéder, appelez 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 est associée au champ de texte d'entrée spécifié avec les options données.
getBounds
getBounds()
Paramètres:aucun
Valeur renvoyée:LatLngBounds|undefined Limites de pondération.
Renvoie les limites de pondération des prédictions.
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 informations ont été correctement récupérées. Pour obtenir la liste des champs, consultez PlaceResult.
getPlace
getPlace()
Paramètres:aucun
Return Value (Valeur renvoyée) : PlaceResult le lieu sélectionné par l'utilisateur.
Renvoie les informations sur le lieu sélectionné par l'utilisateur si elles ont été correctement récupérées. Sinon, renvoie un objet Place bouchon, avec la propriété name définie sur la valeur actuelle du champ de saisie.
setBounds
setBounds(bounds)
Paramètres: 
Return Value (Valeur renvoyée) : aucune
Définit la zone préférée dans laquelle renvoyer des résultats de lieu. Les résultats sont orientés vers ce domaine, sans s'y limiter.
setComponentRestrictions
setComponentRestrictions(restrictions)
Paramètres: 
Return Value (Valeur renvoyée) : aucune
Définit les restrictions des composants. Les restrictions de composant permettent de limiter les prédictions à celles du composant parent. Par exemple, le pays.
setFields
setFields(fields)
Paramètres: 
  • fields:  Array<string> optional
Return Value (Valeur renvoyée) : aucune
Définit les champs à inclure pour le lieu dans la réponse "Details" (Détails) une fois les informations récupérées. Pour obtenir la liste des champs, consultez PlaceResult.
setOptions
setOptions(options)
Paramètres: 
Return Value (Valeur renvoyée) : aucune
setTypes
setTypes(types)
Paramètres: 
  • types:  Array<string> optional types de prédictions à inclure.
Return Value (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 si une requête Place Details échoue, 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 des composants. Les restrictions de 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 "details" une fois les informations récupérées, qui seront facturées. Si ['ALL'] est transmis, 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 seuls les ID de lieu doivent être récupérés. Le PlaceResult mis à disposition lors du déclenchement de l'événement place_changed ne contiendra que les champs "place_id", "types" et "name", ainsi que le place_id, les types et la description renvoyés par le service Autocomplete. Désactivés 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 la valeur strictBounds sur false (valeur par défaut), les résultats sont pondérés en fonction des lieux situés entre 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 qui fournit des prédictions de requête en fonction du texte saisi par un utilisateur. Il s'associe à un élément d'entrée de type text et écoute le texte saisi dans ce champ. La liste des prédictions se présente sous la forme d'une liste déroulante et est mise à jour à mesure que du texte est saisi.

Cette classe étend MVCObject.

Pour y accéder, appelez 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 est associée au champ de texte d'entrée spécifié avec les options données.
getBounds
getBounds()
Paramètres:aucun
Valeur renvoyée:  LatLngBounds|undefined
Renvoie les limites de pondération des prédictions de requête.
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: 
Return Value (Valeur renvoyée) : aucune
Définit la région à utiliser pour pondérer les prédictions des requêtes. Les résultats n'auront d'incidence que sur cette zone et ne seront pas totalement restreints à 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.

SearchBoxOptions.

Interface google.maps.places.SearchBoxOptions

Options pouvant être définies sur un objet SearchBox.
bounds optional
Zone dans laquelle pondérer les prédictions des requêtes. Les prédictions sont orientées vers les requêtes ciblant ces limites, mais ne s'y limitent pas.