کلاس DistanceMatrixService
google.maps.DistanceMatrixService
کلاس
کتابخانه "routes"
const {DistanceMatrixService} = await google.maps.importLibrary("routes");
سازنده | |
|---|---|
DistanceMatrixService |
DistanceMatrixService()پارامترها: هیچ
نمونه جدیدی از DistanceMatrixService ایجاد میکند که پُرسمانهای ماتریس فاصله را به سرورهای Google ارسال میکند. |
روشها | |
|---|---|
getDistanceMatrix |
getDistanceMatrix(request[, callback])پارامترها:
مقدار برگشتی:
Promise<DistanceMatrixResponse>درخواست ماتریس فاصله صادر میکند. |
میانای DistanceMatrixRequest
میانا
google.maps.DistanceMatrixRequest
یک پُرسمان ماتریس فاصله که توسط DistanceMatrixService ارسال شده است و حاوی آرایههایی از مکانهای مبدأ و مقصد و گزینههای مختلف برای محاسبه سنجهها است.
مشخصات | |
|---|---|
destinations |
نوع:
Array<string|LatLng|LatLngLiteral|Place>آرایهای حاوی رشتههای نشانی مقصد، یا اشیای LatLng، یا Place، که فاصله و زمان تا آنها محاسبه میشود. الزامی. |
origins |
نوع:
Array<string|LatLng|LatLngLiteral|Place>آرایهای حاوی رشتههای نشانی مبدأ، یا اشیای LatLng، یا Place، که فاصله و زمان از آنها محاسبه میشود. الزامی. |
travelMode |
نوع:
TravelModeنوع مسیریابی درخواستشده. الزامی. |
avoidFerries
اختیاری |
نوع:
boolean optionalاگر true، به سرویس Distance Matrix دستور میدهد تا حد امکان از کشتیها اجتناب کند. اختیاری. |
avoidHighways
اختیاری |
نوع:
boolean optionalاگر true، به سرویس Distance Matrix دستور میدهد تا حد امکان از بزرگراهها اجتناب کند. اختیاری. |
avoidTolls
اختیاری |
نوع:
boolean optionalاگر true، به سرویس Distance Matrix دستور میدهد تا حد امکان از جادههای عوارضی اجتناب کند. اختیاری. |
drivingOptions
اختیاری |
نوع:
DrivingOptions optionalتنظیماتی که فقط برای درخواستهایی اعمال میشود که travelMode در آنها DRIVING است. این شیء تأثیری بر دیگر حالتهای سفر نخواهد داشت. |
language
اختیاری |
نوع:
string optionalشناسه زبان برای زبانی که نتایج باید به آن برگردانده شود (درصورت امکان). فهرست زبانهای پشتیبانیشده را ببینید. |
region
اختیاری |
نوع:
string optionalکد منطقه که بهعنوان سوگیری برای درخواستهای زمینکدیابی استفاده میشود. کد منطقه مقدار دو نویسهای ccTLD («دامنه سطح بالا») را میپذیرد. اکثر کدهای ccTLD با کدهای ISO 3166-1 یکسان هستند، با چند استثنای قابلتوجه. برای مثال، دامنه سطح بالای کد کشوری پادشاهی متحد «uk» ( .co.uk) است، درحالیکه کد ISO 3166-1 آن «gb» است (که ازنظر فنی برای نهاد «پادشاهی متحد بریتانیای کبیر و ایرلند شمالی» است). |
transitOptions
اختیاری |
نوع:
TransitOptions optionalتنظیماتی که فقط برای درخواستهایی اعمال میشود که travelMode آنها TRANSIT است. این شیء تأثیری بر دیگر حالتهای سفر نخواهد داشت. |
unitSystem
اختیاری |
نوع:
UnitSystem optionalسیستم واحد ترجیحی برای استفاده هنگام نمایش فاصله. اختیاری؛ پیشفرض متریک است. |
میانای DistanceMatrixResponse
میانا
google.maps.DistanceMatrixResponse
پاسخ به درخواست DistanceMatrixService، شامل نشانیهای مبدأ و مقصد قالببندیشده، و دنبالهای از DistanceMatrixResponseRow، یکی برای هر نشانی مبدأ مربوطه.
مشخصات | |
|---|---|
destinationAddresses |
نوع:
Array<string>نشانیهای مقصد قالببندیشده. |
originAddresses |
نوع:
Array<string>نشانیهای مبدأ قالببندیشده. |
rows |
ردیفهای ماتریس، مربوط به نشانیهای مبدأ. |
میانای DistanceMatrixResponseRow
میانا
google.maps.DistanceMatrixResponseRow
ردیفی از پاسخ به درخواست DistanceMatrixService، شامل دنبالهای از DistanceMatrixResponseElement، هرکدام برای یک نشانی مقصد مربوطه.
مشخصات | |
|---|---|
elements |
عناصر ردیف، مطابق با نشانیهای مقصد. |
میانای DistanceMatrixResponseElement
میانا
google.maps.DistanceMatrixResponseElement
عنصر واحدی از پاسخ به درخواست DistanceMatrixService که حاوی مدت و فاصله از یک مبدأ تا یک مقصد است.
مشخصات | |
|---|---|
distance |
نوع:
Distanceفاصله برای این جفت مبدأ-مقصد. این ویژگی ممکن است تعریفنشده باشد زیرا ممکن است فاصله نامشخص باشد. |
duration |
نوع:
Durationمدت زمان این جفت مبدأ-مقصد. این ویژگی ممکن است تعریف نشده باشد زیرا مدت زمان ممکن است ناشناخته باشد. |
duration_in_traffic |
نوع:
Durationمدت زمان این جفت مبدأ-مقصد، با درنظر گرفتن شرایط ترافیکی که توسط ویژگی trafficModel نشان داده شده است. این ویژگی ممکن است undefined باشد زیرا مدت ممکن است نامشخص باشد. فقط برای مشتریان «طرح Premium» دردسترس است، وقتی drivingOptions هنگام درخواست تعریف شده باشد. |
fare |
نوع:
TransitFareکرایه کل برای این جفت مبدأ-مقصد. فقط برای درخواستهای حملونقل عمومی قابلاجرا است. |
status |
وضعیت این جفت مبدأ-مقصد خاص. |
ثابتهای DistanceMatrixStatus
google.maps.DistanceMatrixStatus
ثابتها
کتابخانه "routes"
وضعیت سطح بالا درباره درخواست بهطور کلی که توسط DistanceMatrixService پساز تکمیل درخواست ماتریس فاصله برگردانده میشود. اینها را براساس مقدار یا بااستفاده از نام ثابت مشخص کنید. برای مثال، 'OK' یا google.maps.DistanceMatrixStatus.OK.
این ثابتها بهعنوان رشته نیز قابلاستفاده هستند. در TypeScript، رشتههای لفظی با نوع DistanceMatrixStatusString تعریف میشوند.
const {DistanceMatrixStatus} = await google.maps.importLibrary("routes");
ثابتها | |
|---|---|
INVALID_REQUEST |
درخواست ارائهشده نامعتبر بود. |
MAX_DIMENSIONS_EXCEEDED |
درخواست حاوی بیشاز ۲۵ مبدأ یا بیشاز ۲۵ مقصد است. |
MAX_ELEMENTS_EXCEEDED |
حاصلضرب مبدأها و مقصدها از حد مجاز هر پُرسمان بیشتر است. |
OK |
پاسخ حاوی نتیجه معتبری است. |
OVER_QUERY_LIMIT |
تعداد عناصر درخواستشده در دوره زمانی مجاز بسیار زیاد است. اگر کمی بعد دوباره امتحان کنید، درخواست باید موفقیتآمیز باشد. |
REQUEST_DENIED |
این سرویس استفاده از سرویس «ماتریس فاصله» را برای صفحه وب شما رد کرد. |
UNKNOWN_ERROR |
بهدلیل خطای سرور، درخواست «ماتریس فاصله» پردازش نشد. اگر دوباره امتحان کنید، ممکن است درخواست موفقیتآمیز باشد. |
ثابتهای DistanceMatrixElementStatus
google.maps.DistanceMatrixElementStatus
ثابتها
کتابخانه "routes"
وضعیت سطح عنصر درباره جفتسازی مبدأ-مقصد خاصی که توسط DistanceMatrixService پساز تکمیل درخواست ماتریس فاصله برگردانده شده است. این مقادیر بهصورت رشته مشخص میشوند، برای مثال، 'OK'.
این ثابتها بهعنوان رشته نیز قابلاستفاده هستند. در TypeScript، رشتههای لفظی با نوع DistanceMatrixElementStatusString تعریف میشوند.
const {DistanceMatrixElementStatus} = await google.maps.importLibrary("routes");
ثابتها | |
|---|---|
NOT_FOUND |
مبدأ و/یا مقصد این جفتسازی زمینکدیابی نشد. |
OK |
پاسخ حاوی نتیجه معتبری است. |
ZERO_RESULTS |
هیچ مسیری بین مبدأ و مقصد پیدا نشد. |