Places Widgets

کلاس PlaceAutocompleteElement

google.maps.places . PlaceAutocompleteElement کلاس google.maps.places . PlaceAutocompleteElement

پیاده سازی AutocompleteView for Places API

این کلاس PlaceAutocompleteElementOptions را پیاده سازی می کند.

با فراخوانی const {PlaceAutocompleteElement} = await google.maps.importLibrary("places") دسترسی پیدا کنید. کتابخانه ها را در Maps JavaScript API ببینید.

PlaceAutocompleteElement
PlaceAutocompleteElement(options)
مولفه های:
element optional
نوع: HTMLElement | SVGElement optional
این فیلد فقط خواندنی است. عنصر DOM پشتوانه نما.
inputElement
عنصر ورودی برای نشان دادن تکمیل خودکار.
ارثی: componentRestrictions ، locationBias ، locationRestriction ، requestedLanguage ، requestedRegion ، types
addListener
addListener(eventName, handler)
مولفه های:
مقدار بازگشتی: MapsEventListener
تابع شنونده داده شده را به نام رویداد داده شده اضافه می کند.
gmp-placeselect
function(place)
استدلال ها:
این رویداد زمانی فعال می‌شود که کاربر پیش‌بینی مکان را انتخاب کند. یک شی مکان را برمی گرداند.
gmp-requesterror
function()
استدلال ها: هیچ
این رویداد زمانی فعال می شود که یک درخواست به backend رد شود (مثلاً کلید API نادرست). این رویداد حباب نمی کند.

رابط PlaceAutocompleteElementOptions

google.maps.places . PlaceAutocompleteElementOptions رابط google.maps.places . PlaceAutocompleteElementOptions

گزینه هایی برای ساخت PlaceAutocompleteElement.

inputElement
عنصر ورودی برای نشان دادن تکمیل خودکار.
componentRestrictions optional
نوع: ComponentRestrictions optional
محدودیت های مولفه محدودیت‌های مؤلفه برای محدود کردن پیش‌بینی‌ها فقط به آنهایی که در مؤلفه اصلی هستند استفاده می‌شوند. مثلا کشور.
element optional
نوع: HTMLElement | SVGElement optional
این فیلد فقط خواندنی است. عنصر DOM پشتوانه نما.
locationBias optional
نوع: LocationBias optional
یک مرز نرم یا اشاره برای استفاده در هنگام جستجوی مکان‌ها.
locationRestriction optional
نوع: LocationRestriction optional
محدودیت هایی برای محدود کردن نتایج جستجو.
requestedLanguage optional
نوع: string optional
در صورت امکان، یک شناسه زبان برای زبانی که نتایج باید به آن بازگردانده شوند. ممکن است به نتایج زبان انتخابی رتبه بالاتری داده شود، اما پیشنهادات محدود به این زبان نیست. لیست زبان های پشتیبانی شده را ببینید.
requestedRegion optional
نوع: string optional
یک کد منطقه ای که برای قالب بندی نتایج و برای فیلتر کردن نتایج استفاده می شود. این پیشنهادات را به این کشور محدود نمی کند. کد منطقه یک مقدار دو نویسه ccTLD ("دامنه سطح بالا") را می پذیرد. اکثر کدهای ccTLD با کدهای ISO 3166-1 یکسان هستند، با برخی استثناهای قابل توجه. به عنوان مثال، ccTLD بریتانیا "uk" ( .co.uk ) است در حالی که کد ISO 3166-1 آن "gb" است (از لحاظ فنی برای نهاد "پادشاهی متحده بریتانیای کبیر و ایرلند شمالی").
types optional
نوع: Array <string> optional
انواع پیش بینی هایی که باید برگردانده شوند. برای انواع پشتیبانی شده، به راهنمای برنامه نویس مراجعه کنید. اگر هیچ نوع مشخص نشده باشد، همه انواع برگردانده می شوند.

کلاس تکمیل خودکار

google.maps.places . Autocomplete کلاس 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()
پارامترها: ندارد
Return Value: PlaceResult مکان انتخاب شده توسط کاربر.
اگر جزئیات با موفقیت بازیابی شده باشد، جزئیات مکان انتخاب شده توسط کاربر را برمی گرداند. در غیر این صورت، یک شیء Stub Place را برمی‌گرداند، با ویژگی name که روی مقدار فعلی فیلد ورودی تنظیم شده است.
setBounds
setBounds(bounds)
مولفه های:
ارزش بازگشتی: ندارد
ناحیه ترجیحی را که در آن نتایج مکان را برگرداند، تنظیم می کند. نتایج نسبت به این حوزه تعصب دارند، اما محدود به آن نیستند.
setComponentRestrictions
setComponentRestrictions(restrictions)
مولفه های:
ارزش بازگشتی: ندارد
محدودیت های مؤلفه را تنظیم می کند. محدودیت‌های مؤلفه برای محدود کردن پیش‌بینی‌ها فقط به آنهایی که در مؤلفه اصلی هستند استفاده می‌شوند. مثلا کشور.
setFields
setFields(fields)
مولفه های:
  • fields : Array <string> optional
ارزش بازگشتی: ندارد
وقتی جزئیات با موفقیت بازیابی شدند، فیلدهایی را تنظیم می کند که برای مکان در پاسخ جزئیات اضافه شوند. برای فهرستی از فیلدها PlaceResult را ببینید.
setOptions
setOptions(options)
مولفه های:
ارزش بازگشتی: ندارد
setTypes
setTypes(types)
مولفه های:
  • types : Array <string> optional انواع پیش بینی هایی که باید گنجانده شوند.
ارزش بازگشتی: ندارد
انواع پیش بینی هایی را که باید برگردانده شوند را تنظیم می کند. برای انواع پشتیبانی شده، به راهنمای برنامه نویس مراجعه کنید. اگر هیچ نوع مشخص نشده باشد، همه انواع برگردانده می شوند.
به ارث رسیده: addListener ، bindTo ، get ، notify ، set ، setValues ، unbind ، unbindAll
place_changed
function()
استدلال ها: هیچ
این رویداد زمانی فعال می شود که یک PlaceResult برای مکانی که کاربر انتخاب کرده است در دسترس باشد.
اگر کاربر نام مکانی را وارد کند که توسط کنترل پیشنهاد نشده است و کلید Enter را فشار دهد، یا اگر درخواست Place Details ناموفق باشد، PlaceResult شامل ورودی کاربر در ویژگی name است، بدون اینکه ویژگی دیگری تعریف شده باشد.

رابط AutocompleteOptions

google.maps.places . 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'] است.
placeIdOnly optional placeIdOnly optional
نوع: boolean optional
اینکه آیا فقط شناسه‌های مکان بازیابی شود. PlaceResult که با فعال شدن رویداد place_changed در دسترس قرار می‌گیرد، فقط دارای فیلدهای place_id، انواع و نام است و مکان_id، انواع و توضیحات توسط سرویس تکمیل خودکار بازگردانده می‌شود. به طور پیش فرض غیرفعال است.
strictBounds optional
نوع: boolean optional
یک مقدار بولی که نشان می‌دهد ویجت تکمیل خودکار فقط باید آن مکان‌هایی را برگرداند که در زمان ارسال پرس و جو در داخل محدوده ویجت تکمیل خودکار قرار دارند. تنظیم strictBounds روی false (که پیش‌فرض است) باعث می‌شود نتایج به سمت مکان‌های موجود در محدوده‌ها، اما نه محدود به آن، سوگیری شوند.
types optional
نوع: Array <string> optional
انواع پیش بینی هایی که باید برگردانده شوند. برای انواع پشتیبانی شده، به راهنمای برنامه نویس مراجعه کنید. اگر هیچ نوع مشخص نشده باشد، همه انواع برگردانده می شوند.

google.maps.places . 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 رابط google.maps.places . SearchBoxOptions

گزینه هایی که می توان روی یک شی SearchBox تنظیم کرد.

bounds optional
نوع: LatLngBounds | LatLngBoundsLiteral optional
منطقه ای که پیش بینی های پرس و جو به سمت آن سوگیری می شود. پیش‌بینی‌ها به سمت پرسش‌هایی که این محدوده‌ها را هدف قرار می‌دهند، تعصب دارند، اما محدود به آن نیستند.