کلاس RouteMatrix
google.maps.routes.RouteMatrix
کلاس
ماتریسی از مسیرهای محاسبهشده برای مجموعهای از جفتهای مبدأ/مقصد توسط RouteMatrix.computeRouteMatrix
با تماس با const {RouteMatrix} = await google.maps.importLibrary("routes") دسترسی پیدا کنید.
کتابخانهها در Maps JavaScript API را ببینید.
روشهای ایستا | |
|---|---|
computeRouteMatrix |
computeRouteMatrix(request)پارامترها:
مقدار برگشتی:
Promise<{matrix:RouteMatrix}>فهرستی از مبدأها و مقصدها را دریافت میکند و ماتریسی حاوی اطلاعات مسیر برای هر ترکیب مبدأ و مقصد برمیگرداند. توجه: این روش مستلزم آن است که با تنظیم کردن ویژگی ComputeRouteMatrixRequest.fields، ماسک فیلد پاسخ را در درخواست مشخص کنید. مقدار، فهرستی از مسیرهای فیلد است. برای مثال:
استفاده از پوشش فیلد پاسخ عام fields: ['*'] توصیه نمیشود زیرا:
|
مشخصات | |
|---|---|
rows |
نوع:
Array<RouteMatrixRow>ردیفهای ماتریس. هر ردیف با یک مبدأ مطابقت دارد و حاوی آرایهای از RouteMatrixItem است که هرکدام نشاندهنده مسیری به مقصد است. |
روشها | |
|---|---|
toJSON |
toJSON()پارامترها: هیچ
مقدار برگشتی:
Objectبه شیء تبدیل میکند. |
کلاس RouteMatrixRow
google.maps.routes.RouteMatrixRow
کلاس
مطابق با مبدأی است که به RouteMatrix.computeRouteMatrix منتقل شده است. حاوی فهرستی از RouteMatrixItem است که هر مورد نشاندهنده مسیری به مقصد است.
با تماس با const {RouteMatrixRow} = await google.maps.importLibrary("routes") دسترسی پیدا کنید.
کتابخانهها در Maps JavaScript API را ببینید.
مشخصات | |
|---|---|
items |
نوع:
Array<RouteMatrixItem>اطلاعات مسیر برای هر مقصد. |
روشها | |
|---|---|
toJSON |
toJSON()پارامترها: هیچ
مقدار برگشتی:
Objectبه شیء تبدیل میکند. |
کلاس RouteMatrixItem
google.maps.routes.RouteMatrixItem
کلاس
حاوی اطلاعات مسیر محاسبهشده برای جفت مبدأ/مقصد ارسالشده به RouteMatrix.computeRouteMatrix است.
با تماس با const {RouteMatrixItem} = await google.maps.importLibrary("routes") دسترسی پیدا کنید.
کتابخانهها در Maps JavaScript API را ببینید.
مشخصات | |
|---|---|
condition |
نوع:
RouteMatrixItemCondition optionalنشان میدهد که مسیر پیدا شده است یا نه. |
distanceMeters |
نوع:
number optionalمسافت سفر مسیر به متر. |
durationMillis |
نوع:
number optionalمدت زمان لازم برای پیمایش مسیر برحسب میلیثانیه. اگر ComputeRouteMatrixRequest.routingPreference را روی TRAFFIC_UNAWARE تنظیم کنید، این مقدار با RouteMatrixItem.staticDurationMillis یکسان خواهد بود. اگر ComputeRouteMatrixRequest.routingPreference را روی TRAFFIC_AWARE یا TRAFFIC_AWARE_OPTIMAL تنظیم کنید، این مقدار با درنظر گرفتن شرایط ترافیک محاسبه میشود. توجه: اگر مدتزمان از ۲^۵۳ میلیثانیه بیشتر شود، این مقدار Number.POSITIVE_INFINITY است. |
error |
نوع:
RouteMatrixItemError optionalخطایی که درطول محاسبه مسیر رخ داده است. |
fallbackInfo |
نوع:
FallbackInfo optionalدر برخی موارد که سرور نمیتواند مسیر را با اولویتهای ارائهشده برای این جفت مبدأ/مقصد خاص محاسبه کند، ممکن است به استفاده از حالت محاسباتی دیگری برگردد. وقتی از بازگشت استفاده میشود، این فیلد حاوی اطلاعات دقیقی درباره پاسخ بازگشت است. درغیراینصورت، این فیلد تنظیم نشده است. |
localizedValues |
نوع:
RouteMatrixItemLocalizedValues optionalنمایشهای نوشتاری ویژگیهای RouteMatrixItem. |
staticDurationMillis |
نوع:
number optionalمدت زمان سفر در مسیر بدون درنظر گرفتن شرایط ترافیک. توجه: اگر مدتزمان از ۲^۵۳ میلیثانیه بیشتر شود، این مقدار Number.POSITIVE_INFINITY است. |
travelAdvisory |
نوع:
RouteTravelAdvisory optionalاطلاعات بیشتر درباره مسیر. |
روشها | |
|---|---|
toJSON |
toJSON()پارامترها: هیچ
مقدار برگشتی:
Objectبه شیء تبدیل میکند. |
میانای ComputeRouteMatrixRequest
میانا
google.maps.routes.ComputeRouteMatrixRequest
درخواست برای ماتریس مسیر.
مشخصات | |
|---|---|
destinations |
نوع:
Iterable<string|LatLng|LatLngLiteral|LatLngAltitudeLiteral|DirectionalLocationLiteral|Place|Waypoint>آرایه مقصدها که ستونهای ماتریس پاسخ را تعیین میکند. مقداری که بهعنوان رشته ارسال میشود میتواند نشانی، plus code، یا نام منبع «مکان» باشد. مقادیر ارتفاع درنظر گرفته نمیشود. |
fields |
نوع:
Iterable<string>مجموعه فیلدهایی که باید واکشی شوند. ["*"] را برای همه فیلدها مشخص کنید. |
origins |
نوع:
Iterable<string|LatLng|LatLngLiteral|LatLngAltitudeLiteral|DirectionalLocationLiteral|Place|RouteMatrixOrigin|Waypoint>آرایه مبدأها که ردیفهای ماتریس پاسخ را تعیین میکند. مقداری که بهعنوان رشته ارسال میشود میتواند نشانی، plus code، یا نام منبع «مکان» باشد. مقادیر ارتفاع درنظر گرفته نمیشود. چندین محدودیت اندازه برای کاردینالیته مبدأ و مقصد اعمال میشود:
|
arrivalTime optional |
نوع:
Date optionalزمان رسیدن. توجه: فقط زمانی میتوان تنظیم کرد که ComputeRouteMatrixRequest.travelMode روی TRANSIT تنظیم شده باشد. میتوانید ComputeRouteMatrixRequest.departureTime یا ComputeRouteMatrixRequest.arrivalTime را مشخص کنید، اما نه هر دو را. سفرهای حملونقل عمومی برای حداکثر ۷ روز گذشته یا ۱۰۰ روز آینده دردسترس است. |
departureTime optional |
نوع:
Date optionalزمان حرکت. اگر این مقدار را تنظیم نکنید، این مقدار بهطور پیشفرض روی زمانی که درخواست را ارسال کردهاید تنظیم میشود. توجه: فقط زمانی میتوانید زمان را در گذشته مشخص کنید که ComputeRouteMatrixRequest.travelMode روی TRANSIT تنظیم شده باشد. سفرهای حملونقل عمومی برای حداکثر ۷ روز گذشته یا ۱۰۰ روز آینده دردسترس است. |
extraComputations optional |
نوع:
Iterable<ComputeRouteMatrixExtraComputation> optionalفهرستی از محاسبات اضافی که ممکن است برای تکمیل درخواست استفاده شود. توجه: این محاسبات اضافی ممکن است فیلدهای اضافی را در پاسخ برگرداند. این فیلدهای اضافی باید در ComputeRouteMatrixRequest.fields نیز مشخص شوند تا در پاسخ برگردانده شوند. |
language optional |
نوع:
string optionalکد زبان BCP-47، مانند «en-US» یا «sr-Latn». برای اطلاعات بیشتر، شناسه محلی یونیکد را ببینید. برای مشاهده فهرست زبانهای پشتیبانیشده، به پشتیبانی زبان مراجعه کنید. وقتی این مقدار را ارائه نمیدهید، زبان از تنظیمات بومیسازی Google Maps JavaScript API شما استنباط میشود. درغیراینصورت، زبان از مکان اولین مبدأ استنباط میشود. |
region optional |
نوع:
string optionalکد منطقه، که بهعنوان مقدار دو نویسهای ccTLD («دامنه سطح بالا») مشخص شده است. برای اطلاعات بیشتر، دامنههای سطح بالای کد کشور را ببینید. وقتی این مقدار را ارائه نمیدهید، منطقه از تنظیمات بومیسازی Google Maps JavaScript API شما استنباط میشود. درغیراینصورت، منطقه از مکان مبدأ اول استنباط میشود. |
routingPreference optional |
نوع:
RoutingPreference optionalنحوه محاسبه ماتریس مسیر را مشخص میکند. سرور تلاش میکند از اولویت مسیریابی انتخابشده برای محاسبه ماتریس مسیر استفاده کند. اگر اولویت مسیریابی منجر به خطا یا تأخیر بسیار طولانی شود، خطا برگردانده میشود. این گزینه را فقط وقتی میتوانید مشخص کنید که ComputeRouteMatrixRequest.travelMode روی DRIVING یا TWO_WHEELER باشد، درغیراینصورت درخواست ناموفق خواهد بود. |
trafficModel optional |
نوع:
TrafficModel optionalفرضهای مورد استفاده هنگام محاسبه زمان در ترافیک را مشخص میکند. این تنظیم بر مقدار برگرداندهشده در RouteMatrixItem.durationMillis که حاوی زمان پیشبینیشده در ترافیک براساس میانگینهای تاریخی است تأثیر میگذارد. ComputeRouteMatrixRequest.trafficModel فقط برای درخواستهایی دردسترس است که ComputeRouteMatrixRequest.routingPreference را روی TRAFFIC_AWARE_OPTIMAL و ComputeRouteMatrixRequest.travelMode را روی DRIVING تنظیم کرده باشند. پیشفرضها به BEST_GUESS. |
transitPreference optional |
نوع:
TransitPreference optionalاولویتهایی را مشخص میکند که بر مسیر برگرداندهشده برای مسیرهای TRANSIT تأثیر میگذارد. توجه: فقط زمانی میتوان مشخص کرد که ComputeRouteMatrixRequest.travelMode روی TRANSIT تنظیم شده باشد. |
travelMode optional |
نوع:
TravelMode optionalحالت حملونقل را مشخص میکند. |
units optional |
نوع:
UnitSystem optionalواحدهای اندازهگیری را برای فیلدهای نمایش مشخص میکند. اگر این مقدار را ارائه نکنید، واحدهای نمایش از مکان اولین مبدأ استنباط میشود. |
ثابتهای ComputeRouteMatrixExtraComputation
google.maps.routes.ComputeRouteMatrixExtraComputation
یادآور همیشگی
محاسبات اضافی برای انجام درخواست RouteMatrix.computeRouteMatrix.
با تماس با const {ComputeRouteMatrixExtraComputation} = await google.maps.importLibrary("routes") دسترسی پیدا کنید.
کتابخانهها در Maps JavaScript API را ببینید.
ثابتها | |
|---|---|
TOLLS |
اطلاعات عوارض برای مورد(های) ماتریس. |
ثابتهای RouteMatrixItemCondition
google.maps.routes.RouteMatrixItemCondition
یادآور همیشگی
وضعیت مسیر برای جفت مبدأ/مقصد مشخص.
با تماس با const {RouteMatrixItemCondition} = await google.maps.importLibrary("routes") دسترسی پیدا کنید.
کتابخانهها در Maps JavaScript API را ببینید.
ثابتها | |
|---|---|
ROUTE_EXISTS |
مسیری پیدا شد. |
ROUTE_NOT_FOUND |
مسیری پیدا نشد. |
کلاس RouteMatrixItemError
google.maps.routes.RouteMatrixItemError
کلاس
خطایی که درطول RouteMatrix.computeRouteMatrix برای جفت مبدأ/مقصد خاصی رخ داده است.
این کلاس
Error را گسترش میدهد.
با تماس با const {RouteMatrixItemError} = await google.maps.importLibrary("routes") دسترسی پیدا کنید.
کتابخانهها در Maps JavaScript API را ببینید.
روشها | |
|---|---|
toJSON |
toJSON()پارامترها: هیچ
مقدار برگشتی:
Objectبه شیء تبدیل میکند. |
RouteMatrixItemLocalizedValues کلاس
google.maps.routes.RouteMatrixItemLocalizedValues
کلاس
نمایش نوشتاری RouteMatrixItem.
با تماس با const {RouteMatrixItemLocalizedValues} = await google.maps.importLibrary("routes") دسترسی پیدا کنید.
کتابخانهها در Maps JavaScript API را ببینید.
مشخصات | |
|---|---|
distance |
نوع:
string optionalمسافت سفر مورد ماتریس مسیر بهصورت نوشتاری. |
distanceLanguage |
نوع:
string optionalکد زبان BCP-47 نوشتار فاصله، مانند «en-US» یا «sr-Latn». برای اطلاعات بیشتر، به http://www.unicode.org/reports/tr35/#Unicode_locale_identifier مراجعه کنید. |
duration |
نوع:
string optionalمدت، بهصورت نوشتاری و بومیسازیشده برای منطقه پُرسمان نشان داده میشود. شرایط ترافیک را درنظر میگیرد. توجه: اگر اطلاعات ترافیک را درخواست نکرده باشید، این مقدار همان مقدار RouteMatrixItemLocalizedValues.staticDuration است. |
durationLanguage |
نوع:
string optionalکد زبان BCP-47 نوشتار مدت، مانند «en-US» یا «sr-Latn». برای اطلاعات بیشتر، به http://www.unicode.org/reports/tr35/#Unicode_locale_identifier مراجعه کنید. |
staticDuration |
نوع:
string optionalمدتزمان بدون درنظر گرفتن شرایط ترافیک، که بهصورت نوشتاری نشان داده میشود. |
staticDurationLanguage |
نوع:
string optionalکد زبان BCP-47 نوشتار مدتزمان ایستا، مانند «en-US» یا «sr-Latn». |
transitFare |
نوع:
string optionalکرایه حملونقل عمومی، بهصورت نوشتاری نشان داده میشود. |
transitFareLanguage |
نوع:
string optionalکد زبان BCP-47 نوشتار کرایه حملونقل عمومی، مثل «en-US» یا «sr-Latn». برای اطلاعات بیشتر، به http://www.unicode.org/reports/tr35/#Unicode_locale_identifier مراجعه کنید. |
روشها | |
|---|---|
toJSON |
toJSON()پارامترها: هیچ
مقدار برگشتی:
Objectبه شیء تبدیل میکند. |
میانای RouteMatrixOrigin
میانا
google.maps.routes.RouteMatrixOrigin
یک مبدأ برای ComputeRouteMatrixRequest.
مشخصات | |
|---|---|
waypoint |
مکان مبدأ. مقداری که بهعنوان رشته ارسال میشود ممکن است نشانی یا plus code باشد. مقادیر ارتفاع برای درنظر گرفته نمیشود. |
routeModifiers optional |
نوع:
RouteModifiers optionalاصلاحکنندهها برای هر مسیری که این را بهعنوان مبدأ درنظر میگیرد. |