SpatialURL class
SpatialURL は、Azure Maps空間操作の URL を表します。
- Extends
コンストラクター
| SpatialURL(Pipeline, string) | SpatialURL のインスタンスを作成します。 |
継承されたプロパティ
| maps |
ベース URL 文字列値。 |
メソッド
| get |
各フィーチャーが入力の対応するインデックス付きフィーチャーを囲むバッファーである FeatureCollection を返します。 バッファーは、入力に指定された距離に応じて、指定されたフィーチャーの外側または内部にある可能性があります。 FeatureCollection 入力でフィーチャーごとに 1 つの距離を指定するか、距離を 1 つだけ指定すると、その距離がコレクション内のすべてのフィーチャーに適用されます。 ジオメトリの正 (または負) バッファーは、バッファー距離の絶対値と等しい半径の円を持つジオメトリの Minkowski 合計 (または差) として定義されます。 バッファー API は常に多角形の結果を返します。 線と点の負またはゼロ距離バッファーは、常に空の多角形です。 入力機能は、要求または Data Upload API を介してアップロードされ、一意の udid によって参照される GeoJSON ファイルによって提供されます。 データには、Point、MultiPoint、Polygon、MultiPolygon、LineString、MultiLineString のコレクションが含まれる場合があります。 指定した場合、GeometryCollection は無視されます。
を直接提供する場合は それ以外の場合は、Get Buffer API を使用します。 https://docs.microsoft.com/rest/api/maps/spatial/getbuffer |
| get |
要求内のユーザー データまたは udid によって識別されるユーザー アップロード データ セット内のユーザー データによって提供される、基本ポイントと特定のポイント セットの間の最も近いポイントを返します。
udid を使用する場合、ターゲット ポイントのセットは、 Data Upload API を介してアップロードされ、一意の udid によって参照される GeoJSON ファイルによって提供されます。 GeoJSON ファイルに含まれるのは、Point ジオメトリのコレクションのみです。 MultiPoint またはその他のジオメトリが指定されている場合、無視されます。 許容されるポイントの最大数は 100,000 です。
このアルゴリズムでは、ルーティングやトラフィックは考慮されません。 返される情報には、最も近いポイントの緯度、経度、最も近いポイントからの距離 (メートル単位) が含まれます。
を直接提供する場合は それ以外の場合は、最も近いポイントの取得 API を使用します。 https://docs.microsoft.com/rest/api/maps/spatial/getclosestpoint |
| get |
要求で指定されたジオフェンスまたは Data サービスにアップロードされたジオフェンスとの座標の近接性を取得します。 Data Upload API を使用して、ジオフェンスまたはフェンスのセットをアップロードできます。 ジオフェンス データ形式の詳細については、「 GeoJSON データ のジオフェンス」を参照してください。 座標の近接性を照会するには、追跡するオブジェクトの位置とフェンスまたはフェンスのセットの ID を指定します。応答にはジオフェンスの外側の端からの距離に関する情報が含まれます。 負の値は、座標がフェンスの内側にあることを意味し、正の値はフェンスの外側にあることを意味します。 この API は、資産の追跡、フリート管理、オブジェクトの移動に関するアラートの設定など、さまざまなシナリオに使用できます。 この API では、 Event Grid との統合がサポートされています。 isAsync パラメーターは、Event Grid との統合を有効にするために使用されます (既定では無効)。 この API をテストするには、Data Upload API を使用して Post Geofence API examples(Request Body) からサンプル データをアップロードし、以下のサンプル要求の [udid] を Data Upload API によって返される udid に置き換えます。 ジオフェンスを直接提供する場合は、Post Geofence API を使用します。 https://docs.microsoft.com/rest/api/maps/spatial/postgeofence それ以外の場合は、Get Geofence API を使用します。 https://docs.microsoft.com/en-us/rest/api/maps/spatial/getgeofence Geofencing InnerError コードジオフェンシング応答エラー コントラクトでは、 は、 innererror.code |error.message ---------------------------- |nullDeviceId の-------------------------------------- |デバイス ID を null にすることはできません。 NullUdid |Udid を null にすることはできません。 UdidWrongFormat|Udid は、ユーザー データ インジェスト API から取得する必要があります。 InvalidUserTime|Usertime が無効です。 InvalidSearchBuffer|Searchbuffer が無効です。 InvalidSearchRange|searchbuffer の値の範囲は 0 ~ 500 m である必要があります。 InvalidLatLon|Lat パラメーターまたは lon パラメーターが無効です。 InvalidIsAsyncValue|IsAsync パラメーターが無効です。 InvalidModeValue|mode パラメーターが無効です。 InvalidJson|ジオフェンシング データは有効な json ファイルではありません。 NotSupportedGeoJson|ジオフェンシング データを Feature または FeatureCollections として読み取ることはできません。 InvalidGeoJson|ジオフェンシング データが無効です。 NoUserDataWithAccountOrSubscription|指定された account-id または subscription-id を持つユーザー ジオフェンシング データが見つかりません。NoUserDataWithUdid|指定された udId を持つユーザー ジオフェンシング データが見つかりません。 |
| get |
球の表面に沿って測定された、球の表面上の 2 つの点間の大円または最短距離を返します。 これは、球の内部を通る直線の計算とは異なります。 この方法は、空港間の最短距離を計算することによって飛行機の移動距離を推定するのに役立ちます。 Get Great Circle Distance API を使用します。 https://docs.microsoft.com/rest/api/maps/spatial/getgreatcircledistance |
| get |
ポイントが一連のポリゴン内にあるかどうかを返します。 一連の多角形は、要求で提供されるか、 Data Upload API を介してアップロードされ、一意の udid によって参照される GeoJSON ファイルによって提供されます。 GeoJSON ファイルには Polygon ジオメトリと MultiPolygon ジオメトリが含まれている場合があります。指定した場合、他のジオメトリは無視されます。 ポイントがこれらのポリゴンの内側または境界にある場合、返される値は true です。 それ以外のすべての場合、返される値は false です。 ポイントが複数のポリゴン内にある場合、結果は交差する geometries セクションを提供し、ユーザー データ内のすべての有効なジオメトリ (geometryId によって参照) を表示します。 Polygon の形成に許容される頂点の最大数は 10,000 です。
を直接提供する場合は それ以外の場合は、Polygon API の Get Point を使用します。 https://docs.microsoft.com/rest/api/maps/spatial/getpointinpolygon |
継承されたメソッド
| new |
Credential が指定された新しい Pipeline オブジェクトを作成するために使用される静的メソッド。 |
コンストラクターの詳細
SpatialURL(Pipeline, string)
SpatialURL のインスタンスを作成します。
new SpatialURL(pipeline: Pipeline, mapsUrl?: string)パラメーター
- pipeline
- Pipeline
MapsURL.newPipeline() を呼び出して既定のパイプラインを作成するか、カスタマイズされたパイプラインを指定します。
- mapsUrl
-
string
Azure Maps サービスを指す URL 文字列。既定値は です"https://atlas.microsoft.com"。
プロトコルが指定されていない場合 (例: "atlas.microsoft.com") が https 想定されます。
継承されたプロパティの詳細
mapsUrl
メソッドの詳細
getBuffer(Aborter, string | SpatialFeatureCollection, number[])
各フィーチャーが入力の対応するインデックス付きフィーチャーを囲むバッファーである FeatureCollection を返します。 バッファーは、入力に指定された距離に応じて、指定されたフィーチャーの外側または内部にある可能性があります。 FeatureCollection 入力でフィーチャーごとに 1 つの距離を指定するか、距離を 1 つだけ指定すると、その距離がコレクション内のすべてのフィーチャーに適用されます。 ジオメトリの正 (または負) バッファーは、バッファー距離の絶対値と等しい半径の円を持つジオメトリの Minkowski 合計 (または差) として定義されます。 バッファー API は常に多角形の結果を返します。 線と点の負またはゼロ距離バッファーは、常に空の多角形です。 入力機能は、要求または Data Upload API を介してアップロードされ、一意の udid によって参照される GeoJSON ファイルによって提供されます。 データには、Point、MultiPoint、Polygon、MultiPolygon、LineString、MultiLineString のコレクションが含まれる場合があります。 指定した場合、GeometryCollection は無視されます。
を直接提供する場合は FeatureCollection 、Post Buffer API を使用します。 https://docs.microsoft.com/rest/api/maps/spatial/postbuffer
それ以外の場合は、Get Buffer API を使用します。 https://docs.microsoft.com/rest/api/maps/spatial/getbuffer
function getBuffer(aborter: Aborter, udidOrFeatureCollection: string | SpatialFeatureCollection, distances: number[]): Promise<GetBufferResponse>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
- udidOrFeatureCollection
-
string | SpatialFeatureCollection
FeatureCollection有効な GeoJSON FeatureCollection オブジェクトをアップロードした後に Data Upload API から返される入力または一意の ID を含む 。 詳細については、 RFC 7946 を参照してください。 フィーチャのすべてのプロパティに を含める geometryId必要があります。これはジオメトリを識別するために使用され、大文字と小文字が区別されます。
- distances
-
number[]
距離の一覧 (フィーチャごとに 1 つ、またはすべてのフィーチャに対して 1 つ)。 正の距離を指定すると、フィーチャの外側にバッファーが生成されますが、負の距離ではフィーチャ内にバッファーが生成されます。 ジオメトリ自体よりも負の距離が大きい場合は、空のポリゴンが返されます。
戻り値
Promise<GetBufferResponse>
getClosestPoint(Aborter, GeoJSON.Position, string | SpatialFeatureCollection, GetClosestPointOptions)
要求内のユーザー データまたは udid によって識別されるユーザー アップロード データ セット内のユーザー データによって提供される、基本ポイントと特定のポイント セットの間の最も近いポイントを返します。
udid を使用する場合、ターゲット ポイントのセットは、 Data Upload API を介してアップロードされ、一意の udid によって参照される GeoJSON ファイルによって提供されます。 GeoJSON ファイルに含まれるのは、Point ジオメトリのコレクションのみです。 MultiPoint またはその他のジオメトリが指定されている場合、無視されます。 許容されるポイントの最大数は 100,000 です。
このアルゴリズムでは、ルーティングやトラフィックは考慮されません。 返される情報には、最も近いポイントの緯度、経度、最も近いポイントからの距離 (メートル単位) が含まれます。
を直接提供する場合は FeatureCollection 、最も近いポイントの投稿 API を使用します。 https://docs.microsoft.com/rest/api/maps/spatial/postclosestpoint
それ以外の場合は、最も近いポイントの取得 API を使用します。 https://docs.microsoft.com/rest/api/maps/spatial/getclosestpoint
function getClosestPoint(aborter: Aborter, position: GeoJSON.Position, udidOrFeatureCollection: string | SpatialFeatureCollection, options?: GetClosestPointOptions): Promise<GetClosesPointResponse>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
- position
- GeoJSON.Position
基点。
- udidOrFeatureCollection
-
string | SpatialFeatureCollection
FeatureCollection有効な GeoJSON FeatureCollection オブジェクトをアップロードした後に Data Upload API から返されるターゲット ポイントまたは一意の ID を含む 。 詳細については、 RFC 7946 を参照してください。 フィーチャのすべてのプロパティに を含める geometryId必要があります。これはジオメトリを識別するために使用され、大文字と小文字が区別されます。
- options
- GetClosestPointOptions
戻り値
Promise<GetClosesPointResponse>
getGeofence(Aborter, string, string | SpatialFeatureCollection, GeoJSON.Position, GetGeofenceOptions)
要求で指定されたジオフェンスまたは Data サービスにアップロードされたジオフェンスとの座標の近接性を取得します。 Data Upload API を使用して、ジオフェンスまたはフェンスのセットをアップロードできます。 ジオフェンス データ形式の詳細については、「 GeoJSON データ のジオフェンス」を参照してください。 座標の近接性を照会するには、追跡するオブジェクトの位置とフェンスまたはフェンスのセットの ID を指定します。応答にはジオフェンスの外側の端からの距離に関する情報が含まれます。 負の値は、座標がフェンスの内側にあることを意味し、正の値はフェンスの外側にあることを意味します。 この API は、資産の追跡、フリート管理、オブジェクトの移動に関するアラートの設定など、さまざまなシナリオに使用できます。 この API では、 Event Grid との統合がサポートされています。 isAsync パラメーターは、Event Grid との統合を有効にするために使用されます (既定では無効)。 この API をテストするには、Data Upload API を使用して Post Geofence API examples(Request Body) からサンプル データをアップロードし、以下のサンプル要求の [udid] を Data Upload API によって返される udid に置き換えます。
ジオフェンスを直接提供する場合は、Post Geofence API を使用します。 https://docs.microsoft.com/rest/api/maps/spatial/postgeofence
それ以外の場合は、Get Geofence API を使用します。 https://docs.microsoft.com/en-us/rest/api/maps/spatial/getgeofence
Geofencing InnerError コード
ジオフェンシング応答エラー コントラクトでは、 は、 innererror エラーに関するサービス固有の情報を含むオブジェクトです。 code は、特定の innererror ジオフェンシング エラーの種類にマップできるプロパティです。 次の表は、既知のすべてのクライアント エラーの種類と対応するジオフェンス エラー messageの間のコード マッピングを示しています。
innererror.code |error.message ---------------------------- |nullDeviceId の-------------------------------------- |デバイス ID を null にすることはできません。 NullUdid |Udid を null にすることはできません。 UdidWrongFormat|Udid は、ユーザー データ インジェスト API から取得する必要があります。 InvalidUserTime|Usertime が無効です。 InvalidSearchBuffer|Searchbuffer が無効です。 InvalidSearchRange|searchbuffer の値の範囲は 0 ~ 500 m である必要があります。 InvalidLatLon|Lat パラメーターまたは lon パラメーターが無効です。 InvalidIsAsyncValue|IsAsync パラメーターが無効です。 InvalidModeValue|mode パラメーターが無効です。 InvalidJson|ジオフェンシング データは有効な json ファイルではありません。 NotSupportedGeoJson|ジオフェンシング データを Feature または FeatureCollections として読み取ることはできません。 InvalidGeoJson|ジオフェンシング データが無効です。 NoUserDataWithAccountOrSubscription|指定された account-id または subscription-id を持つユーザー ジオフェンシング データが見つかりません。NoUserDataWithUdid|指定された udId を持つユーザー ジオフェンシング データが見つかりません。
function getGeofence(aborter: Aborter, deviceId: string, udidOrFeatureCollection: string | SpatialFeatureCollection, position: GeoJSON.Position, options?: GetGeofenceOptions): Promise<GetGeofenceResponse>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
- deviceId
-
string
デバイスの ID
- udidOrFeatureCollection
-
string | SpatialFeatureCollection
FeatureCollection有効な GeoJSON FeatureCollection オブジェクトをアップロードした後に Data Upload API から返されるフェンスまたは一意の ID を含む 。 詳細については、 RFC 7946 を参照してください。 フィーチャのすべてのプロパティには、 が含まれている geometryId必要があります。これはジオメトリを識別するために使用され、大文字と小文字が区別されます。
- position
- GeoJSON.Position
渡される場所。
- options
- GetGeofenceOptions
戻り値
Promise<GetGeofenceResponse>
getGreatCircleDistance(Aborter, [GeoJSON.Position, GeoJSON.Position])
球の表面に沿って測定された、球の表面上の 2 つの点間の大円または最短距離を返します。 これは、球の内部を通る直線の計算とは異なります。 この方法は、空港間の最短距離を計算することによって飛行機の移動距離を推定するのに役立ちます。 Get Great Circle Distance API を使用します。 https://docs.microsoft.com/rest/api/maps/spatial/getgreatcircledistance
function getGreatCircleDistance(aborter: Aborter, coordinates: [GeoJSON.Position, GeoJSON.Position]): Promise<GetGreatCircleDistance>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
- coordinates
-
[GeoJSON.Position, GeoJSON.Position]
距離の計算に使用する座標。 2 つの座標が必要です。 1 つ目はソース ポイント座標、最後はターゲット ポイント座標です。
戻り値
Promise<GetGreatCircleDistance>
getPointInPolygon(Aborter, string | SpatialFeatureCollection, GeoJSON.Position)
ポイントが一連のポリゴン内にあるかどうかを返します。 一連の多角形は、要求で提供されるか、 Data Upload API を介してアップロードされ、一意の udid によって参照される GeoJSON ファイルによって提供されます。 GeoJSON ファイルには Polygon ジオメトリと MultiPolygon ジオメトリが含まれている場合があります。指定した場合、他のジオメトリは無視されます。 ポイントがこれらのポリゴンの内側または境界にある場合、返される値は true です。 それ以外のすべての場合、返される値は false です。 ポイントが複数のポリゴン内にある場合、結果は交差する geometries セクションを提供し、ユーザー データ内のすべての有効なジオメトリ (geometryId によって参照) を表示します。 Polygon の形成に許容される頂点の最大数は 10,000 です。
を直接提供する場合は FeatureCollection 、Post Point In Polygon API を使用します。 https://docs.microsoft.com/rest/api/maps/spatial/postpointinpolygon
それ以外の場合は、Polygon API の Get Point を使用します。 https://docs.microsoft.com/rest/api/maps/spatial/getpointinpolygon
function getPointInPolygon(aborter: Aborter, udidOrFeatureCollection: string | SpatialFeatureCollection, position: GeoJSON.Position): Promise<GetPointInPolygonResponse>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
- udidOrFeatureCollection
-
string | SpatialFeatureCollection
FeatureCollection有効な GeoJSON FeatureCollection オブジェクトをアップロードした後にデータ アップロード API から返される多角形または一意の ID を含む 。 詳細については、 RFC 7946 を参照してください。 フィーチャのすべてのプロパティには、 が含まれている geometryId必要があります。これはジオメトリを識別するために使用され、大文字と小文字が区別されます。
- position
- GeoJSON.Position
基点。
戻り値
Promise<GetPointInPolygonResponse>
継承済みメソッドの詳細
newPipeline(Credential, INewPipelineOptions)
Credential が指定された新しい Pipeline オブジェクトを作成するために使用される静的メソッド。
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipelineパラメーター
- credential
- Credential
SubscriptionKeyCredential、TokenCredential、MapControlCredential など。
- pipelineOptions
- INewPipelineOptions
戻り値
新しい Pipeline オブジェクト。