הכיתה 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:
|
requestedLanguage |
סוג:
string optional מזהה שפה של השפה שבה צריך להציג את התוצאות, אם אפשר. יכול להיות שתוצאות בשפה שנבחרה יקבלו דירוג גבוה יותר, אבל ההצעות לא מוגבלות לשפה הזו. כאן אפשר לעיין ברשימת השפות הנתמכות.
מאפיין HTML:
|
requestedRegion |
סוג:
string optional קוד אזור שמשמש לעיצוב התוצאות ולסינון התוצאות. היא לא מגבילה את ההצעות למדינה הזו. קוד האזור יכול להכיל ערך בן שני תווים של דומיין ברמה עליונה עם קוד מדינה (ccTLD). רוב הקודים של הדומיינים ברמה הלאומית זהים לקודי ISO 3166-1, מלבד כמה יוצאים מן הכלל. לדוגמה, הדומיין ברמה העליונה של בריטניה הוא 'uk' (
.co.uk ), ואילו הקוד שלה ב-ISO 3166-1 הוא 'gb' (טכנית, עבור הישות 'ממלכת בריטניה הגדולה וצפון אירלנד').מאפיין HTML:
|
types |
סוג:
Array<string> optional סוגי התחזיות שיוחזרו. ב מדריך למפתחים מפורטת רשימת הסוגים הנתמכים. אם לא מציינים סוגי פריטים, כל הסוגים יוחזרו.
מאפיין HTML:
|
חלקים | |
---|---|
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. |
Methods | |
---|---|
addEventListener |
addEventListener(type, listener[, options]) פרמטרים:
ערך המוחזר:
void הגדרת פונקציה שתופעל בכל פעם שהאירוע שצוין יועבר ליעד. ראו addEventListener |
removeEventListener |
removeEventListener(type, listener[, options]) פרמטרים:
ערך המוחזר:
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 הצגה של PlaceAutocompleteElement.types |
הכיתה PlaceAutocompletePlaceSelectEvent
google.maps.places.PlaceAutocompletePlaceSelectEvent
class
האירוע הזה נוצר אחרי שהמשתמש בוחר מקום באמצעות הרכיב 'השלמה אוטומטית למקומות'. ניגשים לבחירה באמצעות event.place
.
הכיתה הזו היא תת-מחלקה של Event
.
אפשר לגשת אליו באמצעות חיוג למספר const {PlaceAutocompletePlaceSelectEvent} = await google.maps.importLibrary("places")
. ספריות ב-Maps JavaScript API
מאפיינים | |
---|---|
place |
סוג:
Place |
הכיתה PlaceAutocompleteRequestErrorEvent
google.maps.places.PlaceAutocompleteRequestErrorEvent
class
האירוע הזה נפלט על ידי PlaceAutocompleteElement כשיש בעיה בבקשת הרשת.
הכיתה הזו היא תת-מחלקה של Event
.
אפשר לגשת אליו באמצעות חיוג למספר const {PlaceAutocompleteRequestErrorEvent} = await google.maps.importLibrary("places")
. ספריות ב-Maps JavaScript API
הכיתה PlaceDetailsElement
google.maps.places.PlaceDetailsElement
class
רכיב HTML שמוצגים בו פרטים על מקום מסוים. משתמשים בשיטות configureFromPlace()
או configureFromLocation()
כדי לציין את התוכן שרוצים להציג. כדי להשתמש ברכיב פרטי המקום, צריך להפעיל את Places UI Kit API בפרויקט במסוף Google Cloud.
רכיב מותאם אישית:
<gmp-place-details size="small"></gmp-place-details>
הכיתה הזו היא תת-מחלקה של HTMLElement
.
המחלקה הזו מטמיעה את PlaceDetailsElementOptions
.
אפשר לגשת אליו באמצעות חיוג למספר const {PlaceDetailsElement} = await google.maps.importLibrary("places")
. ספריות ב-Maps JavaScript API
יצרן | |
---|---|
PlaceDetailsElement |
PlaceDetailsElement([options]) פרמטרים:
|
מאפיינים | |
---|---|
place |
סוג:
Place optional קריאה בלבד. אובייקט Place שמכיל את המזהה, המיקום והתצוגה הווירטואלית של המקום שמוצג כרגע. |
size |
סוג:
PlaceDetailsSize optional וריאנט הגודל של PlaceDetailsElement. כברירת מחדל, האלמנט יציג את הערך
PlaceDetailsSize.X_LARGE .מאפיין HTML:
|
Methods | |
---|---|
addEventListener |
addEventListener(type, listener[, options]) פרמטרים:
ערך המוחזר:
void הגדרת פונקציה שתופעל בכל פעם שהאירוע שצוין יועבר ליעד. ראו addEventListener |
configureFromLocation |
configureFromLocation(location) פרמטרים:
ערך המחזרה:
Promise<void> הבטחה (promise) שמתבצעת אחרי טעינת הנתונים של המקום והצגתם.הגדרת הווידג'ט מ- LatLng באמצעות גיאוקוד הפוכה. |
configureFromPlace |
configureFromPlace(place) פרמטרים:
ערך המובהק:
Promise<void> הבטחה (promise) שמתבצעת אחרי טעינת הנתונים של המקום והצגתם.הגדרת הווידג'ט באמצעות אובייקט Place או מזהה מקום. |
removeEventListener |
removeEventListener(type, listener[, options]) פרמטרים:
ערך המוחזר:
void הסרת רכיב מעקב אירועים שרשום קודם לכן באמצעות addEventListener מהיעד. מידע נוסף זמין במאמר removeEventListener |
אירועים | |
---|---|
gmp-load |
function(event) ארגומנטים:
האירוע הזה מופעל כשהרכיב נטען והתוכן שלו מוצג. האירוע הזה לא עובר 'העברה חזרה'. |
gmp-requesterror |
function(event) ארגומנטים:
האירוע הזה מופעל כשבקשה לקצה העורפי נדחתה (למשל, מפתח API שגוי). האירוע הזה לא עובר 'העברה חזרה'. |
הממשק PlaceDetailsElementOptions
ממשק google.maps.places.PlaceDetailsElementOptions
האפשרויות לגבי PlaceDetailsElement
.
מאפיינים | |
---|---|
size optional |
סוג:
PlaceDetailsSize optional הצגה של PlaceDetailsElement.size |
המשתנים הקבועים של PlaceDetailsSize
google.maps.places.PlaceDetailsSize
קבועים
וריאציות של גדלים עבור PlaceDetailsElement
.
אפשר לגשת אליו באמצעות חיוג למספר const {PlaceDetailsSize} = await google.maps.importLibrary("places")
. ספריות ב-Maps JavaScript API
קבועים | |
---|---|
LARGE |
וריאנט גדול שכולל תמונה גדולה, מידע בסיסי ופרטים ליצירת קשר. |
MEDIUM |
וריאנט בינוני שכולל תמונה גדולה ומידע בסיסי. |
SMALL |
וריאנט קטן שכולל תמונה קטנה ומידע בסיסי. |
X_LARGE |
גרסה גדולה במיוחד שכוללת קולאז' של תמונות, ביקורות ומידע מקיף על המקום. |
הכיתה PlaceListElement
google.maps.places.PlaceListElement
class
רכיב HTML שמוצגות בו תוצאות החיפוש של המקומות ברשימה. משתמשים בשיטות configureFromSearchByTextRequest()
או configureFromSearchNearbyRequest()
כדי לציין את הבקשה שעבורה רוצים להציג את התוצאות. כדי להשתמש ברכיב של רשימת מקומות, צריך להפעיל את Places UI Kit API בפרויקט במסוף Google Cloud.
רכיב מותאם אישית:
<gmp-place-list selectable></gmp-place-list>
הכיתה הזו היא תת-מחלקה של HTMLElement
.
המחלקה הזו מטמיעה את PlaceListElementOptions
.
אפשר לגשת אליו באמצעות חיוג למספר const {PlaceListElement} = await google.maps.importLibrary("places")
. ספריות ב-Maps JavaScript API
יצרן | |
---|---|
PlaceListElement |
PlaceListElement([options]) פרמטרים:
|
מאפיינים | |
---|---|
places |
קריאה בלבד. מערך של אובייקטים מסוג Place שמכיל את המזהים, המיקומים והתצוגות הדו-ממדיות של המקומות שמוצגים כרגע. |
selectable |
סוג:
boolean אם אפשר לבחור את הפריטים ברשימה או לא. אם הערך הוא true, פריטים ברשימה יהיו לחצנים ששולחים את האירוע
gmp-placeselect כשלוחצים עליהם. יש גם תמיכה בניווט ובבחירה במקלדת נגישה.מאפיין HTML:
|
Methods | |
---|---|
addEventListener |
addEventListener(type, listener[, options]) פרמטרים:
ערך המוחזר:
void הגדרת פונקציה שתופעל בכל פעם שהאירוע שצוין יועבר ליעד. ראו addEventListener |
configureFromSearchByTextRequest |
configureFromSearchByTextRequest(request) פרמטרים:
ערך המובהק:
Promise<void> הבטחה (promise) שמתבצעת אחרי טעינת הנתונים של המקום והצגתם.הגדרת הווידג'ט להצגת תוצאות חיפוש מבקשת API לחיפוש טקסט של מקומות. |
configureFromSearchNearbyRequest |
configureFromSearchNearbyRequest(request) פרמטרים:
ערך המובהק:
Promise<void> הבטחה (promise) שמתבצעת אחרי טעינת הנתונים של המקום והצגתם.הגדרת הווידג'ט להצגת תוצאות חיפוש מבקשה של Places Nearby Search API. |
removeEventListener |
removeEventListener(type, listener[, options]) פרמטרים:
ערך המוחזר:
void הסרת רכיב מעקב אירועים שרשום קודם לכן באמצעות addEventListener מהיעד. מידע נוסף זמין במאמר removeEventListener |
אירועים | |
---|---|
gmp-load |
function(event) ארגומנטים:
האירוע הזה מופעל כשהרכיב נטען והתוכן שלו מוצג. האירוע הזה לא עובר 'העברה חזרה'. |
gmp-placeselect |
function(event) ארגומנטים:
האירוע הזה מופעל כשמשתמש בוחר מקום. מכיל אובייקט Place ואת האינדקס של המקום שנבחר ברשימה. |
gmp-requesterror |
function(event) ארגומנטים:
האירוע הזה מופעל כשבקשה לקצה העורפי נדחתה (למשל, מפתח API שגוי). האירוע הזה לא עובר 'העברה חזרה'. |
הממשק PlaceListElementOptions
ממשק google.maps.places.PlaceListElementOptions
האפשרויות לגבי PlaceListElement
.
מאפיינים | |
---|---|
selectable optional |
סוג:
boolean optional הצגה של PlaceListElement.selectable |
הכיתה PlaceListPlaceSelectEvent
google.maps.places.PlaceListPlaceSelectEvent
class
האירוע הזה נפלט על ידי PlaceListElement
כשהמשתמש בוחר מקום.
הכיתה הזו היא תת-מחלקה של Event
.
אפשר לגשת אליו באמצעות חיוג למספר const {PlaceListPlaceSelectEvent} = await google.maps.importLibrary("places")
. ספריות ב-Maps JavaScript API
מאפיינים | |
---|---|
index |
סוג:
number האינדקס של המקום שנבחר ברשימה. |
place |
סוג:
Place אובייקט Place שמכיל את המזהה, המיקום והתצוגה הווירטואלית של המקום שנבחר. |
הכיתה Autocomplete
google.maps.places.Autocomplete
class
ווידג'ט שמציג תחזיות של מקומות על סמך הקלט הטקסט של המשתמש. הוא מצורף לרכיב קלט מסוג text
ומקשיב להזנת טקסט בשדה הזה. רשימת התחזיות מוצגת כרשימה נפתחת, והיא מתעדכנת כשמוסיפים טקסט.
הכיתה הזו היא תת-מחלקה של MVCObject
.
אפשר לגשת אליו באמצעות חיוג למספר const {Autocomplete} = await google.maps.importLibrary("places")
. ספריות ב-Maps JavaScript API
יצרן | |
---|---|
Autocomplete |
Autocomplete(inputField[, opts]) פרמטרים:
יצירת מכונה חדשה של Autocomplete שמצורפת לשדה הטקסט של הקלט שצוין עם האפשרויות הנתונות. |
Methods | |
---|---|
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) פרמטרים:
ערך המוחזר: None
מגדיר את השדות שכלולים במקום בתשובה עם הפרטים, כשהפרטים מאוחזרים בהצלחה. רשימה של שדות מופיעה במאמר PlaceResult . |
setOptions |
setOptions(options) פרמטרים:
ערך המוחזר: None
|
setTypes |
setTypes(types) פרמטרים:
ערך המוחזר: 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 |
סוג:
LatLngBounds|LatLngBoundsLiteral optional האזור שבו רוצים לחפש מקומות. |
componentRestrictions optional |
סוג:
ComponentRestrictions optional ההגבלות על הרכיבים. הגבלות על רכיבים משמשות להגבלת התחזיות רק לאלה שנמצאות ברכיב ההורה. למשל, המדינה. |
fields optional |
סוג:
Array<string> optional השדות שצריך לכלול עבור המקום בתגובה עם הפרטים, כשהפרטים אוחזרים בהצלחה, ועליהם יתבצע החיוב. אם מעבירים את הערך ['ALL'] , כל השדות הזמינים יחזרו ויחויבו (לא מומלץ לפריסות ייצור). רשימה של שדות מופיעה במאמר PlaceResult . אפשר לציין שדות בתצוגת עץ באמצעות נתיבים עם נקודות (לדוגמה, "geometry.location" ). ברירת המחדל היא ['ALL'] . |
|
סוג:
boolean optional אם לאחזר רק מזהי מקומות. ב-PlaceResult שזמין כשהאירוע place_changed מופעל יופיעו רק השדות place_id, types ו-name, עם place_id, types ו-description שהוחזרו על ידי שירות ההשלמה האוטומטית. מושבתת כברירת מחדל. |
strictBounds optional |
סוג:
boolean optional ערך בוליאני שמציין שווידג'ט ההשלמה האוטומטית צריך להציג רק את המקומות שנמצאים בתוך גבולות הווידג'ט של ההשלמה האוטומטית בזמן שליחת השאילתה. הגדרת strictBounds לערך false (ברירת המחדל) תגרום להטיה של התוצאות לכיוון מקומות שנמצאים בתוך הגבולות, אבל לא רק אליהם. |
types optional |
סוג:
Array<string> optional סוגי התחזיות שיוחזרו. ב מדריך למפתחים מפורטת רשימת הסוגים הנתמכים. אם לא מציינים סוגי פריטים, כל הסוגים יוחזרו. |
הכיתה SearchBox
google.maps.places.SearchBox
class
ווידג'ט שמספק חיזויים של שאילתות על סמך הקלט הטקסט של המשתמש. הוא מצורף לרכיב קלט מסוג text
ומקשיב להזנת טקסט בשדה הזה. רשימת התחזיות מוצגת כרשימה נפתחת, והיא מתעדכנת כשמוסיפים טקסט.
הכיתה הזו היא תת-מחלקה של MVCObject
.
אפשר לגשת אליו באמצעות חיוג למספר const {SearchBox} = await google.maps.importLibrary("places")
. ספריות ב-Maps JavaScript API
יצרן | |
---|---|
SearchBox |
SearchBox(inputField[, opts]) פרמטרים:
יצירת מכונה חדשה של SearchBox שמצורפת לשדה הטקסט של הקלט שצוין עם האפשרויות הנתונות. |
Methods | |
---|---|
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 |
סוג:
LatLngBounds|LatLngBoundsLiteral optional האזור שאליו רוצים להטות את התחזיות של השאילתות. התחזיות מוטה לשאילתות שמטרגטות את הגבולות האלה, אבל לא מוגבלת אליהן. |