次の方法で共有

RouteBeginPostRouteMatrixPreviewOptionalParams interface

  • リファレンス
パッケージ:
azure-maps-rest

省略可能なパラメーター。

Extends

RequestOptionsBase

プロパティ

arriveAt

目的地への到着日時。 dateTime として指定する必要があります。 タイム ゾーン オフセットが指定されていない場合は、ターゲット ポイントのオフセットと見なされます。 arriveAt 値は将来である必要があります。 arriveAt パラメーターは、departAt、minDeviationDistance、minDeviationTime と組み合わせて使用することはできません。
avoid

ルートの決定時にルート計算で回避する必要がある何かを指定します。 1 つの要求で複数回指定できます。たとえば、'&avoid=高速道路&avoid=tollRoads&avoid=ferrys' です。 CalculateReachableRange 要求では、既にUsedRoads の値を使用しないでください。 使用できる値は、'tollRoads'、'高速道路'、'フェリー'、'unpavedRoads'、'carpools'、'alreadyUsedRoads'、'borderCrossings' です。
computeTravelTimeFor

さまざまな種類の交通情報 (なし、履歴、ライブ) と既定の最適推定移動時間を使用して、追加の移動時間を返すかどうかを指定します。 使用可能な値は、'none'、'all' です。
departAt

出発地点からの出発日時。 現在とは別の出発時刻は dateTime として指定する必要があります。 タイム ゾーン オフセットが指定されていない場合は、原点のオフセットと見なされます。 departAt 値は、将来の日付/時刻形式 (1996-12-19T16:39:57-08:00) である必要があります。
hilliness

スリル満点のルートのための丘陵性の程度。 このパラメーターは、=thrilling と routeType組み合わせてのみ使用できます。 指定できる値は、'low'、'normal'、'high' です。
routeType

要求されたルートの種類。 使用可能な値には、'fastest'、'shortest'、'eco'、'thrilling' などがあります。
sectionType

ルート応答で報告されるセクションの種類を指定します。

たとえば、sectionType = 歩行者の場合、歩行者のみに適したセクションが返されます。 複数の型を使用できます。 既定の sectionType は、travelMode 入力を参照します。 既定では、travelMode は car に設定されています。 使用可能な値には、'carTrain'、'country'、'ferry'、'高速道路'、'歩行者'、'tollRoad'、'tollVignette'、'traffic'、'travelMode'、'tunnel' などがあります。
traffic

指定できる値

  • true - ルーティング中に使用可能なすべてのトラフィック情報を考慮する
  • false - ルーティング中に現在のトラフィック データを無視します。 現在のトラフィック データはルーティング中は無視されますが、有効な道路速度に対する履歴トラフィックの影響は引き続き組み込まれることに注意してください。
travelMode

要求されたルートの移動モード。 要求された travelMode は、ルート全体で使用できない場合があることに注意してください。 要求された travelMode が特定のセクションで使用できない場合、そのセクションの応答の travelMode 要素は他の要素になります。 移動モードバス、オートバイ、タクシー、バンはベータ機能であることに注意してください。 すべての領域で完全な制限データを使用できるわけではありません。 ReachableRange 要求の計算では、自転車と歩行者の値を使用しないでください。 使用可能な値には、'car'、'truck'、'taxi'、'bus'、'van'、'motorcycle'、'bicycle'、'pedestrian' などがあります。
vehicleAxleWeight

車両の車軸あたりの重量 (kg)。 値が 0 の場合、車軸あたりの重量制限は考慮されません。
vehicleHeight

車両の高さ (メートル単位)。 値が 0 の場合、高さの制限は考慮されません。
vehicleLength

車両の長さ (メートル単位)。 値 0 は、長さの制限が考慮されないことを意味します。
vehicleLoadType

危険物として分類され、一部の道路から制限される可能性のある貨物の種類。 使用可能な vehicleLoadType 値は、US Hazmat クラス 1 から 9 に加えて、他の国で使用するための一般的な分類です。 USHazmat で始まる値は米国のルーティング用であり、otherHazmat は他のすべての国で使用する必要があります。 vehicleLoadType は複数回指定できます。 このパラメーターは現在、travelMode=truck でのみ考慮されています。 使用できる値は、'USHazmatClass1'、 'USHazmatClass2'、'USHazmatClass3'、'USHazmatClass4'、'USHazmatClass5'、'USHazmatClass6'、'USHazmatClass7'、'USHazmatClass8'、'USHazmatClass9'、'otherHazmatExplosive'、'otherHazmatGeneral'、'otherHazmatHarmfulToWater'
vehicleMaxSpeed

キロ/時の車両の最高速度。 値 0 は、ルート計画中に車両に適切な値が決定され、適用されることを意味します。 0 以外の値は、ルート計画中にオーバーライドされる可能性があります。
vehicleWeight

車両の重量 (キロ単位)。
vehicleWidth

車両の幅 (メートル単位)。 値が 0 の場合、幅の制限は考慮されません。
waitForResults

要求を同期的に実行するかどうかを示すブール値。 true に設定すると、要求が 120 秒で完了すると、ユーザーは 200 応答を受け取ります。 それ以外の場合、ユーザーはすぐに 202 応答を受け取ります。 202 応答の詳細については、API の説明を参照してください。
windingness

スリル満点のルートのターンのレベル。 このパラメーターは、routeType=thrilling と組み合わせてのみ使用できます。 指定できる値は、'low'、'normal'、'high' です。

継承されたプロパティ

abortSignal

要求を中止するために使用できるシグナル。
customHeaders

{object}[customHeaders]要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。
onDownloadProgress

ダウンロードの進行状況時に発生するコールバック。
onUploadProgress

アップロードの進行状況時に発生するコールバック。
timeout

要求が自動的に終了するまでの時間 (ミリ秒)。

プロパティの詳細

arriveAt

目的地への到着日時。 dateTime として指定する必要があります。 タイム ゾーン オフセットが指定されていない場合は、ターゲット ポイントのオフセットと見なされます。 arriveAt 値は将来である必要があります。 arriveAt パラメーターは、departAt、minDeviationDistance、minDeviationTime と組み合わせて使用することはできません。

arriveAt?: Date

プロパティ値

Date

avoid

ルートの決定時にルート計算で回避する必要がある何かを指定します。 1 つの要求で複数回指定できます。たとえば、'&avoid=高速道路&avoid=tollRoads&avoid=ferrys' です。 CalculateReachableRange 要求では、既にUsedRoads の値を使用しないでください。 使用できる値は、'tollRoads'、'高速道路'、'フェリー'、'unpavedRoads'、'carpools'、'alreadyUsedRoads'、'borderCrossings' です。

avoid?: Avoid[]

プロパティ値

Avoid[]

computeTravelTimeFor

さまざまな種類の交通情報 (なし、履歴、ライブ) と既定の最適推定移動時間を使用して、追加の移動時間を返すかどうかを指定します。 使用可能な値は、'none'、'all' です。

computeTravelTimeFor?: ComputeTravelTimeFor

プロパティ値

ComputeTravelTimeFor

departAt

出発地点からの出発日時。 現在とは別の出発時刻は dateTime として指定する必要があります。 タイム ゾーン オフセットが指定されていない場合は、原点のオフセットと見なされます。 departAt 値は、将来の日付/時刻形式 (1996-12-19T16:39:57-08:00) である必要があります。

departAt?: Date

プロパティ値

Date

hilliness

スリル満点のルートのための丘陵性の程度。 このパラメーターは、=thrilling と routeType組み合わせてのみ使用できます。 指定できる値は、'low'、'normal'、'high' です。

hilliness?: Hilliness

プロパティ値

Hilliness

routeType

要求されたルートの種類。 使用可能な値には、'fastest'、'shortest'、'eco'、'thrilling' などがあります。

routeType?: RouteType

プロパティ値

RouteType

sectionType

ルート応答で報告されるセクションの種類を指定します。

たとえば、sectionType = 歩行者の場合、歩行者のみに適したセクションが返されます。 複数の型を使用できます。 既定の sectionType は、travelMode 入力を参照します。 既定では、travelMode は car に設定されています。 使用可能な値には、'carTrain'、'country'、'ferry'、'高速道路'、'歩行者'、'tollRoad'、'tollVignette'、'traffic'、'travelMode'、'tunnel' などがあります。

sectionType?: SectionType

プロパティ値

SectionType

traffic

指定できる値

  • true - ルーティング中に使用可能なすべてのトラフィック情報を考慮する
  • false - ルーティング中に現在のトラフィック データを無視します。 現在のトラフィック データはルーティング中は無視されますが、有効な道路速度に対する履歴トラフィックの影響は引き続き組み込まれることに注意してください。
traffic?: boolean

プロパティ値

boolean

travelMode

要求されたルートの移動モード。 要求された travelMode は、ルート全体で使用できない場合があることに注意してください。 要求された travelMode が特定のセクションで使用できない場合、そのセクションの応答の travelMode 要素は他の要素になります。 移動モードバス、オートバイ、タクシー、バンはベータ機能であることに注意してください。 すべての領域で完全な制限データを使用できるわけではありません。 ReachableRange 要求の計算では、自転車と歩行者の値を使用しないでください。 使用可能な値には、'car'、'truck'、'taxi'、'bus'、'van'、'motorcycle'、'bicycle'、'pedestrian' などがあります。

travelMode?: TravelMode

プロパティ値

TravelMode

vehicleAxleWeight

車両の車軸あたりの重量 (kg)。 値が 0 の場合、車軸あたりの重量制限は考慮されません。

vehicleAxleWeight?: number

プロパティ値

number

vehicleHeight

車両の高さ (メートル単位)。 値が 0 の場合、高さの制限は考慮されません。

vehicleHeight?: number

プロパティ値

number

vehicleLength

車両の長さ (メートル単位)。 値 0 は、長さの制限が考慮されないことを意味します。

vehicleLength?: number

プロパティ値

number

vehicleLoadType

危険物として分類され、一部の道路から制限される可能性のある貨物の種類。 使用可能な vehicleLoadType 値は、US Hazmat クラス 1 から 9 に加えて、他の国で使用するための一般的な分類です。 USHazmat で始まる値は米国のルーティング用であり、otherHazmat は他のすべての国で使用する必要があります。 vehicleLoadType は複数回指定できます。 このパラメーターは現在、travelMode=truck でのみ考慮されています。 使用できる値は、'USHazmatClass1'、 'USHazmatClass2'、'USHazmatClass3'、'USHazmatClass4'、'USHazmatClass5'、'USHazmatClass6'、'USHazmatClass7'、'USHazmatClass8'、'USHazmatClass9'、'otherHazmatExplosive'、'otherHazmatGeneral'、'otherHazmatHarmfulToWater'

vehicleLoadType?: VehicleLoadType

プロパティ値

VehicleLoadType

vehicleMaxSpeed

キロ/時の車両の最高速度。 値 0 は、ルート計画中に車両に適切な値が決定され、適用されることを意味します。 0 以外の値は、ルート計画中にオーバーライドされる可能性があります。

vehicleMaxSpeed?: number

プロパティ値

number

vehicleWeight

車両の重量 (キロ単位)。

vehicleWeight?: number

プロパティ値

number

vehicleWidth

車両の幅 (メートル単位)。 値が 0 の場合、幅の制限は考慮されません。

vehicleWidth?: number

プロパティ値

number

waitForResults

要求を同期的に実行するかどうかを示すブール値。 true に設定すると、要求が 120 秒で完了すると、ユーザーは 200 応答を受け取ります。 それ以外の場合、ユーザーはすぐに 202 応答を受け取ります。 202 応答の詳細については、API の説明を参照してください。

waitForResults?: boolean

プロパティ値

boolean

windingness

スリル満点のルートのターンのレベル。 このパラメーターは、routeType=thrilling と組み合わせてのみ使用できます。 指定できる値は、'low'、'normal'、'high' です。

windingness?: Windingness

プロパティ値

Windingness

継承されたプロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

継承元 RequestOptionsBase.abortSignal

customHeaders

{object}[customHeaders]要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。

customHeaders?: [key: string]: string

プロパティ値

[key: string]: string

継承元 RequestOptionsBase.customHeaders

onDownloadProgress

ダウンロードの進行状況時に発生するコールバック。

onDownloadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

継承元 RequestOptionsBase.onDownloadProgress

onUploadProgress

アップロードの進行状況時に発生するコールバック。

onUploadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

継承元 RequestOptionsBase.onUploadProgress

timeout

要求が自動的に終了するまでの時間 (ミリ秒)。

timeout?: number

プロパティ値

number

継承元 RequestOptionsBase.timeout