کلاس PlaceAutocompleteElement
google.maps.places . PlaceAutocompleteElement
کلاس google.maps.places . PlaceAutocompleteElement
PlaceAutocompleteElement یک زیر کلاس HTMLElement
است که یک مؤلفه UI برای Places Autocomplete API فراهم می کند.
PlaceAutocompleteElement به طور خودکار از AutocompleteSessionToken
به صورت داخلی برای گروه بندی مراحل پرس و جو و انتخاب جستجوی تکمیل خودکار کاربر استفاده می کند.
اولین تماس با Place.fetchFields
در یک Place
که توسط PlacePrediction.toPlace
برگردانده شده است به طور خودکار شامل نشانه جلسه مورد استفاده برای واکشی PlacePrediction
می شود.
برای جزئیات بیشتر در مورد نحوه عملکرد جلسات، https://developers.google.com/maps/documentation/places/web-service/place-session-tokens را ببینید.
عنصر سفارشی:
<gmp-place-autocomplete included-primary-types="type1 type2 type3..." included-region-codes="c1 c2 c3..." name="string" origin="lat,lng" requested-language="string" requested-region="string" unit-system="metric"></gmp-place-autocomplete>
این کلاس HTMLElement
را گسترش می دهد.
این کلاس PlaceAutocompleteElementOptions
پیاده سازی می کند.
با فراخوانی const {PlaceAutocompleteElement} = await google.maps.importLibrary("places")
دسترسی پیدا کنید.
کتابخانه ها را در Maps JavaScript API ببینید.
سازنده | |
---|---|
PlaceAutocompleteElement | PlaceAutocompleteElement(options) پارامترها:
|
خواص | |
---|---|
includedPrimaryTypes | نوع: Array <string> optional شامل نوع مکان اصلی (به عنوان مثال، "رستوران" یا "پمپ بنزین"). یک مکان تنها در صورتی برگردانده می شود که نوع اصلی آن در این لیست گنجانده شده باشد. حداکثر 5 مقدار قابل تعیین است. اگر هیچ نوع مشخصی وجود نداشته باشد، همه انواع Place برگردانده می شوند. ویژگی HTML:
|
includedRegionCodes | نوع: Array <string> optional فقط شامل نتایج در مناطق مشخص شده، مشخص شده به عنوان حداکثر 15 کد منطقه دو نویسه CLDR. مجموعه خالی نتایج را محدود نمی کند. اگر هر دو locationRestriction و includedRegionCodes تنظیم شده باشند، نتایج در ناحیه تقاطع قرار خواهند گرفت. ویژگی HTML:
|
locationBias | نوع: LocationBias optional یک مرز نرم یا اشاره برای استفاده در هنگام جستجوی مکانها. |
locationRestriction | نوع: LocationRestriction optional محدودیت هایی برای محدود کردن نتایج جستجو. |
name | نوع: string optional نامی که برای عنصر ورودی استفاده می شود. برای جزئیات به https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name مراجعه کنید. رفتاری مشابه با ویژگی name برای ورودی ها دنبال می کند. توجه داشته باشید که این نامی است که هنگام ارسال فرم استفاده می شود. برای جزئیات بیشتر به https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form مراجعه کنید. ویژگی HTML:
|
origin | نوع: LatLng | LatLngLiteral | LatLngAltitude | LatLngAltitudeLiteral optional مبدأ محاسبه فاصله. در صورت عدم تعیین فاصله محاسبه نمی شود. ارتفاع، اگر داده شود، در محاسبه استفاده نمی شود. ویژگی HTML:
|
requestedLanguage | نوع: string optional در صورت امکان، یک شناسه زبان برای زبانی که نتایج باید به آن بازگردانده شوند. ممکن است به نتایج زبان انتخابی رتبه بالاتری داده شود، اما پیشنهادات محدود به این زبان نیست. لیست زبان های پشتیبانی شده را ببینید. ویژگی HTML:
|
requestedRegion | نوع: string optional یک کد منطقه ای که برای قالب بندی نتایج و برای فیلتر کردن نتایج استفاده می شود. این پیشنهادات را به این کشور محدود نمی کند. کد منطقه یک مقدار دو نویسه ccTLD ("دامنه سطح بالا") را می پذیرد. اکثر کدهای ccTLD با کدهای ISO 3166-1 یکسان هستند، با برخی استثناهای قابل توجه. به عنوان مثال، ccTLD بریتانیا "uk" ( .co.uk ) است در حالی که کد ISO 3166-1 آن "gb" است (از لحاظ فنی برای نهاد "پادشاهی متحده بریتانیای کبیر و ایرلند شمالی"). ویژگی HTML:
|
unitSystem | نوع: UnitSystem optional سیستم واحدی که برای نمایش فواصل استفاده می شود. اگر مشخص نشده باشد، سیستم واحد توسط requestedRegion تعیین می شود. ویژگی HTML:
|
قطعات | |
---|---|
prediction-item | موردی در فهرست کشویی پیش بینی ها که نشان دهنده یک پیش بینی واحد است. |
prediction-item-icon | نمادی که در سمت چپ هر مورد در لیست پیش بینی ها نمایش داده می شود. |
prediction-item-main-text | بخشی از پیش بینی - آیتم که متن اصلی پیش بینی است. برای مکانهای جغرافیایی، این شامل نام مکانی، مانند «سیدنی» یا نام و شماره خیابان، مانند «خیابان 10 کینگ» است. به طور پیشفرض، پیشبینی آیتم-متن-متن سیاه رنگ است. اگر متن اضافی در پیشبینی آیتم وجود داشته باشد، خارج از پیشبینی-آیتم-متن-اصلی است و سبک خود را از پیشبینی-آیتم به ارث میبرد. به طور پیش فرض خاکستری رنگ است. متن اضافی معمولاً یک آدرس است. |
prediction-item-match | بخشی از پیش بینی برگشتی که با ورودی کاربر مطابقت دارد. به طور پیش فرض، این متن مطابق با متن پررنگ برجسته می شود. توجه داشته باشید که متن تطبیق داده شده ممکن است در هر نقطه ای از پیش بینی مورد باشد. لزوماً بخشی از پیشبینی-متن-متن-اصلی نیست. |
prediction-item-selected | موردی که کاربر از طریق صفحه کلید به آن می رود. توجه: آیتم های انتخاب شده هم تحت تاثیر سبک های این قسمت و هم سبک های قسمت پیش بینی-آیتم قرار می گیرند. |
prediction-list | عنصر بصری حاوی لیستی از پیش بینی های ارائه شده توسط سرویس تکمیل خودکار مکان. این لیست به عنوان یک لیست کشویی در زیر PlaceAutocompleteElement ظاهر می شود. |
روش ها | |
---|---|
| addEventListener(type, listener[, options]) پارامترها:
مقدار برگشتی: void تابعی را تنظیم می کند که هر زمان که رویداد مشخص شده به هدف تحویل داده شود فراخوانی می شود. به addEventListener مراجعه کنید. |
| removeEventListener(type, listener[, options]) پارامترها:
مقدار برگشتی: void شنونده رویدادی که قبلاً با addEventListener ثبت شده بود را از هدف حذف می کند. removeEventListener را ببینید. |
رویدادها | |
---|---|
gmp-error | function(errorEvent) استدلال ها:
این رویداد زمانی فعال می شود که یک درخواست به backend رد شود (مثلاً کلید API نادرست). این رویداد حباب نمی کند. |
gmp-select | function(placePredictionSelectEvent) استدلال ها:
این رویداد زمانی فعال میشود که کاربر پیشبینی مکان را انتخاب کند. شامل یک شی PlacePrediction است که می تواند به یک شی Place تبدیل شود. |
رابط PlaceAutocompleteElementOptions
google.maps.places . PlaceAutocompleteElementOptions
رابط google.maps.places . PlaceAutocompleteElementOptions
گزینه هایی برای ساخت PlaceAutocompleteElement. برای توضیح هر ویژگی، به ویژگی همنام در کلاس PlaceAutocompleteElement مراجعه کنید.
خواص | |
---|---|
locationBias optional | نوع: LocationBias optional |
locationRestriction optional | نوع: LocationRestriction optional |
name optional | نوع: string optional |
requestedLanguage optional | نوع: string optional |
کلاس PlacePredictionSelectEvent
google.maps.places . PlacePredictionSelectEvent
کلاس google.maps.places . PlacePredictionSelectEvent
این رویداد پس از انتخاب یک مورد پیش بینی توسط کاربر با PlaceAutocompleteElement ایجاد می شود. با event.placePrediction
به انتخاب دسترسی پیدا کنید.
با فراخوانی PlacePrediction.toPlace
placePrediction را به یک Place
تبدیل کنید.
این کلاس Event
را گسترش می دهد.
با فراخوانی const {PlacePredictionSelectEvent} = await google.maps.importLibrary("places")
دسترسی پیدا کنید.
کتابخانه ها را در Maps JavaScript API ببینید.
خواص | |
---|---|
placePrediction | نوع: PlacePrediction با فراخوانی PlacePrediction.toPlace آن را به یک Place تبدیل کنید. |
کلاس PlaceAutocompleteRequestErrorEvent
google.maps.places . PlaceAutocompleteRequestErrorEvent
کلاس google.maps.places . PlaceAutocompleteRequestErrorEvent
این رویداد توسط PlaceAutocompleteElement زمانی که مشکلی در درخواست شبکه وجود دارد منتشر می شود.
این کلاس Event
را گسترش می دهد.
با فراخوانی const {PlaceAutocompleteRequestErrorEvent} = await google.maps.importLibrary("places")
دسترسی پیدا کنید.
کتابخانه ها را در Maps JavaScript API ببینید.
کلاس PlaceContextualElement
google.maps.places . PlaceContextualElement
کلاس google.maps.places . PlaceContextualElement
ویجتی که از نشانه زمینه برای نمایش نمای متنی پاسخ Grounding با Google Maps استفاده می کند.
عنصر سفارشی:
<gmp-place-contextual context-token="string"></gmp-place-contextual>
این کلاس HTMLElement
را گسترش می دهد.
این کلاس PlaceContextualElementOptions
پیاده سازی می کند.
با فراخوانی const {PlaceContextualElement} = await google.maps.importLibrary("places")
دسترسی پیدا کنید.
کتابخانه ها را در Maps JavaScript API ببینید.
خواص | |
---|---|
contextToken | نوع: string optional نشانه زمینه. ویژگی HTML:
|
روش ها | |
---|---|
| addEventListener(type, listener[, options]) پارامترها:
مقدار برگشتی: void تابعی را تنظیم می کند که هر زمان که رویداد مشخص شده به هدف تحویل داده شود فراخوانی می شود. به addEventListener مراجعه کنید. |
| removeEventListener(type, listener[, options]) پارامترها:
مقدار برگشتی: void شنونده رویدادی که قبلاً با addEventListener ثبت شده بود را از هدف حذف می کند. removeEventListener را ببینید. |
رابط PlaceContextualElementOptions
google.maps.places . PlaceContextualElementOptions
رابط google.maps.places . PlaceContextualElementOptions
گزینههای PlaceContextualElement
.
خواص | |
---|---|
|