RoutePostRouteMatrixPreviewOptionalParams interface

  • Referenz
Paket:
azure-maps-rest

Optionale Parameter.

Extends

RequestOptionsBase

Eigenschaften

arriveAt

Datum und Uhrzeit der Ankunft am Zielpunkt. Sie muss als dateTime angegeben werden. Wenn kein Zeitzonenoffset angegeben wird, wird davon ausgegangen, dass es sich um den des Zielpunkts handelt. Der wert "arriveAt" muss in der Zukunft sein. Der parameter arriveAt kann nicht in Verbindung mit departAt, minDeviationDistance oder minDeviationTime verwendet werden.
avoid

Gibt etwas an, das die Routenberechnung beim Bestimmen der Route vermeiden soll. Kann mehrmals in einer Anforderung angegeben werden, z. B. "&avoid=autobahnen&avoid=tollRoads&avoid=ferries". In calculateReachableRange-Anforderungen darf der Wert alreadyUsedRoads nicht verwendet werden. Mögliche Werte: "tollRoads", "autobahnen", "ferries", "unpavedRoads", "carpools", "alreadyUsedRoads", "borderCrossings"
computeTravelTimeFor

Gibt an, ob zusätzliche Reisezeiten zurückgegeben werden sollen, indem verschiedene Arten von Verkehrsinformationen (keine, historische, live) sowie die am besten geschätzte Standardreisezeit verwendet werden. Mögliche Werte: "none", "all"
departAt

Das Datum und die Uhrzeit des Abflugs vom Ursprungspunkt. Die Abfahrtszeiten müssen ab sofort als dateTime angegeben werden. Wenn kein Zeitzonenoffset angegeben wird, wird davon ausgegangen, dass es sich um den des Ursprungspunkts handelt. Der wert "departAt" muss in der Zukunft im Datum-Uhrzeit-Format (1996-12-19T16:39:57-08:00) vorliegen.
hilliness

Grad der Hügeligkeit für aufregende Route. Dieser Parameter kann nur in Verbindung mit routeType=thrilling verwendet werden. Mögliche Werte: "niedrig", "normal", "hoch"
routeType

Der Typ der angeforderten Route. Mögliche Werte sind: "schnellste", "kürzeste", "öko", "spannend"
sectionType

Gibt an, welcher der Abschnittstypen in der Routenantwort gemeldet wird.

Wenn beispielsweise sectionType = pedestrian die Abschnitte zurückgegeben werden, die nur für Fußgänger geeignet sind. Es können mehrere Typen verwendet werden. Der StandardabschnittType bezieht sich auf die travelMode-Eingabe. Standardmäßig ist travelMode auf Auto festgelegt. Mögliche Werte: "carTrain", "country", "ferry", "motorway", "pedestrian", "tollRoad", "tollVignette", "traffic", "travelMode", "tunnel"
traffic

Mögliche Werte:

  • true: Berücksichtigen Sie alle verfügbaren Datenverkehrsinformationen während des Routings.
  • false: Ignorieren Sie aktuelle Datenverkehrsdaten während des Routings. Beachten Sie, dass die aktuellen Verkehrsdaten während des Routings ignoriert werden, die Auswirkungen des historischen Verkehrs auf die effektiven Straßengeschwindigkeiten jedoch weiterhin berücksichtigt werden.
travelMode

Der Reisemodus für die angeforderte Route. Beachten Sie, dass der angeforderte travelMode möglicherweise nicht für die gesamte Route verfügbar ist. Wenn der angeforderte travelMode für einen bestimmten Abschnitt nicht verfügbar ist, ist das travelMode-Element der Antwort für diesen Abschnitt ein anderes. Beachten Sie, dass die Reisemodi Bus, Motorrad, Taxi und Van BETA-Funktionalität sind. Vollständige Einschränkungsdaten sind nicht in allen Bereichen verfügbar. In calculateReachableRange-Anforderungen dürfen die Werte Fahrrad und Fußgänger nicht verwendet werden. Mögliche Werte: "Auto", "Lkw", "Taxi", "Bus", "Van", "Motorrad", "Fahrrad", "Fußgänger"
vehicleAxleWeight

Gewicht pro Achse des Fahrzeugs in kg. Ein Wert von 0 bedeutet, dass Gewichtseinschränkungen pro Achse nicht berücksichtigt werden.
vehicleHeight

Höhe des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Höheneinschränkungen nicht berücksichtigt werden.
vehicleLength

Länge des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Längeneinschränkungen nicht berücksichtigt werden.
vehicleLoadType

Arten von Gütern, die als gefahrstoffgefährdete Güter eingestuft werden können und von einigen Straßen aus eingeschränkt werden können. Verfügbare VehicleLoadType-Werte sind US Hazmat-Klassen 1 bis 9 sowie generische Klassifizierungen für die Verwendung in anderen Ländern. Werte, die mit USHazmat beginnen, gelten für das US-Routing, während andereHazmat für alle anderen Länder verwendet werden sollten. vehicleLoadType kann mehrmals angegeben werden. Dieser Parameter wird derzeit nur für travelMode=truck berücksichtigt. Mögliche Werte sind: 'USHazmatClass1', 'USHazmatClass2', 'USHazmatClass3', 'USHazmatClass4', 'USHazmatClass5', 'USHazmatClass6', 'USHazmatClass7', 'USHazmatClass8', 'USHazmatClass9', 'otherHazmatExplosive', 'otherHazmatGeneral', 'otherHazmatHarmfulToWater'
vehicleMaxSpeed

Höchstgeschwindigkeit des Fahrzeugs in km/Stunde. Ein Wert von 0 bedeutet, dass bei der Routenplanung ein geeigneter Wert für das Fahrzeug ermittelt und angewendet wird. Ein Wert ungleich 0 kann während der Routenplanung überschrieben werden.
vehicleWeight

Gewicht des Fahrzeugs in Kilogramm.
vehicleWidth

Breite des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Breiteseinschränkungen nicht berücksichtigt werden.
waitForResults

Boolesch, um anzugeben, ob die Anforderung synchron ausgeführt werden soll. Wenn die Einstellung auf true festgelegt ist, erhält der Benutzer eine Antwort mit 200, wenn die Anforderung unter 120 Sekunden abgeschlossen ist. Andernfalls erhält der Benutzer sofort eine Antwort 202. Weitere Informationen zur Antwort 202 finden Sie in der API-Beschreibung.
windingness

Grad der Kurven für aufregende Route. Dieser Parameter kann nur in Verbindung mit routeType=thrilling verwendet werden. Mögliche Werte: "niedrig", "normal", "hoch"

Geerbte Eigenschaften

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
customHeaders

{object} [customHeaders] Benutzerdefinierte benutzerdefinierte Anforderungsheader, die angewendet werden, bevor die Anforderung gesendet wird.
onDownloadProgress

Rückruf, der beim Downloadfortschritt ausgelöst wird.
onUploadProgress

Rückruf, der beim Hochladen des Fortschritts ausgelöst wird.
timeout

Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird.

Details zur Eigenschaft

arriveAt

Datum und Uhrzeit der Ankunft am Zielpunkt. Sie muss als dateTime angegeben werden. Wenn kein Zeitzonenoffset angegeben wird, wird davon ausgegangen, dass es sich um den des Zielpunkts handelt. Der wert "arriveAt" muss in der Zukunft sein. Der parameter arriveAt kann nicht in Verbindung mit departAt, minDeviationDistance oder minDeviationTime verwendet werden.

arriveAt?: Date

Eigenschaftswert

Date

avoid

Gibt etwas an, das die Routenberechnung beim Bestimmen der Route vermeiden soll. Kann mehrmals in einer Anforderung angegeben werden, z. B. "&avoid=autobahnen&avoid=tollRoads&avoid=ferries". In calculateReachableRange-Anforderungen darf der Wert alreadyUsedRoads nicht verwendet werden. Mögliche Werte: "tollRoads", "autobahnen", "ferries", "unpavedRoads", "carpools", "alreadyUsedRoads", "borderCrossings"

avoid?: Avoid[]

Eigenschaftswert

Avoid[]

computeTravelTimeFor

Gibt an, ob zusätzliche Reisezeiten zurückgegeben werden sollen, indem verschiedene Arten von Verkehrsinformationen (keine, historische, live) sowie die am besten geschätzte Standardreisezeit verwendet werden. Mögliche Werte: "none", "all"

computeTravelTimeFor?: ComputeTravelTimeFor

Eigenschaftswert

ComputeTravelTimeFor

departAt

Das Datum und die Uhrzeit des Abflugs vom Ursprungspunkt. Die Abfahrtszeiten müssen ab sofort als dateTime angegeben werden. Wenn kein Zeitzonenoffset angegeben wird, wird davon ausgegangen, dass es sich um den des Ursprungspunkts handelt. Der wert "departAt" muss in der Zukunft im Datum-Uhrzeit-Format (1996-12-19T16:39:57-08:00) vorliegen.

departAt?: Date

Eigenschaftswert

Date

hilliness

Grad der Hügeligkeit für aufregende Route. Dieser Parameter kann nur in Verbindung mit routeType=thrilling verwendet werden. Mögliche Werte: "niedrig", "normal", "hoch"

hilliness?: Hilliness

Eigenschaftswert

Hilliness

routeType

Der Typ der angeforderten Route. Mögliche Werte sind: "schnellste", "kürzeste", "öko", "spannend"

routeType?: RouteType

Eigenschaftswert

RouteType

sectionType

Gibt an, welcher der Abschnittstypen in der Routenantwort gemeldet wird.

Wenn beispielsweise sectionType = pedestrian die Abschnitte zurückgegeben werden, die nur für Fußgänger geeignet sind. Es können mehrere Typen verwendet werden. Der StandardabschnittType bezieht sich auf die travelMode-Eingabe. Standardmäßig ist travelMode auf Auto festgelegt. Mögliche Werte: "carTrain", "country", "ferry", "motorway", "pedestrian", "tollRoad", "tollVignette", "traffic", "travelMode", "tunnel"

sectionType?: SectionType

Eigenschaftswert

SectionType

traffic

Mögliche Werte:

  • true: Berücksichtigen Sie alle verfügbaren Datenverkehrsinformationen während des Routings.
  • false: Ignorieren Sie aktuelle Datenverkehrsdaten während des Routings. Beachten Sie, dass die aktuellen Verkehrsdaten während des Routings ignoriert werden, die Auswirkungen des historischen Verkehrs auf die effektiven Straßengeschwindigkeiten jedoch weiterhin berücksichtigt werden.
traffic?: boolean

Eigenschaftswert

boolean

travelMode

Der Reisemodus für die angeforderte Route. Beachten Sie, dass der angeforderte travelMode möglicherweise nicht für die gesamte Route verfügbar ist. Wenn der angeforderte travelMode für einen bestimmten Abschnitt nicht verfügbar ist, ist das travelMode-Element der Antwort für diesen Abschnitt ein anderes. Beachten Sie, dass die Reisemodi Bus, Motorrad, Taxi und Van BETA-Funktionalität sind. Vollständige Einschränkungsdaten sind nicht in allen Bereichen verfügbar. In calculateReachableRange-Anforderungen dürfen die Werte Fahrrad und Fußgänger nicht verwendet werden. Mögliche Werte: "Auto", "Lkw", "Taxi", "Bus", "Van", "Motorrad", "Fahrrad", "Fußgänger"

travelMode?: TravelMode

Eigenschaftswert

TravelMode

vehicleAxleWeight

Gewicht pro Achse des Fahrzeugs in kg. Ein Wert von 0 bedeutet, dass Gewichtseinschränkungen pro Achse nicht berücksichtigt werden.

vehicleAxleWeight?: number

Eigenschaftswert

number

vehicleHeight

Höhe des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Höheneinschränkungen nicht berücksichtigt werden.

vehicleHeight?: number

Eigenschaftswert

number

vehicleLength

Länge des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Längeneinschränkungen nicht berücksichtigt werden.

vehicleLength?: number

Eigenschaftswert

number

vehicleLoadType

Arten von Gütern, die als gefahrstoffgefährdete Güter eingestuft werden können und von einigen Straßen aus eingeschränkt werden können. Verfügbare VehicleLoadType-Werte sind US Hazmat-Klassen 1 bis 9 sowie generische Klassifizierungen für die Verwendung in anderen Ländern. Werte, die mit USHazmat beginnen, gelten für das US-Routing, während andereHazmat für alle anderen Länder verwendet werden sollten. vehicleLoadType kann mehrmals angegeben werden. Dieser Parameter wird derzeit nur für travelMode=truck berücksichtigt. Mögliche Werte sind: 'USHazmatClass1', 'USHazmatClass2', 'USHazmatClass3', 'USHazmatClass4', 'USHazmatClass5', 'USHazmatClass6', 'USHazmatClass7', 'USHazmatClass8', 'USHazmatClass9', 'otherHazmatExplosive', 'otherHazmatGeneral', 'otherHazmatHarmfulToWater'

vehicleLoadType?: VehicleLoadType

Eigenschaftswert

VehicleLoadType

vehicleMaxSpeed

Höchstgeschwindigkeit des Fahrzeugs in km/Stunde. Ein Wert von 0 bedeutet, dass bei der Routenplanung ein geeigneter Wert für das Fahrzeug ermittelt und angewendet wird. Ein Wert ungleich 0 kann während der Routenplanung überschrieben werden.

vehicleMaxSpeed?: number

Eigenschaftswert

number

vehicleWeight

Gewicht des Fahrzeugs in Kilogramm.

vehicleWeight?: number

Eigenschaftswert

number

vehicleWidth

Breite des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Breiteseinschränkungen nicht berücksichtigt werden.

vehicleWidth?: number

Eigenschaftswert

number

waitForResults

Boolesch, um anzugeben, ob die Anforderung synchron ausgeführt werden soll. Wenn die Einstellung auf true festgelegt ist, erhält der Benutzer eine Antwort mit 200, wenn die Anforderung unter 120 Sekunden abgeschlossen ist. Andernfalls erhält der Benutzer sofort eine Antwort 202. Weitere Informationen zur Antwort 202 finden Sie in der API-Beschreibung.

waitForResults?: boolean

Eigenschaftswert

boolean

windingness

Grad der Kurven für aufregende Route. Dieser Parameter kann nur in Verbindung mit routeType=thrilling verwendet werden. Mögliche Werte: "niedrig", "normal", "hoch"

windingness?: Windingness

Eigenschaftswert

Windingness

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

Geerbt von RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Benutzerdefinierte benutzerdefinierte Anforderungsheader, die angewendet werden, bevor die Anforderung gesendet wird.

customHeaders?: [key: string]: string

Eigenschaftswert

[key: string]: string

Geerbt von RequestOptionsBase.customHeaders

onDownloadProgress

Rückruf, der beim Downloadfortschritt ausgelöst wird.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

Geerbt von RequestOptionsBase.onDownloadProgress

onUploadProgress

Rückruf, der beim Hochladen des Fortschritts ausgelöst wird.

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

Geerbt von RequestOptionsBase.onUploadProgress

timeout

Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird.

timeout?: number

Eigenschaftswert

number

Geerbt von RequestOptionsBase.timeout