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