Share via

RoutePostRouteMatrixPreviewOptionalParams interface

  • Referensi
Paket:
azure-maps-rest

Parameter opsional.

Extends

RequestOptionsBase

Properti

arriveAt

Tanggal dan waktu kedatangan di titik tujuan. Ini harus ditentukan sebagai dateTime. Ketika offset zona waktu tidak ditentukan, itu akan diasumsikan sebagai titik tujuan. Nilai arriveAt harus di masa mendatang. Parameter arriveAt tidak dapat digunakan bersama dengan departAt, minDeviationDistance, atau minDeviationTime.
avoid

Menentukan sesuatu yang harus dihindari oleh perhitungan rute saat menentukan rute. Dapat ditentukan beberapa kali dalam satu permintaan, misalnya, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Dalam permintaan calculateReachableRange, nilai alreadyUsedRoads tidak boleh digunakan. Nilai yang mungkin termasuk: 'tollRoads', 'motorways', 'feri', 'unpavedRoads', 'carpools', 'alreadyUsedRoads', 'borderCrossings'
computeTravelTimeFor

Menentukan apakah akan mengembalikan waktu perjalanan tambahan menggunakan berbagai jenis informasi lalu lintas (tidak ada, historis, langsung) serta perkiraan waktu perjalanan terbaik default. Nilai yang mungkin termasuk: 'none', 'all'
departAt

Tanggal dan waktu keberangkatan dari titik asal. Waktu keberangkatan selain dari sekarang harus ditentukan sebagai dateTime. Ketika offset zona waktu tidak ditentukan, itu akan diasumsikan sebagai titik asal. Nilai departAt harus di masa mendatang dalam format tanggal-waktu (1996-12-19T16:39:57-08:00).
hilliness

Tingkat kebukitan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan routeType=thrilling. Nilai yang mungkin termasuk: 'rendah', 'normal', 'tinggi'
routeType

Jenis rute yang diminta. Nilai yang mungkin termasuk: 'tercepat', 'terpendek', 'eco', 'mendebarkan'
sectionType

Menentukan jenis bagian mana yang dilaporkan dalam respons rute.

Misalnya jika sectionType = pedestrian, bagian yang cocok untuk pejalan kaki hanya dikembalikan. Beberapa jenis dapat digunakan. SectionType default mengacu pada input travelMode. Secara default travelMode diatur ke mobil. Kemungkinan nilainya meliputi: 'carTrain', 'country', 'ferry', 'motorway', 'pedestrian', 'tollRoad', 'tollVignette', 'traffic', 'travelMode', 'tunnel'
traffic

Nilai yang memungkinkan:

  • true - Pertimbangkan semua informasi lalu lintas yang tersedia selama perutean
  • false - Abaikan data lalu lintas saat ini selama perutean. Perhatikan bahwa meskipun data lalu lintas saat ini diabaikan selama perutean, efek lalu lintas historis pada kecepatan jalan yang efektif masih dimasukkan.
travelMode

Mode perjalanan untuk rute yang diminta. Perhatikan bahwa travelMode yang diminta mungkin tidak tersedia untuk seluruh rute. Jika travelMode yang diminta tidak tersedia untuk bagian tertentu, elemen travelMode dari respons untuk bagian tersebut akan menjadi yang lain. Perhatikan bahwa mode perjalanan bus, sepeda motor, taksi, dan van adalah fungsionalitas BETA. Data pembatasan penuh tidak tersedia di semua area. Dalam permintaan calculateReachableRange , nilai sepeda dan pejalan kaki tidak boleh digunakan. Kemungkinan nilainya meliputi: 'mobil', 'truk', 'taksi', 'bus', 'van', 'sepeda motor', 'sepeda', 'pejalan kaki'
vehicleAxleWeight

Berat per sumbu kendaraan dalam kg. Nilai 0 berarti bahwa pembatasan berat per sumbu tidak dipertimbangkan.
vehicleHeight

Tinggi kendaraan dalam meter. Nilai 0 berarti bahwa pembatasan tinggi tidak dipertimbangkan.
vehicleLength

Panjang kendaraan dalam meter. Nilai 0 berarti bahwa pembatasan panjang tidak dipertimbangkan.
vehicleLoadType

Jenis kargo yang mungkin diklasifikasikan sebagai bahan berbahaya dan dibatasi dari beberapa jalan. Nilai vehicleLoadType yang tersedia adalah kelas Hazmat AS 1 hingga 9, ditambah klasifikasi generik untuk digunakan di negara lain. Nilai yang dimulai dengan USHazmat adalah untuk perutean AS sementara otherHazmat harus digunakan untuk semua negara lain. vehicleLoadType dapat ditentukan beberapa kali. Parameter ini saat ini hanya dipertimbangkan untuk travelMode=truck. Nilai yang mungkin termasuk: 'USHazmatClass1', 'USHazmatClass2', 'USHazmatClass3', 'USHazmatClass4', 'USHazmatClass5', 'USHazmatClass6', 'USHazmatClass7', 'USHazmatClass8', 'USHazmatClass9', 'otherHazmatExplosive', 'otherHazmatGeneral', 'otherHazmatHarmfulToWater'
vehicleMaxSpeed

Kecepatan maksimum kendaraan dalam km/jam. Nilai 0 berarti bahwa nilai yang sesuai untuk kendaraan akan ditentukan dan diterapkan selama perencanaan rute. Nilai bukan nol dapat ditimpa selama perencanaan rute.
vehicleWeight

Berat kendaraan dalam kilogram.
vehicleWidth

Lebar kendaraan dalam meter. Nilai 0 berarti bahwa pembatasan lebar tidak dipertimbangkan.
waitForResults

Boolean untuk menunjukkan apakah akan menjalankan permintaan secara sinkron. Jika diatur ke true, pengguna akan mendapatkan respons 200 jika permintaan selesai di bawah 120 detik. Jika tidak, pengguna akan mendapatkan respons 202 segera. Lihat deskripsi API untuk detail selengkapnya tentang respons 202.
windingness

Tingkat belokan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan routeType=thrilling. Nilai yang mungkin termasuk: 'rendah', 'normal', 'tinggi'

Properti yang Diwariskan

abortSignal

Sinyal yang dapat digunakan untuk membatalkan permintaan.
customHeaders

{object} [customHeaders] Header permintaan kustom yang ditentukan pengguna yang akan diterapkan sebelum permintaan dikirim.
onDownloadProgress

Panggilan balik yang diaktifkan setelah kemajuan pengunduhan.
onUploadProgress

Panggilan balik yang diaktifkan setelah kemajuan pengunggahan.
timeout

Jumlah milidetik yang dapat diambil permintaan sebelum dihentikan secara otomatis.

Detail Properti

arriveAt

Tanggal dan waktu kedatangan di titik tujuan. Ini harus ditentukan sebagai dateTime. Ketika offset zona waktu tidak ditentukan, itu akan diasumsikan sebagai titik tujuan. Nilai arriveAt harus di masa mendatang. Parameter arriveAt tidak dapat digunakan bersama dengan departAt, minDeviationDistance, atau minDeviationTime.

arriveAt?: Date

Nilai Properti

Date

avoid

Menentukan sesuatu yang harus dihindari oleh perhitungan rute saat menentukan rute. Dapat ditentukan beberapa kali dalam satu permintaan, misalnya, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Dalam permintaan calculateReachableRange, nilai alreadyUsedRoads tidak boleh digunakan. Nilai yang mungkin termasuk: 'tollRoads', 'motorways', 'feri', 'unpavedRoads', 'carpools', 'alreadyUsedRoads', 'borderCrossings'

avoid?: Avoid[]

Nilai Properti

Avoid[]

computeTravelTimeFor

Menentukan apakah akan mengembalikan waktu perjalanan tambahan menggunakan berbagai jenis informasi lalu lintas (tidak ada, historis, langsung) serta perkiraan waktu perjalanan terbaik default. Nilai yang mungkin termasuk: 'none', 'all'

computeTravelTimeFor?: ComputeTravelTimeFor

Nilai Properti

ComputeTravelTimeFor

departAt

Tanggal dan waktu keberangkatan dari titik asal. Waktu keberangkatan selain dari sekarang harus ditentukan sebagai dateTime. Ketika offset zona waktu tidak ditentukan, itu akan diasumsikan sebagai titik asal. Nilai departAt harus di masa mendatang dalam format tanggal-waktu (1996-12-19T16:39:57-08:00).

departAt?: Date

Nilai Properti

Date

hilliness

Tingkat kebukitan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan routeType=thrilling. Nilai yang mungkin termasuk: 'rendah', 'normal', 'tinggi'

hilliness?: Hilliness

Nilai Properti

Hilliness

routeType

Jenis rute yang diminta. Nilai yang mungkin termasuk: 'tercepat', 'terpendek', 'eco', 'mendebarkan'

routeType?: RouteType

Nilai Properti

RouteType

sectionType

Menentukan jenis bagian mana yang dilaporkan dalam respons rute.

Misalnya jika sectionType = pedestrian, bagian yang cocok untuk pejalan kaki hanya dikembalikan. Beberapa jenis dapat digunakan. SectionType default mengacu pada input travelMode. Secara default travelMode diatur ke mobil. Kemungkinan nilainya meliputi: 'carTrain', 'country', 'ferry', 'motorway', 'pedestrian', 'tollRoad', 'tollVignette', 'traffic', 'travelMode', 'tunnel'

sectionType?: SectionType

Nilai Properti

SectionType

traffic

Nilai yang memungkinkan:

  • true - Pertimbangkan semua informasi lalu lintas yang tersedia selama perutean
  • false - Abaikan data lalu lintas saat ini selama perutean. Perhatikan bahwa meskipun data lalu lintas saat ini diabaikan selama perutean, efek lalu lintas historis pada kecepatan jalan yang efektif masih dimasukkan.
traffic?: boolean

Nilai Properti

boolean

travelMode

Mode perjalanan untuk rute yang diminta. Perhatikan bahwa travelMode yang diminta mungkin tidak tersedia untuk seluruh rute. Jika travelMode yang diminta tidak tersedia untuk bagian tertentu, elemen travelMode dari respons untuk bagian tersebut akan menjadi yang lain. Perhatikan bahwa mode perjalanan bus, sepeda motor, taksi, dan van adalah fungsionalitas BETA. Data pembatasan penuh tidak tersedia di semua area. Dalam permintaan calculateReachableRange , nilai sepeda dan pejalan kaki tidak boleh digunakan. Kemungkinan nilainya meliputi: 'mobil', 'truk', 'taksi', 'bus', 'van', 'sepeda motor', 'sepeda', 'pejalan kaki'

travelMode?: TravelMode

Nilai Properti

TravelMode

vehicleAxleWeight

Berat per sumbu kendaraan dalam kg. Nilai 0 berarti bahwa pembatasan berat per sumbu tidak dipertimbangkan.

vehicleAxleWeight?: number

Nilai Properti

number

vehicleHeight

Tinggi kendaraan dalam meter. Nilai 0 berarti bahwa pembatasan tinggi tidak dipertimbangkan.

vehicleHeight?: number

Nilai Properti

number

vehicleLength

Panjang kendaraan dalam meter. Nilai 0 berarti bahwa pembatasan panjang tidak dipertimbangkan.

vehicleLength?: number

Nilai Properti

number

vehicleLoadType

Jenis kargo yang mungkin diklasifikasikan sebagai bahan berbahaya dan dibatasi dari beberapa jalan. Nilai vehicleLoadType yang tersedia adalah kelas Hazmat AS 1 hingga 9, ditambah klasifikasi generik untuk digunakan di negara lain. Nilai yang dimulai dengan USHazmat adalah untuk perutean AS sementara otherHazmat harus digunakan untuk semua negara lain. vehicleLoadType dapat ditentukan beberapa kali. Parameter ini saat ini hanya dipertimbangkan untuk travelMode=truck. Nilai yang mungkin termasuk: 'USHazmatClass1', 'USHazmatClass2', 'USHazmatClass3', 'USHazmatClass4', 'USHazmatClass5', 'USHazmatClass6', 'USHazmatClass7', 'USHazmatClass8', 'USHazmatClass9', 'otherHazmatExplosive', 'otherHazmatGeneral', 'otherHazmatHarmfulToWater'

vehicleLoadType?: VehicleLoadType

Nilai Properti

VehicleLoadType

vehicleMaxSpeed

Kecepatan maksimum kendaraan dalam km/jam. Nilai 0 berarti bahwa nilai yang sesuai untuk kendaraan akan ditentukan dan diterapkan selama perencanaan rute. Nilai bukan nol dapat ditimpa selama perencanaan rute.

vehicleMaxSpeed?: number

Nilai Properti

number

vehicleWeight

Berat kendaraan dalam kilogram.

vehicleWeight?: number

Nilai Properti

number

vehicleWidth

Lebar kendaraan dalam meter. Nilai 0 berarti bahwa pembatasan lebar tidak dipertimbangkan.

vehicleWidth?: number

Nilai Properti

number

waitForResults

Boolean untuk menunjukkan apakah akan menjalankan permintaan secara sinkron. Jika diatur ke true, pengguna akan mendapatkan respons 200 jika permintaan selesai di bawah 120 detik. Jika tidak, pengguna akan mendapatkan respons 202 segera. Lihat deskripsi API untuk detail selengkapnya tentang respons 202.

waitForResults?: boolean

Nilai Properti

boolean

windingness

Tingkat belokan untuk rute yang mendebarkan. Parameter ini hanya dapat digunakan bersama dengan routeType=thrilling. Nilai yang mungkin termasuk: 'rendah', 'normal', 'tinggi'

windingness?: Windingness

Nilai Properti

Windingness

Detail Properti yang Diwariskan

abortSignal

Sinyal yang dapat digunakan untuk membatalkan permintaan.

abortSignal?: AbortSignalLike

Nilai Properti

AbortSignalLike

Diwarisi Dari RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Header permintaan kustom yang ditentukan pengguna yang akan diterapkan sebelum permintaan dikirim.

customHeaders?: [key: string]: string

Nilai Properti

[key: string]: string

Diwarisi Dari RequestOptionsBase.customHeaders

onDownloadProgress

Panggilan balik yang diaktifkan setelah kemajuan pengunduhan.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Nilai Properti

(progress: TransferProgressEvent) => void

Diwarisi Dari RequestOptionsBase.onDownloadProgress

onUploadProgress

Panggilan balik yang diaktifkan setelah kemajuan pengunggahan.

onUploadProgress?: (progress: TransferProgressEvent) => void

Nilai Properti

(progress: TransferProgressEvent) => void

Diwarisi Dari RequestOptionsBase.onUploadProgress

timeout

Jumlah milidetik yang dapat diambil permintaan sebelum dihentikan secara otomatis.

timeout?: number

Nilai Properti

number

Diwarisi Dari RequestOptionsBase.timeout