המחלקה PlaceAutocompleteElement
google.maps.places.PlaceAutocompleteElement
סיווג
PlaceAutomaticElement היא מחלקת משנה של HTMLElement
שמספקת רכיב של ממשק המשתמש להשלמה אוטומטית של מקומות ב-Places 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:
|
requestedLanguage |
סוג:
string optional מזהה השפה של השפה שבה יוצגו התוצאות, אם זה אפשרי. יכול להיות שתוצאות בשפה שנבחרה יקבלו דירוג גבוה יותר, אבל ההצעות לא מוגבלות לשפה הזו. כאן אפשר לעיין ברשימת השפות הנתמכות.
מאפיין HTML:
|
requestedRegion |
סוג:
string optional קוד אזור המשמש לעיצוב תוצאות ולסינון תוצאות. היא לא מגבילה את ההצעות למדינות האלה. קוד האזור מקבל ערך בן שני תווים של ccTLD ("דומיין ברמה העליונה"). רוב הקודים של ccTLD זהים לקודי ISO 3166-1, למעט כמה יוצאים מן הכלל. לדוגמה, הדומיין ברמה העליונה של קוד מדינה (ccTLD) בבריטניה הוא "uk" (
.co.uk ) אבל קוד ISO 3166-1 שלו הוא "gb" (טכני עבור הישות "בריטניה וצפון אירלנד").מאפיין HTML:
|
types |
סוג:
Array<string> optional סוגי החיזויים שיש להחזיר. הסוגים הנתמכים מפורטים במדריך למפתחים. אם לא מציינים סוגים, כל הסוגים יוחזרו.
מאפיין HTML:
|
חלקים | |
---|---|
prediction-item |
פריט בתפריט הנפתח של החיזויים שמייצג חיזוי אחד. |
prediction-item-icon |
הסמל שמוצג מימין לכל פריט ברשימת החיזויים. |
prediction-item-main-text |
חלק מפריט החיזוי, שהוא הטקסט הראשי של החיזוי. לגבי מיקומים גיאוגרפיים, המאפיין כולל שם של מקום, כמו 'סידני', או שם רחוב ומספר, כמו 'רחוב המלך 10'. כברירת מחדל, הטקסט של פריט החיזוי מהפריט הראשי צבוע בשחור. אם יש טקסט נוסף בפריט החיזוי, הוא נמצא מחוץ לטקסט הראשי של פריט החיזוי ויורש את הסגנון שלו מפריט החיזוי. כברירת מחדל, הצבע הוא אפור. הטקסט הנוסף הוא בדרך כלל כתובת. |
prediction-item-match |
החלק בחיזוי שהוחזר שתואם לקלט של המשתמש. כברירת מחדל, הטקסט התואם הזה מודגש בטקסט מודגש. לתשומת ליבכם: הטקסט התואם יכול להופיע במקום כלשהו בתוך פריט החיזוי. הוא לא בהכרח חלק מהטקסט הראשי של חיזוי-פריט. |
prediction-item-selected |
הפריט כשהמשתמש מנווט אליו באמצעות המקלדת. הערה: הפריטים שנבחרו יושפעו גם מסגנונות החלקים האלה וגם מסגנונות החלקים של פריט החיזוי. |
prediction-list |
הרכיב הוויזואלי שמכיל את רשימת החיזויים שהוחזרו על ידי שירות ההשלמה האוטומטית של מקומות. רשימה זו מופיעה כרשימה נפתחת מתחת לרכיב ההשלמה האוטומטית של המקום. |
שיטות | |
---|---|
addEventListener |
addEventListener(type, listener[, options]) פרמטרים:
הערך המוחזר:
void מגדירה פונקציה שתיקרא בכל פעם שהאירוע שצוין מועבר ליעד. ראו את addEventListener |
removeEventListener |
removeEventListener(type, listener[, options]) פרמטרים:
הערך המוחזר:
void מסיר מהיעד האזנה לאירוע שנרשם בעבר באמצעות addEventListener. ראו את removeEventListener |
אירועים | |
---|---|
gmp-placeselect |
function(placeAutocompletePlaceSelectEvent) ארגומנטים:
האירוע הזה מופעל כשמשתמש בוחר חיזוי מקום. מכיל אובייקט מקום. |
gmp-requesterror |
function(placeAutocompleteRequestErrorEvent) ארגומנטים:
האירוע הזה מופעל כשבקשה לקצה העורפי נדחתה (לדוגמה, מפתח API שגוי). האירוע לא מופיע בבועות. |
ממשק PlaceAutocompleteElementOptions
ממשק google.maps.places.PlaceAutocompleteElementOptions
אפשרויות לבניית רכיב PlaceAutomaticElement.
תכונות | |
---|---|
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 הצגה של PlaceAutocompleteElement.types |
שיעור של PlaceAutocompletePlaceSelectEvent
google.maps.places.PlaceAutocompletePlaceSelectEvent
סיווג
האירוע הזה נוצר אחרי שהמשתמש בוחר מקום עם הרכיב 'השלמה אוטומטית של מקומות'. אפשר לגשת לבחירה באמצעות event.place
.
הכיתה הזו משתרעת על פני
Event
.
ניתן לגשת באמצעות חיוג אל const {PlaceAutocompletePlaceSelectEvent} = await google.maps.importLibrary("places")
. ראה ספריות ב-Maps JavaScript API.
תכונות | |
---|---|
place |
סוג:
Place |
המחלקה PlaceAutocompleteRequestErrorEvent
google.maps.places.PlaceAutocompleteRequestErrorEvent
סיווג
האירוע הזה נפלט על ידי ה-PlaceAutomaticElement כשיש בעיה בבקשת הרשת.
הכיתה הזו משתרעת על פני
Event
.
ניתן לגשת באמצעות חיוג אל const {PlaceAutocompleteRequestErrorEvent} = await google.maps.importLibrary("places")
. ראה ספריות ב-Maps JavaScript API.
השלמה אוטומטית של הכיתה
google.maps.places.Autocomplete
סיווג
ווידג'ט שמספק חיזויי מקום על סמך קלט טקסט של משתמש. היא נצמדת לרכיב קלט מסוג 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 המקום שנבחר על ידי המשתמש.מחזירה את הפרטים של המקום שנבחר על ידי המשתמש אם הפרטים אוחזרו בהצלחה. אחרת, מוחזר אובייקט stub של מיקום, כאשר המאפיין name מוגדר לערך הנוכחי של שדה הקלט. |
setBounds |
setBounds(bounds) פרמטרים:
ערך החזרה: ללא
הגדרת האזור המועדף להחזרת תוצאות של מקומות. התוצאות מוטות לכיוון האזור הזה, אך לא רק. |
setComponentRestrictions |
setComponentRestrictions(restrictions) פרמטרים:
ערך החזרה: ללא
המדיניות מגדירה את ההגבלות על הרכיבים. הגבלות על רכיבים משמשות להגבלת החיזויים רק לאלו שבתוך רכיב ההורה. למשל, המדינה. |
setFields |
setFields(fields) פרמטרים:
ערך החזרה: ללא
מגדיר את השדות להכללה עבור המקום בתגובת הפרטים לאחר שהפרטים אוחזרו בהצלחה. לרשימת השדות יש לעיין ב- PlaceResult . |
setOptions |
setOptions(options) פרמטרים:
ערך החזרה: ללא
|
setTypes |
setTypes(types) פרמטרים:
ערך החזרה: ללא
מגדירה את סוגי החיזויים שיש להחזיר. הסוגים הנתמכים מפורטים במדריך למפתחים. אם לא מציינים סוגים, כל הסוגים יוחזרו. |
עברה בירושה:
addListener ,
bindTo ,
get ,
notify ,
set ,
setValues ,
unbind ,
unbindAll
|
אירועים | |
---|---|
place_changed |
function() ארגומנטים: ללא
האירוע הזה מופעל כאשר PlaceResult הופך לזמין למקום שהמשתמש בחר. אם המשתמש מזין שם של מקום שלא הוצע על ידי הפקד ולוחץ על מקש Enter, או אם בקשה של פרטי מקום נכשלת, PlaceResult מכיל את קלט המשתמש במאפיין name , ללא מאפיינים אחרים מוגדרים. |
ממשק AutocompleteOptions
ממשק google.maps.places.AutocompleteOptions
האפשרויות שאפשר להגדיר באובייקט Autocomplete
.
תכונות | |
---|---|
bounds optional |
סוג:
LatLngBounds|LatLngBoundsLiteral optional האזור שבו יש לחפש מקומות. |
componentRestrictions optional |
סוג:
ComponentRestrictions optional ההגבלות על הרכיבים. הגבלות על רכיבים משמשות להגבלת החיזויים רק לאלו שבתוך רכיב ההורה. למשל, המדינה. |
fields optional |
סוג:
Array<string> optional שדות שיש לכלול עבור המקום בתגובת הפרטים לאחר אחזור הפרטים בהצלחה, שיחויב עבורם. אם מועבר ['ALL'] , כל השדות הזמינים יוחזרו ויחויבו (לא מומלץ עבור פריסות של סביבת ייצור). לרשימת השדות יש לעיין ב-PlaceResult . אפשר לציין שדות מקוננים בנתיבי נקודות (לדוגמה, "geometry.location" ). ברירת המחדל היא ['ALL'] . |
|
סוג:
boolean optional האם לאחזר רק מזהי מקומות. תוצאת ה-Place_id שתהיה זמינה כשהאירוע place_ changed (שינוי המקום) מופעל יכללו רק את השדות Place_id, types ו-name, והם יוחזרו על ידי שירות ההשלמה האוטומטית. התכונה מושבתת כברירת מחדל. |
strictBounds optional |
סוג:
boolean optional ערך בוליאני, שמציין שהווידג'ט של ההשלמה האוטומטית צריך להחזיר רק את המקומות שנמצאים בגבולות הווידג'ט של ההשלמה האוטומטית בזמן שליחת השאילתה. אם מגדירים את StrictBounds כ- false (ברירת המחדל) תהיה הטיה של התוצאות למקומות שנכללים בגבולות, אך לא רק. |
types optional |
סוג:
Array<string> optional סוגי החיזויים שיש להחזיר. הסוגים הנתמכים מפורטים במדריך למפתחים. אם לא מציינים סוגים, כל הסוגים יוחזרו. |
סיווג של SearchBox
google.maps.places.SearchBox
סיווג
ווידג'ט שמספק חיזויי שאילתות על סמך קלט טקסט של משתמש. היא נצמדת לרכיב קלט מסוג 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) פרמטרים:
ערך החזרה: ללא
מגדיר את האזור לשימוש עבור הטיית חיזויים של שאילתות. התוצאות יטופלו רק לגבי האזור הזה ולא יוגבלו רק אליו. |
עברה בירושה:
addListener ,
bindTo ,
get ,
notify ,
set ,
setValues ,
unbind ,
unbindAll
|
אירועים | |
---|---|
places_changed |
function() ארגומנטים: ללא
האירוע הזה מופעל כשהמשתמש בוחר שאילתה, יש להשתמש ב- getPlaces כדי לקבל מקומות חדשים. |
ממשק SearchBoxOptions
ממשק google.maps.places.SearchBoxOptions
האפשרויות שאפשר להגדיר באובייקט SearchBox
.
תכונות | |
---|---|
bounds optional |
סוג:
LatLngBounds|LatLngBoundsLiteral optional האזור שאליו רוצים להטות חיזויים של שאילתות. התחזיות מתבססות על שאילתות שמטרגטות את הגבולות האלה, אבל לא רק על השאילתות האלה. |