RouteBeginPostRouteMatrixPreviewOptionalParams interface
Optionale Parameter.
- Extends
-
RequestOptionsBase
Eigenschaften
arrive |
Datum und Uhrzeit der Ankunft am Zielort. Sie muss als dateTime angegeben werden. Wenn kein Zeitzonenoffset angegeben wird, wird davon ausgegangen, dass es sich um den Des Zielpunkts handelt. Der Wert für "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 bei der Routenberechnung beim Bestimmen der Route vermieden werden 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 sind: "tollRoads", "autobahnen", "ferries", "unpavedRoads", "carpools", "alreadyUsedRoads", "borderCrossings" |
compute |
Gibt an, ob zusätzliche Reisezeiten mit verschiedenen Arten von Verkehrsinformationen (keine, historischen, live) sowie der am besten geschätzten Standardreisezeit zurückgegeben werden sollen. Mögliche Werte: "none", "all" |
depart |
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 |
route |
Der Typ der angeforderten Route. Mögliche Werte sind: "schnellste", "kürzeste", "eco", "thrilling" |
section |
Gibt an, welcher der Abschnittstypen in der Routenantwort gemeldet wird. |
traffic | Mögliche Werte:
|
travel |
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 anforderungen von calculateReachableRange dürfen die Werte bicycle und pedestrian nicht verwendet werden. Mögliche Werte sind: "Auto", "Lkw", "Taxi", "Bus", "Van", "Motorrad", "Fahrrad", "Fußgänger" |
vehicle |
Gewicht pro Achse des Fahrzeugs in kg. Der Wert 0 bedeutet, dass Gewichtsbeschränkungen pro Achse nicht berücksichtigt werden. |
vehicle |
Höhe des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Höheneinschränkungen nicht berücksichtigt werden. |
vehicle |
Länge des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Längeneinschränkungen nicht berücksichtigt werden. |
vehicle |
Arten von Fracht, die als gefahrgut klassifiziert werden können und von einigen Straßen 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 US-Routing, während otherHazmat für alle anderen Länder verwendet werden sollte. 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' |
vehicle |
Höchstgeschwindigkeit des Fahrzeugs in km/Stunde. Der Wert 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. |
vehicle |
Gewicht des Fahrzeugs in Kilogramm. |
vehicle |
Breite des Fahrzeugs in Metern. Der Wert 0 bedeutet, dass Breiteseinschränkungen nicht berücksichtigt werden. |
wait |
Boolescher Wert, um anzugeben, ob die Anforderung synchron ausgeführt werden soll. Wenn dieser Wert auf TRUE festgelegt ist, erhält der Benutzer eine Antwort vom Typ 200, wenn die Anforderung weniger als 120 Sekunden abgeschlossen ist. Andernfalls erhält der Benutzer sofort eine Antwort vom Typ 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: "low", "normal", "high" |
Geerbte Eigenschaften
abort |
Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann. |
custom |
{object} [customHeaders] Benutzerdefinierte Anforderungsheader, die angewendet werden, bevor die Anforderung gesendet wird. |
on |
Rückruf, der beim Downloadfortschritt ausgelöst wird. |
on |
Rückruf, der beim Uploadvorgang 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 Zielort. Sie muss als dateTime angegeben werden. Wenn kein Zeitzonenoffset angegeben wird, wird davon ausgegangen, dass es sich um den Des Zielpunkts handelt. Der Wert für "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 bei der Routenberechnung beim Bestimmen der Route vermieden werden 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 sind: "tollRoads", "autobahnen", "ferries", "unpavedRoads", "carpools", "alreadyUsedRoads", "borderCrossings"
avoid?: Avoid[]
Eigenschaftswert
Avoid[]
computeTravelTimeFor
Gibt an, ob zusätzliche Reisezeiten mit verschiedenen Arten von Verkehrsinformationen (keine, historischen, live) sowie der am besten geschätzten Standardreisezeit zurückgegeben werden sollen. Mögliche Werte: "none", "all"
computeTravelTimeFor?: ComputeTravelTimeFor
Eigenschaftswert
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: "low", "normal", "high"
hilliness?: Hilliness
Eigenschaftswert
routeType
Der Typ der angeforderten Route. Mögliche Werte sind: "schnellste", "kürzeste", "eco", "thrilling"
routeType?: RouteType
Eigenschaftswert
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 sind: "carTrain", "country", "ferry", "autobahn", "fußgänger", "tollRoad", "tollVignette", "traffic", "travelMode", "tunnel"
sectionType?: SectionType
Eigenschaftswert
traffic
Mögliche Werte:
- true: Berücksichtigen Sie während des Routings alle verfügbaren Datenverkehrsinformationen.
- false: Aktuelle Datenverkehrsdaten während des Routings ignorieren. Beachten Sie, dass die aktuellen Verkehrsdaten zwar beim Routing 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 anforderungen von calculateReachableRange dürfen die Werte bicycle und pedestrian nicht verwendet werden. Mögliche Werte sind: "Auto", "Lkw", "Taxi", "Bus", "Van", "Motorrad", "Fahrrad", "Fußgänger"
travelMode?: TravelMode
Eigenschaftswert
vehicleAxleWeight
Gewicht pro Achse des Fahrzeugs in kg. Der Wert 0 bedeutet, dass Gewichtsbeschrä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 Fracht, die als gefahrgut klassifiziert werden können und von einigen Straßen 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 US-Routing, während otherHazmat für alle anderen Länder verwendet werden sollte. 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
vehicleMaxSpeed
Höchstgeschwindigkeit des Fahrzeugs in km/Stunde. Der Wert 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
Boolescher Wert, um anzugeben, ob die Anforderung synchron ausgeführt werden soll. Wenn dieser Wert auf TRUE festgelegt ist, erhält der Benutzer eine Antwort vom Typ 200, wenn die Anforderung weniger als 120 Sekunden abgeschlossen ist. Andernfalls erhält der Benutzer sofort eine Antwort vom Typ 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: "low", "normal", "high"
windingness?: Windingness
Eigenschaftswert
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 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 Uploadvorgang 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