Share via

SpatialURL class

  • Referensi
Paket:
azure-maps-rest

SpatialURL mewakili URL ke operasi spasial Azure Maps.

Extends
MapsURL

Konstruktor

SpatialURL(Pipeline, string)

Membuat instans SpatialURL.

Properti yang Diwariskan

mapsUrl

Nilai string URL dasar.

Metode

getBuffer(Aborter, string | SpatialFeatureCollection, number[])

Mengembalikan FeatureCollection di mana setiap Fitur adalah buffer di sekitar Fitur input terindeks yang sesuai. Buffer dapat berada di luar atau di dalam Fitur yang disediakan, tergantung pada jarak yang disediakan dalam input. Harus ada satu jarak yang disediakan per Fitur dalam input FeatureCollection, atau jika hanya satu jarak yang disediakan, maka jarak tersebut diterapkan ke setiap Fitur dalam koleksi. Buffer positif (atau negatif) geometri didefinisikan sebagai jumlah Minkowski (atau perbedaan) geometri dengan lingkaran radius yang sama dengan nilai absolut jarak buffer. API buffer selalu mengembalikan hasil poligonal. Buffer garis dan titik negatif atau jarak nol selalu merupakan poligon kosong. Fitur input disediakan dalam permintaan atau oleh file GeoJSON yang diunggah melalui DATA Upload API dan direferensikan oleh udid unik. Data mungkin berisi kumpulan Point, MultiPoint, Polygon, MultiPolygon, LineString, dan MultiLineString. GeometryCollection akan diabaikan jika disediakan. Jika secara langsung menyediakan FeatureCollection penggunaan Post Buffer API: https://docs.microsoft.com/rest/api/maps/spatial/postbuffer

Jika tidak, gunakan Get Buffer API: https://docs.microsoft.com/rest/api/maps/spatial/getbuffer
getClosestPoint(Aborter, GeoJSON.Position, string | SpatialFeatureCollection, GetClosestPointOptions)

Mengembalikan titik terdekat antara titik dasar dan set titik tertentu yang disediakan oleh data pengguna dalam permintaan atau dalam himpunan data yang diunggah pengguna yang diidentifikasi oleh udid. Jika menggunakan udid, kumpulan titik target disediakan oleh file GeoJSON yang diunggah melalui API Pengunggahan Data dan direferensikan oleh udid unik. File GeoJSON hanya boleh berisi kumpulan geometri Titik. MultiPoint atau geometri lainnya akan diabaikan jika disediakan. Jumlah maksimum poin yang diterima adalah 100.000. Algoritma tidak mempertimbangkan perutean atau lalu lintas. Informasi yang dikembalikan mencakup lintang titik terdekat, bujur, dan jarak dalam meter dari titik terdekat. Jika secara langsung menyediakan FeatureCollection penggunaan Post Closest Point API: https://docs.microsoft.com/rest/api/maps/spatial/postclosestpoint

Jika tidak, gunakan Get Closest Point API: https://docs.microsoft.com/rest/api/maps/spatial/getclosestpoint
getGeofence(Aborter, string, string | SpatialFeatureCollection, GeoJSON.Position, GetGeofenceOptions)

Mengambil kedekatan koordinat ke geofence yang disediakan dalam permintaan atau yang telah diunggah ke layanan Data. Anda dapat menggunakan API Pengunggahan Data untuk mengunggah geofence atau set pagar. Lihat Data GeoJSON geofencing untuk detail selengkapnya tentang format data geofence. Untuk mengkueri kedekatan koordinat, Anda menyediakan lokasi objek yang Anda lacak serta ID untuk pagar atau set pagar, dan respons akan berisi informasi tentang jarak dari tepi luar geofence. Nilai negatif menandakan bahwa koordinat berada di dalam pagar sementara nilai positif berarti berada di luar pagar. API ini dapat digunakan untuk berbagai skenario yang mencakup hal-hal seperti pelacakan aset, manajemen armada, atau menyiapkan pemberitahuan untuk memindahkan objek. API mendukung integrasi dengan Event Grid. Parameter isAsync digunakan untuk mengaktifkan integrasi dengan Event Grid (dinonaktifkan secara default). Untuk menguji API ini, Anda dapat mengunggah data sampel dari contoh POST Geofence API (Request Body) melalui Data Upload API dan mengganti [udid] dari permintaan sampel di bawah ini dengan udid yang dikembalikan oleh Data Upload API.

Jika secara langsung menyediakan geofence menggunakan POST Geofence API: https://docs.microsoft.com/rest/api/maps/spatial/postgeofence

Jika tidak, gunakan Get Geofence API: https://docs.microsoft.com/en-us/rest/api/maps/spatial/getgeofence

Kode Geofencing InnerError

Dalam kontrak kesalahan respons geofencing, innererror adalah objek yang berisi informasi spesifik layanan tentang kesalahan. code adalah properti di innererror mana dapat memetakan ke jenis kesalahan geofencing tertentu. Tabel di bawah ini menunjukkan pemetaan kode antara semua jenis kesalahan klien yang diketahui ke kesalahan messagegeofencing yang sesuai .

innererror.code | error.message ---------------------------- | -------------------------------------- NullDeviceId | Id Perangkat tidak boleh null. NullUdid | Udid tidak boleh null. UdidWrongFormat| Udid harus diperoleh dari API penyerapan data pengguna. InvalidUserTime| Waktu pengguna tidak valid. InvalidSearchBuffer| Searchbuffer tidak valid. InvalidSearchRange| Rentang nilai searchbuffer harus dari 0 hingga 500 meter. InvalidLatLon| Parameter Lat dan/atau lon tidak valid. InvalidIsAsyncValue| Parameter IsAsync tidak valid. InvalidModeValue| Parameter mode tidak valid. InvalidJson| Data geofencing bukan file json yang valid. NotSupportedGeoJson| Data geofencing tidak dapat dibaca sebagai Fitur atau FeatureCollections. InvalidGeoJson| Data geofencing tidak valid. NoUserDataWithAccountOrSubscription| Tidak dapat menemukan data geofencing pengguna dengan id akun dan/atau id langganan yang disediakan. NoUserDataWithUdid| Tidak dapat menemukan data geofencing pengguna dengan udId yang disediakan.
getGreatCircleDistance(Aborter, [GeoJSON.Position, GeoJSON.Position])

Mengembalikan lingkaran besar atau jarak terpendek antara dua titik pada permukaan bola, diukur di sepanjang permukaan bola. Ini berbeda dari menghitung garis lurus melalui interior bola. Metode ini sangat membantu untuk memperkirakan jarak perjalanan untuk pesawat dengan menghitung jarak terpendek antara bandara. Menggunakan Get Great Circle Distance API: https://docs.microsoft.com/rest/api/maps/spatial/getgreatcircledistance
getPointInPolygon(Aborter, string | SpatialFeatureCollection, GeoJSON.Position)

Mengembalikan apakah titik berada di dalam sekumpulan poligon. Kumpulan poligon disediakan dalam permintaan atau oleh file GeoJSON yang diunggah melalui API Pengunggahan Data dan direferensikan oleh udid unik. File GeoJSON mungkin berisi geometri Poligon dan MultiPolygon, geometri lain akan diabaikan jika disediakan. Jika titik berada di dalam atau di batas salah satu poligon ini, nilai yang dikembalikan adalah true. Dalam semua kasus lainnya, nilai yang dikembalikan adalah false. Ketika titik berada di dalam beberapa poligon, hasilnya akan memberikan bagian geometri yang bersinggungan untuk menampilkan semua geometri yang valid (dirujuk oleh geometryId) dalam data pengguna. Jumlah maksimum simpul yang diterima untuk membentuk Poligon adalah 10.000. Jika secara langsung menyediakan FeatureCollection penggunaan Post Point In Polygon API: https://docs.microsoft.com/rest/api/maps/spatial/postpointinpolygon

Jika tidak, gunakan GET Point In Polygon API: https://docs.microsoft.com/rest/api/maps/spatial/getpointinpolygon

Metode yang Diwarisi

newPipeline(Credential, INewPipelineOptions)

Metode statis yang digunakan untuk membuat objek Alur baru dengan Kredensial yang disediakan.

Detail Konstruktor

SpatialURL(Pipeline, string)

Membuat instans SpatialURL.

new SpatialURL(pipeline: Pipeline, mapsUrl?: string)

Parameter

pipeline
Pipeline

Panggil MapsURL.newPipeline() untuk membuat alur default, atau sediakan alur yang disesuaikan.

mapsUrl

string

String URL yang menunjuk ke layanan Azure Maps, defaultnya adalah "https://atlas.microsoft.com". Jika tidak ada protokol yang ditentukan, misalnya "atlas.microsoft.com", maka https akan diasumsikan.

Detail Properti yang Diwariskan

mapsUrl

Nilai string URL dasar.

mapsUrl: string

Nilai Properti

string

Diwarisi DariMapsURL.mapsUrl

Detail Metode

getBuffer(Aborter, string | SpatialFeatureCollection, number[])

Mengembalikan FeatureCollection di mana setiap Fitur adalah buffer di sekitar Fitur input terindeks yang sesuai. Buffer dapat berada di luar atau di dalam Fitur yang disediakan, tergantung pada jarak yang disediakan dalam input. Harus ada satu jarak yang disediakan per Fitur dalam input FeatureCollection, atau jika hanya satu jarak yang disediakan, maka jarak tersebut diterapkan ke setiap Fitur dalam koleksi. Buffer positif (atau negatif) geometri didefinisikan sebagai jumlah Minkowski (atau perbedaan) geometri dengan lingkaran radius yang sama dengan nilai absolut jarak buffer. API buffer selalu mengembalikan hasil poligonal. Buffer garis dan titik negatif atau jarak nol selalu merupakan poligon kosong. Fitur input disediakan dalam permintaan atau oleh file GeoJSON yang diunggah melalui DATA Upload API dan direferensikan oleh udid unik. Data mungkin berisi kumpulan Point, MultiPoint, Polygon, MultiPolygon, LineString, dan MultiLineString. GeometryCollection akan diabaikan jika disediakan. Jika secara langsung menyediakan FeatureCollection penggunaan Post Buffer API: https://docs.microsoft.com/rest/api/maps/spatial/postbuffer

Jika tidak, gunakan Get Buffer API: https://docs.microsoft.com/rest/api/maps/spatial/getbuffer

function getBuffer(aborter: Aborter, udidOrFeatureCollection: string | SpatialFeatureCollection, distances: number[]): Promise<GetBufferResponse>

Parameter

aborter
Aborter

Buat instans Aborter baru dengan Aborter.none atau Aborter.timeout(), goto dokumen Aborter untuk contoh selengkapnya tentang pembatalan permintaan.

udidOrFeatureCollection

string | SpatialFeatureCollection

yang FeatureCollection berisi input atau id unik yang dikembalikan dari Data Upload API setelah mengunggah objek GeoJSON FeatureCollection yang valid. Silakan merujuk ke RFC 7946 untuk detailnya. Semua properti fitur harus berisi geometryId, yang digunakan untuk mengidentifikasi geometri dan peka huruf besar/kecil.

distances

number[]

Daftar jarak (satu per fitur atau satu untuk semua fitur). Jarak positif akan menghasilkan buffer di luar fitur, sedangkan jarak negatif akan menghasilkan buffer di dalam fitur. Jika jarak negatif lebih besar dari geometri itu sendiri, poligon kosong akan dikembalikan.

Mengembalikan

Promise<GetBufferResponse>

getClosestPoint(Aborter, GeoJSON.Position, string | SpatialFeatureCollection, GetClosestPointOptions)

Mengembalikan titik terdekat antara titik dasar dan set titik tertentu yang disediakan oleh data pengguna dalam permintaan atau dalam himpunan data yang diunggah pengguna yang diidentifikasi oleh udid. Jika menggunakan udid, kumpulan titik target disediakan oleh file GeoJSON yang diunggah melalui API Pengunggahan Data dan direferensikan oleh udid unik. File GeoJSON hanya boleh berisi kumpulan geometri Titik. MultiPoint atau geometri lainnya akan diabaikan jika disediakan. Jumlah maksimum poin yang diterima adalah 100.000. Algoritma tidak mempertimbangkan perutean atau lalu lintas. Informasi yang dikembalikan mencakup lintang titik terdekat, bujur, dan jarak dalam meter dari titik terdekat. Jika secara langsung menyediakan FeatureCollection penggunaan Post Closest Point API: https://docs.microsoft.com/rest/api/maps/spatial/postclosestpoint

Jika tidak, gunakan Get Closest Point API: https://docs.microsoft.com/rest/api/maps/spatial/getclosestpoint

function getClosestPoint(aborter: Aborter, position: GeoJSON.Position, udidOrFeatureCollection: string | SpatialFeatureCollection, options?: GetClosestPointOptions): Promise<GetClosesPointResponse>

Parameter

aborter
Aborter

Buat instans Aborter baru dengan Aborter.none atau Aborter.timeout(), goto dokumen Aborter untuk contoh selengkapnya tentang pembatalan permintaan.

position
GeoJSON.Position

Titik dasar.

udidOrFeatureCollection

string | SpatialFeatureCollection

yang FeatureCollection berisi titik target atau id unik yang dikembalikan dari API Pengunggahan Data setelah mengunggah objek GeoJSON FeatureCollection yang valid. Silakan merujuk ke RFC 7946 untuk detailnya. Semua properti fitur harus berisi geometryId, yang digunakan untuk mengidentifikasi geometri dan peka huruf besar/kecil.

options
GetClosestPointOptions

Mengembalikan

Promise<GetClosesPointResponse>

getGeofence(Aborter, string, string | SpatialFeatureCollection, GeoJSON.Position, GetGeofenceOptions)

Mengambil kedekatan koordinat ke geofence yang disediakan dalam permintaan atau yang telah diunggah ke layanan Data. Anda dapat menggunakan API Pengunggahan Data untuk mengunggah geofence atau set pagar. Lihat Data GeoJSON geofencing untuk detail selengkapnya tentang format data geofence. Untuk mengkueri kedekatan koordinat, Anda menyediakan lokasi objek yang Anda lacak serta ID untuk pagar atau set pagar, dan respons akan berisi informasi tentang jarak dari tepi luar geofence. Nilai negatif menandakan bahwa koordinat berada di dalam pagar sementara nilai positif berarti berada di luar pagar. API ini dapat digunakan untuk berbagai skenario yang mencakup hal-hal seperti pelacakan aset, manajemen armada, atau menyiapkan pemberitahuan untuk memindahkan objek. API mendukung integrasi dengan Event Grid. Parameter isAsync digunakan untuk mengaktifkan integrasi dengan Event Grid (dinonaktifkan secara default). Untuk menguji API ini, Anda dapat mengunggah data sampel dari contoh POST Geofence API (Request Body) melalui Data Upload API dan mengganti [udid] dari permintaan sampel di bawah ini dengan udid yang dikembalikan oleh Data Upload API.

Jika secara langsung menyediakan geofence menggunakan POST Geofence API: https://docs.microsoft.com/rest/api/maps/spatial/postgeofence

Jika tidak, gunakan Get Geofence API: https://docs.microsoft.com/en-us/rest/api/maps/spatial/getgeofence

Kode Geofencing InnerError

Dalam kontrak kesalahan respons geofencing, innererror adalah objek yang berisi informasi spesifik layanan tentang kesalahan. code adalah properti di innererror mana dapat memetakan ke jenis kesalahan geofencing tertentu. Tabel di bawah ini menunjukkan pemetaan kode antara semua jenis kesalahan klien yang diketahui ke kesalahan messagegeofencing yang sesuai .

innererror.code | error.message ---------------------------- | -------------------------------------- NullDeviceId | Id Perangkat tidak boleh null. NullUdid | Udid tidak boleh null. UdidWrongFormat| Udid harus diperoleh dari API penyerapan data pengguna. InvalidUserTime| Waktu pengguna tidak valid. InvalidSearchBuffer| Searchbuffer tidak valid. InvalidSearchRange| Rentang nilai searchbuffer harus dari 0 hingga 500 meter. InvalidLatLon| Parameter Lat dan/atau lon tidak valid. InvalidIsAsyncValue| Parameter IsAsync tidak valid. InvalidModeValue| Parameter mode tidak valid. InvalidJson| Data geofencing bukan file json yang valid. NotSupportedGeoJson| Data geofencing tidak dapat dibaca sebagai Fitur atau FeatureCollections. InvalidGeoJson| Data geofencing tidak valid. NoUserDataWithAccountOrSubscription| Tidak dapat menemukan data geofencing pengguna dengan id akun dan/atau id langganan yang disediakan. NoUserDataWithUdid| Tidak dapat menemukan data geofencing pengguna dengan udId yang disediakan.

function getGeofence(aborter: Aborter, deviceId: string, udidOrFeatureCollection: string | SpatialFeatureCollection, position: GeoJSON.Position, options?: GetGeofenceOptions): Promise<GetGeofenceResponse>

Parameter

aborter
Aborter

Buat instans Aborter baru dengan Aborter.none atau Aborter.timeout(), goto dokumen Aborter untuk contoh selengkapnya tentang pembatalan permintaan.

deviceId

string

ID perangkat

udidOrFeatureCollection

string | SpatialFeatureCollection

yang FeatureCollection berisi pagar atau id unik yang dikembalikan dari Data Upload API setelah mengunggah objek GeoJSON FeatureCollection yang valid. Silakan merujuk ke RFC 7946 untuk detailnya. Semua properti fitur harus berisi geometryId, yang digunakan untuk mengidentifikasi geometri dan peka huruf besar/kecil.

position
GeoJSON.Position

Lokasi sedang dilewati.

options
GetGeofenceOptions

Mengembalikan

Promise<GetGeofenceResponse>

getGreatCircleDistance(Aborter, [GeoJSON.Position, GeoJSON.Position])

Mengembalikan lingkaran besar atau jarak terpendek antara dua titik pada permukaan bola, diukur di sepanjang permukaan bola. Ini berbeda dari menghitung garis lurus melalui interior bola. Metode ini sangat membantu untuk memperkirakan jarak perjalanan untuk pesawat dengan menghitung jarak terpendek antara bandara. Menggunakan 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>

Parameter

aborter
Aborter

Buat instans Aborter baru dengan Aborter.none atau Aborter.timeout(), goto dokumen Aborter untuk contoh selengkapnya tentang pembatalan permintaan.

coordinates

[GeoJSON.Position, GeoJSON.Position]

Koordinat di mana jarak dihitung. Diperlukan dua koordinat. Yang pertama adalah koordinat titik sumber dan yang terakhir adalah koordinat titik target.

Mengembalikan

Promise<GetGreatCircleDistance>

getPointInPolygon(Aborter, string | SpatialFeatureCollection, GeoJSON.Position)

Mengembalikan apakah titik berada di dalam sekumpulan poligon. Kumpulan poligon disediakan dalam permintaan atau oleh file GeoJSON yang diunggah melalui API Pengunggahan Data dan direferensikan oleh udid unik. File GeoJSON mungkin berisi geometri Poligon dan MultiPolygon, geometri lain akan diabaikan jika disediakan. Jika titik berada di dalam atau di batas salah satu poligon ini, nilai yang dikembalikan adalah true. Dalam semua kasus lainnya, nilai yang dikembalikan adalah false. Ketika titik berada di dalam beberapa poligon, hasilnya akan memberikan bagian geometri yang bersinggungan untuk menampilkan semua geometri yang valid (dirujuk oleh geometryId) dalam data pengguna. Jumlah maksimum simpul yang diterima untuk membentuk Poligon adalah 10.000. Jika secara langsung menyediakan FeatureCollection penggunaan Post Point In Polygon API: https://docs.microsoft.com/rest/api/maps/spatial/postpointinpolygon

Jika tidak, gunakan GET Point In Polygon API: https://docs.microsoft.com/rest/api/maps/spatial/getpointinpolygon

function getPointInPolygon(aborter: Aborter, udidOrFeatureCollection: string | SpatialFeatureCollection, position: GeoJSON.Position): Promise<GetPointInPolygonResponse>

Parameter

aborter
Aborter

Buat instans Aborter baru dengan Aborter.none atau Aborter.timeout(), goto dokumen Aborter untuk contoh selengkapnya tentang pembatalan permintaan.

udidOrFeatureCollection

string | SpatialFeatureCollection

yang FeatureCollection berisi poligon atau id unik yang dikembalikan dari API Pengunggahan Data setelah mengunggah objek GeoJSON FeatureCollection yang valid. Silakan merujuk ke RFC 7946 untuk detailnya. Semua properti fitur harus berisi geometryId, yang digunakan untuk mengidentifikasi geometri dan peka huruf besar/kecil.

position
GeoJSON.Position

Titik dasar.

Mengembalikan

Promise<GetPointInPolygonResponse>

Detail Metode yang Diwarisi

newPipeline(Credential, INewPipelineOptions)

Metode statis yang digunakan untuk membuat objek Alur baru dengan Kredensial yang disediakan.

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipeline

Parameter

credential
Credential

Seperti SubscriptionKeyCredential, TokenCredential, dan MapControlCredential.

pipelineOptions
INewPipelineOptions

Mengembalikan

Pipeline

Objek Alur baru.

Diwarisi DariMapsURL.newPipeline