Places Widgets

הכיתה PlaceAutocompleteElement

google.maps.places.PlaceAutocompleteElement class

PlaceAutocompleteElement הוא תת-סוג של HTMLElement שמספק רכיב של ממשק משתמש ל-Places Autocomplete API.

רכיב מותאם אישית:
<gmp-place-autocomplete name="string" requested-language="string" requested-region="string" types="type1 type2 type3..."></gmp-place-autocomplete>

הכיתה הזו היא תת-מחלקה של HTMLElement.

המחלקה הזו מטמיעה את PlaceAutocompleteElementOptions.

אפשר לגשת אליו באמצעות חיוג למספר const {PlaceAutocompleteElement} = await google.maps.importLibrary("places"). ספריות ב-Maps JavaScript API

PlaceAutocompleteElement
PlaceAutocompleteElement(options)
פרמטרים: 
componentRestrictions
סוג:  ComponentRestrictions optional
ההגבלות על הרכיבים. הגבלות על רכיבים משמשות להגבלת התחזיות רק לאלה שנמצאות ברכיב ההורה. למשל, המדינה.
locationBias
סוג:  LocationBias optional
גבול או רמז רופפים לשימוש בחיפוש מקומות.
locationRestriction
סוג:  LocationRestriction optional
גבולות כדי להגביל את תוצאות החיפוש.
name
סוג:  string optional
השם שישמש לרכיב הקלט. פרטים נוספים זמינים בכתובת https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name. המאפיין הזה פועל כמו מאפיין השם של הקלט. חשוב לזכור שזה השם שישמש כששולחים טופס. פרטים נוספים זמינים בכתובת https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form.
מאפיין HTML:
  • <gmp-placeautocomplete name="string"></gmp-placeautocomplete>
requestedLanguage
סוג:  string optional
מזהה שפה של השפה שבה צריך להציג את התוצאות, אם אפשר. יכול להיות שתוצאות בשפה שנבחרה יקבלו דירוג גבוה יותר, אבל ההצעות לא מוגבלות לשפה הזו. כאן אפשר לעיין ברשימת השפות הנתמכות.
מאפיין HTML:
  • <gmp-place-autocomplete requested-language="string"></gmp-place-autocomplete>
requestedRegion
סוג:  string optional
קוד אזור שמשמש לעיצוב התוצאות ולסינון התוצאות. היא לא מגבילה את ההצעות למדינה הזו. קוד האזור יכול להכיל ערך בן שני תווים של דומיין ברמה עליונה עם קוד מדינה (ccTLD). רוב הקודים של הדומיינים ברמה הלאומית זהים לקודי ISO 3166-1, מלבד כמה יוצאים מן הכלל. לדוגמה, הדומיין ברמה העליונה של בריטניה הוא 'uk' (.co.uk), ואילו הקוד שלה ב-ISO 3166-1 הוא 'gb' (טכנית, עבור הישות 'ממלכת בריטניה הגדולה וצפון אירלנד').
מאפיין HTML:
  • <gmp-place-autocomplete requested-region="string"></gmp-place-autocomplete>
types
סוג:  Array<string> optional
סוגי התחזיות שיוחזרו. ב מדריך למפתחים מפורטת רשימת הסוגים הנתמכים. אם לא מציינים סוגי פריטים, כל הסוגים יוחזרו.
מאפיין HTML:
  • <gmp-place-autocomplete types="type1 type2 type3..."></gmp-place-autocomplete>
prediction-item
פריט בתפריט הנפתח של התחזיות שמייצג חיזוי יחיד.
prediction-item-icon
הסמל שמוצג משמאל לכל פריט ברשימת התחזיות.
prediction-item-main-text
חלק מ-prediction-item שהוא הטקסט הראשי של התחזית. במיקומים גיאוגרפיים, השדה הזה מכיל שם מקום, כמו 'תל אביב', או שם רחוב ומספר, כמו 'רחוב בן גוריון 10'. כברירת מחדל, הרכיב prediction-item-main-text צבוע בשחור. אם יש טקסט נוסף ב-prediction-item, הוא נמצא מחוץ ל-prediction-item-main-text ויורש את הסגנון שלו מ-prediction-item. כברירת מחדל, הוא בצבע אפור. הטקסט הנוסף הוא בדרך כלל כתובת.
prediction-item-match
החלק של התחזית שהוחזר ותואם לקלט של המשתמש. כברירת מחדל, הטקסט המותאם מודגש בטקסט מודגש. חשוב לזכור שהטקסט התואם יכול להופיע בכל מקום ב-prediction-item. הוא לא חייב להיות חלק מה-prediction-item-main-text.
prediction-item-selected
הפריט כשהמשתמש מנווט אליו באמצעות המקלדת. הערה: הפריטים שנבחרו יושפעו גם מסגנונות החלקים האלה וגם מסגנונות החלקים של פריטי התחזית.
prediction-list
הרכיב החזותי שמכיל את רשימת התחזיות שהוחזרו על ידי שירות ההשלמה האוטומטית של מקומות. הרשימה הזו מופיעה כרשימה נפתחת מתחת ל-PlaceAutocompleteElement.
BetaaddEventListener
addEventListener(type, listener[, options])
פרמטרים: 
  • typestring מחרוזת רגישה לאותיות רישיות שמייצגת את סוג האירוע שרוצים להאזין לו.
  • listenerEventListener|EventListenerObject האובייקט שמקבל התראה. זה חייב להיות פונקציה או אובייקט עם שיטת handleEvent
  • optionsboolean|AddEventListenerOptions optional אפשר לעיין באפשרויות. אירועים מותאמים אישית תומכים רק ב-capture וב-passive.
ערך המוחזר:  void
הגדרת פונקציה שתופעל בכל פעם שהאירוע שצוין יועבר ליעד. ראו addEventListener
BetaremoveEventListener
removeEventListener(type, listener[, options])
פרמטרים: 
  • typestring מחרוזת שמציינת את סוג האירוע שעבורו רוצים להסיר את מאזין האירועים.
  • listenerEventListener|EventListenerObject ה-event listener של גורם הטיפול באירוע שרוצים להסיר מיעד האירוע.
  • optionsboolean|EventListenerOptions optional אפשר לעיין באפשרויות
ערך המוחזר:  void
הסרת רכיב מעקב אירועים שרשום קודם לכן באמצעות addEventListener מהיעד. מידע נוסף זמין במאמר removeEventListener
gmp-placeselect
function(placeAutocompletePlaceSelectEvent)
ארגומנטים: 
האירוע הזה מופעל כשמשתמש בוחר תחזית של מקום. מכיל אובייקט Place.
gmp-requesterror
function(placeAutocompleteRequestErrorEvent)
ארגומנטים: 
האירוע הזה מופעל כשבקשה לקצה העורפי נדחתה (למשל, מפתח API שגוי). האירוע הזה לא עובר 'העברה חזרה'.

הממשק PlaceAutocompleteElementOptions

ממשק google.maps.places.PlaceAutocompleteElementOptions

אפשרויות ליצירת PlaceAutocompleteElement.

componentRestrictions optional
סוג:  ComponentRestrictions optional
locationBias optional
סוג:  LocationBias optional
locationRestriction optional
סוג:  LocationRestriction optional
requestedLanguage optional
סוג:  string optional
requestedRegion optional
סוג:  string optional
types optional
סוג:  Array<string> optional

הכיתה PlaceAutocompletePlaceSelectEvent

google.maps.places.PlaceAutocompletePlaceSelectEvent class

האירוע הזה נוצר אחרי שהמשתמש בוחר מקום באמצעות הרכיב 'השלמה אוטומטית למקומות'. ניגשים לבחירה באמצעות event.place.

הכיתה הזו היא תת-מחלקה של Event.

אפשר לגשת אליו באמצעות חיוג למספר const {PlaceAutocompletePlaceSelectEvent} = await google.maps.importLibrary("places"). ספריות ב-Maps JavaScript API

Betaplace
סוג:  Place

הכיתה PlaceAutocompleteRequestErrorEvent

google.maps.places.PlaceAutocompleteRequestErrorEvent class

האירוע הזה נפלט על ידי PlaceAutocompleteElement כשיש בעיה בבקשת הרשת.

הכיתה הזו היא תת-מחלקה של Event.

אפשר לגשת אליו באמצעות חיוג למספר const {PlaceAutocompleteRequestErrorEvent} = await google.maps.importLibrary("places"). ספריות ב-Maps JavaScript API

הכיתה Autocomplete

google.maps.places.Autocomplete class

ווידג'ט שמציג תחזיות של מקומות על סמך הקלט הטקסט של המשתמש. הוא מצורף לרכיב קלט מסוג text ומקשיב להזנת טקסט בשדה הזה. רשימת התחזיות מוצגת כרשימה נפתחת, והיא מתעדכנת כשמוסיפים טקסט.

הכיתה הזו היא תת-מחלקה של MVCObject.

אפשר לגשת אליו באמצעות חיוג למספר const {Autocomplete} = await google.maps.importLibrary("places"). ספריות ב-Maps JavaScript API

Autocomplete
Autocomplete(inputField[, opts])
פרמטרים: 
יצירת מכונה חדשה של Autocomplete שמצורפת לשדה הטקסט של הקלט שצוין עם האפשרויות הנתונות.
getBounds
getBounds()
פרמטרים:  ללא
ערך המחזרה:  LatLngBounds|undefined גבולות ההטיה.
הפונקציה מחזירה את הגבולות שבהם התחזיות מוטה.
getFields
getFields()
פרמטרים:  ללא
ערך המוחזר:  Array<string>|undefined
הפונקציה מחזירה את השדות שצריך לכלול עבור המקום בתשובה עם הפרטים, אחרי שהפרטים אוחזו בהצלחה. רשימה של שדות מופיעה במאמר PlaceResult.
getPlace
getPlace()
פרמטרים:  ללא
ערך המובהק:  PlaceResult המקום שנבחר על ידי המשתמש.
הפונקציה מחזירה את הפרטים של המקום שנבחר על ידי המשתמש, אם הפרטים אוחרו בהצלחה. אחרת, הפונקציה מחזירה אובייקט Place stub, שבו המאפיין name מוגדר לערך הנוכחי של שדה הקלט.
setBounds
setBounds(bounds)
פרמטרים: 
ערך המוחזר:  None
הגדרת האזור המועדף שבו יוצגו תוצאות של מקומות. התוצאות מוטה לאזור הזה, אבל לא מוגבלת אליו.
setComponentRestrictions
setComponentRestrictions(restrictions)
פרמטרים: 
ערך המוחזר:  None
הגדרת ההגבלות על הרכיבים. הגבלות על רכיבים משמשות להגבלת התחזיות רק לאלה שנמצאות ברכיב ההורה. למשל, המדינה.
setFields
setFields(fields)
פרמטרים: 
  • fieldsArray<string> optional
ערך המוחזר:  None
מגדיר את השדות שכלולים במקום בתשובה עם הפרטים, כשהפרטים מאוחזרים בהצלחה. רשימה של שדות מופיעה במאמר PlaceResult.
setOptions
setOptions(options)
פרמטרים: 
ערך המוחזר:  None
setTypes
setTypes(types)
פרמטרים: 
  • typesArray<string> optional סוגי התחזיות שייכללו.
ערך המוחזר:  None
הגדרת סוגי התחזיות שיוחזרו. ב מדריך למפתחים מפורטת רשימת הסוגים הנתמכים. אם לא מציינים סוגי פריטים, כל הסוגים יוחזרו.
עובר בירושה: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll
place_changed
function()
ארגומנטים:  None
האירוע הזה מופעל כשPlaceResult זמין למקום שהמשתמש בחר.
אם המשתמש מזין את השם של מקום שלא הוצע על ידי הרכיב ומקש על מקש Enter, או אם בקשה לקבלת פרטי מקום נכשלת, השדה PlaceResult מכיל את הקלט של המשתמש בנכס name, ללא הגדרה של נכסים אחרים.

הממשק AutocompleteOptions

ממשק google.maps.places.AutocompleteOptions

האפשרויות שאפשר להגדיר באובייקט Autocomplete.

bounds optional
האזור שבו רוצים לחפש מקומות.
componentRestrictions optional
סוג:  ComponentRestrictions optional
ההגבלות על הרכיבים. הגבלות על רכיבים משמשות להגבלת התחזיות רק לאלה שנמצאות ברכיב ההורה. למשל, המדינה.
fields optional
סוג:  Array<string> optional
השדות שצריך לכלול עבור המקום בתגובה עם הפרטים, כשהפרטים אוחזרים בהצלחה, ועליהם יתבצע החיוב. אם מעבירים את הערך ['ALL'], כל השדות הזמינים יחזרו ויחויבו (לא מומלץ לפריסות ייצור). רשימה של שדות מופיעה במאמר PlaceResult. אפשר לציין שדות בתצוגת עץ באמצעות נתיבים עם נקודות (לדוגמה, "geometry.location"). ברירת המחדל היא ['ALL'].
placeIdOnly optional
סוג:  boolean optional
אם לאחזר רק מזהי מקומות. ב-PlaceResult שזמין כשהאירוע place_changed מופעל יופיעו רק השדות place_id, ‏ types ו-name, עם place_id, ‏ types ו-description שהוחזרו על ידי שירות ההשלמה האוטומטית. מושבתת כברירת מחדל.
strictBounds optional
סוג:  boolean optional
ערך בוליאני שמציין שווידג'ט ההשלמה האוטומטית צריך להציג רק את המקומות שנמצאים בתוך גבולות הווידג'ט של ההשלמה האוטומטית בזמן שליחת השאילתה. הגדרת strictBounds לערך false (ברירת המחדל) תגרום להטיה של התוצאות לכיוון מקומות שנמצאים בתוך הגבולות, אבל לא רק אליהם.
types optional
סוג:  Array<string> optional
סוגי התחזיות שיוחזרו. ב מדריך למפתחים מפורטת רשימת הסוגים הנתמכים. אם לא מציינים סוגי פריטים, כל הסוגים יוחזרו.

google.maps.places.SearchBox class

ווידג'ט שמספק חיזויים של שאילתות על סמך הקלט הטקסט של המשתמש. הוא מצורף לרכיב קלט מסוג text ומקשיב להזנת טקסט בשדה הזה. רשימת התחזיות מוצגת כרשימה נפתחת, והיא מתעדכנת כשמוסיפים טקסט.

הכיתה הזו היא תת-מחלקה של MVCObject.

אפשר לגשת אליו באמצעות חיוג למספר const {SearchBox} = await google.maps.importLibrary("places"). ספריות ב-Maps JavaScript API

SearchBox
SearchBox(inputField[, opts])
פרמטרים: 
יצירת מכונה חדשה של SearchBox שמצורפת לשדה הטקסט של הקלט שצוין עם האפשרויות הנתונות.
getBounds
getBounds()
פרמטרים:  ללא
ערך המוחזר:  LatLngBounds|undefined
הפונקציה מחזירה את הגבולות שבהם יש הטיה בתחזיות של שאילתות.
getPlaces
getPlaces()
פרמטרים:  ללא
ערך המוחזר:  Array<PlaceResult>|undefined
הפונקציה מחזירה את השאילתה שבחר המשתמש לשימוש עם האירוע places_changed.
setBounds
setBounds(bounds)
פרמטרים: 
ערך המוחזר:  None
הגדרת האזור שבו נעשה שימוש כדי להטות את התחזיות של השאילתות. התוצאות יהיו מוטה לאזור הזה בלבד, ולא מוגבלות אליו לחלוטין.
עובר בירושה: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll
places_changed
function()
ארגומנטים:  None
האירוע הזה מופעל כאשר המשתמש בוחר שאילתה. צריך להשתמש ב-getPlaces כדי לקבל מקומות חדשים.

הממשק SearchBoxOptions

ממשק google.maps.places.SearchBoxOptions

האפשרויות שאפשר להגדיר באובייקט SearchBox.

bounds optional
האזור שאליו רוצים להטות את התחזיות של השאילתות. התחזיות מוטה לשאילתות שמטרגטות את הגבולות האלה, אבל לא מוגבלת אליהן.