Udostępnij za pośrednictwem

RoutePostRouteMatrixPreviewOptionalParams interface

  • Odwołanie
Pakiet:
azure-maps-rest

Parametry opcjonalne.

Extends

RequestOptionsBase

Właściwości

arriveAt

Data i godzina przybycia do punktu docelowego. Musi być określona jako data/godzina. Jeśli nie określono przesunięcia strefy czasowej, zakłada się, że jest to punkt docelowy. Wartość arriveAt musi być w przyszłości. Nie można użyć parametru arriveAt w połączeniu z parametrem departAt, minDeviationDistance lub minDeviationTime.
avoid

Określa coś, czego należy unikać podczas określania trasy. Można określić wiele razy w jednym żądaniu, na przykład "&avoid=autostrady&avoid=tollRoads&unikaj =promy". W żądaniach calculateReachableRange wartość jużUsedRoads nie może być używana. Możliwe wartości obejmują: "tollRoads", "autostrady", "promy", "unpavedRoads", "carpools", "alreadyUsedRoads", "borderCrossings"
computeTravelTimeFor

Określa, czy zwracać dodatkowe czasy podróży przy użyciu różnych typów informacji o ruchu (brak, historyczny, na żywo), a także domyślny czas podróży najlepiej szacowany. Możliwe wartości to: "none", "all"
departAt

Data i godzina odejścia z punktu początkowego. Czasy odlotu oprócz teraz muszą być określone jako data/godzina. Jeśli nie określono przesunięcia strefy czasowej, zakłada się, że jest to punkt początkowy. Wartość departAt musi być w przyszłości w formacie daty i godziny (1996-12-19T16:39:57-08:00).
hilliness

Stopień wzgórza do porywającej trasy. Ten parametr może być używany tylko w połączeniu z routeType=thrilling. Możliwe wartości to: "niski", "normalny", "wysoki"
routeType

Żądany typ trasy. Możliwe wartości to: "najszybszy", "najkrótszy", "eco", "porywający"
sectionType

Określa, które typy sekcji są zgłaszane w odpowiedzi trasy.

Jeśli na przykład sekcjaType = piesi, są zwracane tylko sekcje odpowiednie dla pieszych. Można użyć wielu typów. Domyślny typ sekcji odnosi się do danych wejściowych travelMode. Domyślnie element travelMode jest ustawiony na samochód. Możliwe wartości obejmują: "carTrain", "country", "ferry", "highway", "pedestrian", "tollRoad", "tollVignette", "traffic", "travelMode", "tunnel"
traffic

Możliwe wartości:

  • true — należy wziąć pod uwagę wszystkie dostępne informacje o ruchu podczas routingu
  • false — ignoruj bieżące dane ruchu podczas routingu. Należy pamiętać, że chociaż bieżące dane ruchu są ignorowane podczas routingu, wpływ historycznego ruchu na efektywne prędkości drogowe jest nadal uwzględniany.
travelMode

Tryb podróży dla żądanej trasy. Należy pamiętać, że żądany tryb travelMode może nie być dostępny dla całej trasy. Jeśli żądany element travelMode nie jest dostępny dla określonej sekcji, element travelMode odpowiedzi dla tej sekcji będzie inny. Należy pamiętać, że tryby podróży autobus, motocykl, taksówka i van są funkcją BETA. Pełne dane ograniczeń nie są dostępne we wszystkich obszarach. W żądaniach calculateReachableRange nie można używać wartości roweru i pieszych. Możliwe wartości to: "samochód", "ciężarówka", "taxi", "bus", "van", "motocykl", "rower", "pieszy"
vehicleAxleWeight

Waga na oś pojazdu w kg. Wartość 0 oznacza, że ograniczenia wagi na oś nie są brane pod uwagę.
vehicleHeight

Wysokość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia wysokości nie są brane pod uwagę.
vehicleLength

Długość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia długości nie są brane pod uwagę.
vehicleLoadType

Typy ładunków, które mogą być klasyfikowane jako materiały niebezpieczne i ograniczone z niektórych dróg. Dostępne wartości vehicleLoadType to klasy us Hazmat od 1 do 9 oraz klasyfikacje ogólne do użycia w innych krajach. Wartości rozpoczynające się od USHazmat są przeznaczone dla routingu usa, podczas gdy inneHazmat powinny być używane dla wszystkich innych krajów. vehicleLoadType można określić wiele razy. Ten parametr jest obecnie uznawany tylko za travelMode=truck. Możliwe wartości obejmują: "USHazmatClass1", "USHazmatClass2", "USHazmatClass3", "USHazmatClass4", "USHazmatClass5", "USHazmatClass6", "USHazmatClass7", "USHazmatClass8", "USHazmatClass9", "otherHazmatExplosive", "otherHazmatGeneral", "otherHazmatHarmfulToWater"
vehicleMaxSpeed

Maksymalna prędkość pojazdu w km/godzinę. Wartość 0 oznacza, że odpowiednia wartość dla pojazdu zostanie określona i zastosowana podczas planowania trasy. Podczas planowania trasy może zostać zastąpiona wartość inna niż zero.
vehicleWeight

Waga pojazdu w kilogramach.
vehicleWidth

Szerokość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia szerokości nie są brane pod uwagę.
waitForResults

Wartość logiczna określająca, czy żądanie ma być wykonywane synchronicznie. W przypadku ustawienia wartości true użytkownik otrzyma odpowiedź 200, jeśli żądanie zostanie zakończone poniżej 120 sekund. W przeciwnym razie użytkownik od razu otrzyma odpowiedź 202. Aby uzyskać więcej informacji na temat odpowiedzi na 202 r., zapoznaj się z opisem interfejsu API.
windingness

Poziom zakrętów dla porywającej trasy. Tego parametru można używać tylko w połączeniu z routeType=thrilling. Możliwe wartości to: "low", "normal", "high"

Właściwości dziedziczone

abortSignal

Sygnał, który może służyć do przerwania żądań.
customHeaders

{object} [customHeaders] Nagłówki żądań niestandardowych zdefiniowane przez użytkownika, które zostaną zastosowane przed wysłaniem żądania.
onDownloadProgress

Wywołanie zwrotne, które jest uruchamiane po postępie pobierania.
onUploadProgress

Wywołanie zwrotne, które jest uruchamiane po postępie przekazywania.
timeout

Liczba milisekund żądania może potrwać przed automatycznym kończeniem.

Szczegóły właściwości

arriveAt

Data i godzina przybycia do punktu docelowego. Musi być określona jako data/godzina. Jeśli nie określono przesunięcia strefy czasowej, zakłada się, że jest to punkt docelowy. Wartość arriveAt musi być w przyszłości. Nie można użyć parametru arriveAt w połączeniu z parametrem departAt, minDeviationDistance lub minDeviationTime.

arriveAt?: Date

Wartość właściwości

Date

avoid

Określa coś, czego należy unikać podczas określania trasy. Można określić wiele razy w jednym żądaniu, na przykład "&avoid=autostrady&avoid=tollRoads&unikaj =promy". W żądaniach calculateReachableRange wartość jużUsedRoads nie może być używana. Możliwe wartości obejmują: "tollRoads", "autostrady", "promy", "unpavedRoads", "carpools", "alreadyUsedRoads", "borderCrossings"

avoid?: Avoid[]

Wartość właściwości

Avoid[]

computeTravelTimeFor

Określa, czy zwracać dodatkowe czasy podróży przy użyciu różnych typów informacji o ruchu (brak, historyczny, na żywo), a także domyślny czas podróży najlepiej szacowany. Możliwe wartości to: "none", "all"

computeTravelTimeFor?: ComputeTravelTimeFor

Wartość właściwości

ComputeTravelTimeFor

departAt

Data i godzina odejścia z punktu początkowego. Czasy odlotu oprócz teraz muszą być określone jako data/godzina. Jeśli nie określono przesunięcia strefy czasowej, zakłada się, że jest to punkt początkowy. Wartość departAt musi być w przyszłości w formacie daty i godziny (1996-12-19T16:39:57-08:00).

departAt?: Date

Wartość właściwości

Date

hilliness

Stopień wzgórza do porywającej trasy. Ten parametr może być używany tylko w połączeniu z routeType=thrilling. Możliwe wartości to: "niski", "normalny", "wysoki"

hilliness?: Hilliness

Wartość właściwości

Hilliness

routeType

Żądany typ trasy. Możliwe wartości to: "najszybszy", "najkrótszy", "eco", "porywający"

routeType?: RouteType

Wartość właściwości

RouteType

sectionType

Określa, które typy sekcji są zgłaszane w odpowiedzi trasy.

Jeśli na przykład sekcjaType = piesi, są zwracane tylko sekcje odpowiednie dla pieszych. Można użyć wielu typów. Domyślny typ sekcji odnosi się do danych wejściowych travelMode. Domyślnie element travelMode jest ustawiony na samochód. Możliwe wartości obejmują: "carTrain", "country", "ferry", "highway", "pedestrian", "tollRoad", "tollVignette", "traffic", "travelMode", "tunnel"

sectionType?: SectionType

Wartość właściwości

SectionType

traffic

Możliwe wartości:

  • true — należy wziąć pod uwagę wszystkie dostępne informacje o ruchu podczas routingu
  • false — ignoruj bieżące dane ruchu podczas routingu. Należy pamiętać, że chociaż bieżące dane ruchu są ignorowane podczas routingu, wpływ historycznego ruchu na efektywne prędkości drogowe jest nadal uwzględniany.
traffic?: boolean

Wartość właściwości

boolean

travelMode

Tryb podróży dla żądanej trasy. Należy pamiętać, że żądany tryb travelMode może nie być dostępny dla całej trasy. Jeśli żądany element travelMode nie jest dostępny dla określonej sekcji, element travelMode odpowiedzi dla tej sekcji będzie inny. Należy pamiętać, że tryby podróży autobus, motocykl, taksówka i van są funkcją BETA. Pełne dane ograniczeń nie są dostępne we wszystkich obszarach. W żądaniach calculateReachableRange nie można używać wartości roweru i pieszych. Możliwe wartości to: "samochód", "ciężarówka", "taxi", "bus", "van", "motocykl", "rower", "pieszy"

travelMode?: TravelMode

Wartość właściwości

TravelMode

vehicleAxleWeight

Waga na oś pojazdu w kg. Wartość 0 oznacza, że ograniczenia wagi na oś nie są brane pod uwagę.

vehicleAxleWeight?: number

Wartość właściwości

number

vehicleHeight

Wysokość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia wysokości nie są brane pod uwagę.

vehicleHeight?: number

Wartość właściwości

number

vehicleLength

Długość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia długości nie są brane pod uwagę.

vehicleLength?: number

Wartość właściwości

number

vehicleLoadType

Typy ładunków, które mogą być klasyfikowane jako materiały niebezpieczne i ograniczone z niektórych dróg. Dostępne wartości vehicleLoadType to klasy us Hazmat od 1 do 9 oraz klasyfikacje ogólne do użycia w innych krajach. Wartości rozpoczynające się od USHazmat są przeznaczone dla routingu usa, podczas gdy inneHazmat powinny być używane dla wszystkich innych krajów. vehicleLoadType można określić wiele razy. Ten parametr jest obecnie uznawany tylko za travelMode=truck. Możliwe wartości obejmują: "USHazmatClass1", "USHazmatClass2", "USHazmatClass3", "USHazmatClass4", "USHazmatClass5", "USHazmatClass6", "USHazmatClass7", "USHazmatClass8", "USHazmatClass9", "otherHazmatExplosive", "otherHazmatGeneral", "otherHazmatHarmfulToWater"

vehicleLoadType?: VehicleLoadType

Wartość właściwości

VehicleLoadType

vehicleMaxSpeed

Maksymalna prędkość pojazdu w km/godzinę. Wartość 0 oznacza, że odpowiednia wartość dla pojazdu zostanie określona i zastosowana podczas planowania trasy. Podczas planowania trasy może zostać zastąpiona wartość inna niż zero.

vehicleMaxSpeed?: number

Wartość właściwości

number

vehicleWeight

Waga pojazdu w kilogramach.

vehicleWeight?: number

Wartość właściwości

number

vehicleWidth

Szerokość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia szerokości nie są brane pod uwagę.

vehicleWidth?: number

Wartość właściwości

number

waitForResults

Wartość logiczna określająca, czy żądanie ma być wykonywane synchronicznie. W przypadku ustawienia wartości true użytkownik otrzyma odpowiedź 200, jeśli żądanie zostanie zakończone poniżej 120 sekund. W przeciwnym razie użytkownik od razu otrzyma odpowiedź 202. Aby uzyskać więcej informacji na temat odpowiedzi na 202 r., zapoznaj się z opisem interfejsu API.

waitForResults?: boolean

Wartość właściwości

boolean

windingness

Poziom zakrętów dla porywającej trasy. Tego parametru można używać tylko w połączeniu z routeType=thrilling. Możliwe wartości to: "low", "normal", "high"

windingness?: Windingness

Wartość właściwości

Windingness

Szczegóły właściwości dziedziczonej

abortSignal

Sygnał, który może służyć do przerwania żądań.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

Dziedziczone z RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Nagłówki żądań niestandardowych zdefiniowane przez użytkownika, które zostaną zastosowane przed wysłaniem żądania.

customHeaders?: [key: string]: string

Wartość właściwości

[key: string]: string

Dziedziczone z RequestOptionsBase.customHeaders

onDownloadProgress

Wywołanie zwrotne, które jest uruchamiane po postępie pobierania.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

Dziedziczone z RequestOptionsBase.onDownloadProgress

onUploadProgress

Wywołanie zwrotne, które jest uruchamiane po postępie przekazywania.

onUploadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

Dziedziczone z RequestOptionsBase.onUploadProgress

timeout

Liczba milisekund żądania może potrwać przed automatycznym kończeniem.

timeout?: number

Wartość właściwości

number

Dziedziczone z RequestOptionsBase.timeout