Share via

SpatialURL class

  • Başvuru
Paket:
azure-maps-rest

SpatialURL, Azure Haritalar uzamsal işlemlerin URL'sini temsil eder.

Extends
MapsURL

Oluşturucular

SpatialURL(Pipeline, string)

SpatialURL örneği oluşturur.

Devralınan Özellikler

mapsUrl

Temel URL dize değeri.

Yöntemler

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

Her Özelliğin girişin ilgili dizinlenmiş Özelliği çevresinde bir arabellek olduğu bir FeatureCollection döndürür. Arabellek, girişte sağlanan mesafeye bağlı olarak sağlanan Özelliğin dışında veya içinde olabilir. FeatureCollection girişinde Özellik başına bir uzaklık sağlanmalı veya yalnızca bir mesafe sağlanmışsa, bu uzaklık koleksiyondaki her Özelliğe uygulanır. Geometrinin pozitif (veya negatif) arabelleği, geometrinin Minkowski toplamı (veya farkı) olarak tanımlanır ve arabelleğe uzaklığın mutlak değerine eşit yarıçap daireleri bulunur. Arabellek API'si her zaman çokgen bir sonuç döndürür. Çizgilerin ve noktaların negatif veya sıfır uzaklık arabelleği her zaman boş bir çokgendir. Giriş özellikleri istekte veya Veri Yükleme API'si aracılığıyla karşıya yüklenen ve benzersiz bir udid tarafından başvurulan bir GeoJSON dosyası tarafından sağlanır. Veriler Point, MultiPoint, Polygon, MultiPolygon, LineString ve MultiLineString koleksiyonlarını içerebilir. Sağlanırsa GeometryCollection yoksayılır. Doğrudan sağlama işlemi FeatureCollection Post Buffer API'sini kullanıyorsa: https://docs.microsoft.com/rest/api/maps/spatial/postbuffer

Aksi takdirde Get Buffer API'sini kullanır: https://docs.microsoft.com/rest/api/maps/spatial/getbuffer
getClosestPoint(Aborter, GeoJSON.Position, string | SpatialFeatureCollection, GetClosestPointOptions)

bir temel nokta ile istekteki veya udid tarafından tanımlanan kullanıcının karşıya yüklediği veri kümesinde kullanıcı verileri tarafından sağlanan belirli bir nokta kümesi arasındaki en yakın noktayı döndürür. udid kullanılıyorsa hedef nokta kümesi , Veri Yükleme API'si aracılığıyla karşıya yüklenen ve benzersiz bir udid tarafından başvurulan bir GeoJSON dosyası tarafından sağlanır. GeoJSON dosyası yalnızca Nokta geometrisi koleksiyonunu içerebilir. MultiPoint veya diğer geometriler sağlanırsa yoksayılır. Kabul edilen maksimum puan sayısı 100.000'dir. Algoritma yönlendirmeyi veya trafiği dikkate almaz. Döndürülen bilgiler en yakın nokta enlemini, boylamını ve en yakın noktadan metre olarak uzaklığı içerir. Doğrudan sağlama işlemi FeatureCollection En Yakın Nokta Sonrası API'sini kullanıyorsa: https://docs.microsoft.com/rest/api/maps/spatial/postclosestpoint

Aksi takdirde En Yakın Noktayı Al API'sini kullanır: https://docs.microsoft.com/rest/api/maps/spatial/getclosestpoint
getGeofence(Aborter, string, string | SpatialFeatureCollection, GeoJSON.Position, GetGeofenceOptions)

bir koordinatın istekte sağlanan veya Veri hizmetine yüklenmiş bir bölge sınırına yakınlığını alır. Coğrafi bölge veya çit kümesi yüklemek için Veri Yükleme API'sini kullanabilirsiniz. Coğrafi konum veri biçimi hakkında daha fazla ayrıntı için bkz. GeoJSON verilerini coğrafi sınırlama. Koordinatın yakınlığını sorgulamak için, izlediğiniz nesnenin konumunun yanı sıra çitin veya çit kümesinin kimliğini de sağlarsınız ve yanıt, coğrafi sınırın dış kenarından uzaklık hakkında bilgi içerir. Negatif bir değer, koordinatın çitin içinde olduğunu, pozitif bir değer ise çitin dışında olduğu anlamına gelir. Bu API varlık izleme, filo yönetimi veya nesneleri taşımak için uyarılar ayarlama gibi çeşitli senaryolar için kullanılabilir. API, Event Grid ile tümleştirmeyi destekler. isAsync parametresi Event Grid ile tümleştirmeyi etkinleştirmek için kullanılır (varsayılan olarak devre dışıdır). Bu API'yi test etmek için, Veri Yükleme API'sini kullanarak Post Geofence API örneklerinden (İstek Gövdesi) örnek verileri karşıya yükleyebilir ve aşağıdaki örnek istekten [udid] değerini Veri Yükleme API'sinin döndürdiği udid ile değiştirebilirsiniz.

Doğrudan coğrafi bölge sağlama işlemi Post Geofence API'sini kullanıyorsa: https://docs.microsoft.com/rest/api/maps/spatial/postgeofence

Aksi takdirde Get Geofence API'sini kullanır: https://docs.microsoft.com/en-us/rest/api/maps/spatial/getgeofence

InnerError kodunu coğrafi olarak sınırlama

Yanıt hata sözleşmesini coğrafi sınırlamada, innererror hata hakkında hizmete özgü bilgileri içeren bir nesnedir. code belirli bir coğrafi sınırlama hata türüne eşleyebileceğiniz bir özelliktir innererror . Aşağıdaki tabloda, bilinen tüm istemci hata türü ile ilgili coğrafi sınırlama hatası messagearasındaki kod eşlemesi gösterilmektedir.

innererror.code | error.message ---------------------------- | -------------------------------------- NullDeviceId | Cihaz Kimliği null olmamalıdır. NullUdid | Udid null olmamalıdır. UdidWrongFormat| Kullanıcı veri alımı API'sinden Udid alınmalıdır. InvalidUserTime| Usertime geçersiz. InvalidSearchBuffer| Searchbuffer geçersiz. InvalidSearchRange| Searchbuffer değeri aralığı 0 ile 500 metre arasında olmalıdır. InvalidLatLon| Lat ve/veya lon parametreleri geçersiz. InvalidIsAsyncValue| IsAsync parametresi geçersiz. InvalidModeValue| Mod parametresi geçersiz. InvalidJson| Verileri sınırlandırma geçerli bir json dosyası değil. NotSupportedGeoJson| Coğrafi sınırlama verileri Özellik veya FeatureCollections olarak okunamaz. InvalidGeoJson| Coğrafi sınırlama verileri geçersiz. NoUserDataWithAccountOrSubscription| Sağlanan hesap kimliği ve/veya abonelik kimliği ile kullanıcı bölge sınırlama verilerini bulamıyorum. NoUserDataWithUdid| Sağlanan udId ile kullanıcı coğrafi sınırlama verileri bulunamıyor.
getGreatCircleDistance(Aborter, [GeoJSON.Position, GeoJSON.Position])

Kürenin yüzeyi boyunca ölçülen kürenin yüzeyindeki iki nokta arasındaki büyük daireyi veya en kısa mesafeyi döndürür. Bu, kürenin iç kısmı boyunca düz bir çizgi hesaplamadan farklıdır. Bu yöntem, havaalanları arasındaki en kısa mesafeyi hesaplayarak uçakların seyahat mesafelerini tahmin etmek için yararlıdır. Get Great Circle Distance API'sini kullanır: https://docs.microsoft.com/rest/api/maps/spatial/getgreatcircledistance
getPointInPolygon(Aborter, string | SpatialFeatureCollection, GeoJSON.Position)

Bir noktanın çokgen kümesi içinde olup olmadığını döndürür. Çokgen kümesi istekte veya Veri Yükleme API'si aracılığıyla karşıya yüklenen ve benzersiz bir udid tarafından başvurulan bir GeoJSON dosyası tarafından sağlanır. GeoJSON dosyası Polygon ve MultiPolygon geometrileri içerebilir; sağlanan diğer geometriler yoksayılır. Nokta bu çokgenlerden birinin içinde veya sınırındaysa, döndürülen değer true olur. Diğer tüm durumlarda, döndürülen değer false olur. Nokta birden çok çokgen içinde olduğunda sonuç, kullanıcı verilerindeki tüm geçerli geometrileri (geometryId tarafından başvurulur) göstermek için kesişen geometriler bölümü verir. Çokgen oluşturmak için kabul edilen en fazla köşe sayısı 10.000'dir. Doğrudan sağlama, FeatureCollection ÇokGende Post Point API'sini kullanıyorsa: https://docs.microsoft.com/rest/api/maps/spatial/postpointinpolygon

Aksi takdirde ÇokGende Alma Noktası API'sini kullanır: https://docs.microsoft.com/rest/api/maps/spatial/getpointinpolygon

Devralınan Yöntemler

newPipeline(Credential, INewPipelineOptions)

Kimlik bilgileri sağlanmış yeni bir İşlem Hattı nesnesi oluşturmak için kullanılan statik bir yöntem.

Oluşturucu Ayrıntıları

SpatialURL(Pipeline, string)

SpatialURL örneği oluşturur.

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

Parametreler

pipeline
Pipeline

Varsayılan işlem hattı oluşturmak veya özelleştirilmiş bir işlem hattı sağlamak için MapsURL.newPipeline() çağrısı yapın.

mapsUrl

string

varsayılan olarak Azure Haritalar hizmetine işaret eden bir URL dizesidir"https://atlas.microsoft.com". Herhangi bir protokol belirtilmezse (örneğin "atlas.microsoft.com", ) https varsayılır.

Devralınan Özellik Detayları

mapsUrl

Temel URL dize değeri.

mapsUrl: string

Özellik Değeri

string

MapsURL.mapsUrl'denDevralındı

Yöntem Ayrıntıları

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

Her Özelliğin girişin ilgili dizinlenmiş Özelliği çevresinde bir arabellek olduğu bir FeatureCollection döndürür. Arabellek, girişte sağlanan mesafeye bağlı olarak sağlanan Özelliğin dışında veya içinde olabilir. FeatureCollection girişinde Özellik başına bir uzaklık sağlanmalı veya yalnızca bir mesafe sağlanmışsa, bu uzaklık koleksiyondaki her Özelliğe uygulanır. Geometrinin pozitif (veya negatif) arabelleği, geometrinin Minkowski toplamı (veya farkı) olarak tanımlanır ve arabelleğe uzaklığın mutlak değerine eşit yarıçap daireleri bulunur. Arabellek API'si her zaman çokgen bir sonuç döndürür. Çizgilerin ve noktaların negatif veya sıfır uzaklık arabelleği her zaman boş bir çokgendir. Giriş özellikleri istekte veya Veri Yükleme API'si aracılığıyla karşıya yüklenen ve benzersiz bir udid tarafından başvurulan bir GeoJSON dosyası tarafından sağlanır. Veriler Point, MultiPoint, Polygon, MultiPolygon, LineString ve MultiLineString koleksiyonlarını içerebilir. Sağlanırsa GeometryCollection yoksayılır. Doğrudan sağlama işlemi FeatureCollection Post Buffer API'sini kullanıyorsa: https://docs.microsoft.com/rest/api/maps/spatial/postbuffer

Aksi takdirde Get Buffer API'sini kullanır: https://docs.microsoft.com/rest/api/maps/spatial/getbuffer

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

Parametreler

aborter
Aborter

İstek iptali hakkında daha fazla örnek için Aborter.none veya Aborter.timeout() ile yeni bir Aborter örneği oluşturun.

udidOrFeatureCollection

string | SpatialFeatureCollection

FeatureCollection Geçerli bir GeoJSON FeatureCollection nesnesi karşıya yüklendikten sonra Veri Yükleme API'sinden döndürülen girişleri veya benzersiz kimliği içeren. Ayrıntılar için lütfen RFC 7946'ya bakın. Özelliğin tüm özellikleri, geometriyi tanımlamak için kullanılan ve büyük/küçük harfe duyarlı olan özelliklerini içermelidir geometryId.

distances

number[]

Uzaklık listesi (özellik başına bir veya tüm özellikler için bir tane). Pozitif uzaklık özelliğin dışında bir arabellek oluştururken, negatif uzaklık özelliğin içinde bir arabellek oluşturur. Negatif uzaklık geometrinin kendisinden büyükse boş bir çokgen döndürülür.

Döndürülenler

Promise<GetBufferResponse>

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

bir temel nokta ile istekteki veya udid tarafından tanımlanan kullanıcının karşıya yüklediği veri kümesinde kullanıcı verileri tarafından sağlanan belirli bir nokta kümesi arasındaki en yakın noktayı döndürür. udid kullanılıyorsa hedef nokta kümesi , Veri Yükleme API'si aracılığıyla karşıya yüklenen ve benzersiz bir udid tarafından başvurulan bir GeoJSON dosyası tarafından sağlanır. GeoJSON dosyası yalnızca Nokta geometrisi koleksiyonunu içerebilir. MultiPoint veya diğer geometriler sağlanırsa yoksayılır. Kabul edilen maksimum puan sayısı 100.000'dir. Algoritma yönlendirmeyi veya trafiği dikkate almaz. Döndürülen bilgiler en yakın nokta enlemini, boylamını ve en yakın noktadan metre olarak uzaklığı içerir. Doğrudan sağlama işlemi FeatureCollection En Yakın Nokta Sonrası API'sini kullanıyorsa: https://docs.microsoft.com/rest/api/maps/spatial/postclosestpoint

Aksi takdirde En Yakın Noktayı Al API'sini kullanır: https://docs.microsoft.com/rest/api/maps/spatial/getclosestpoint

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

Parametreler

aborter
Aborter

İstek iptali hakkında daha fazla örnek için Aborter.none veya Aborter.timeout() ile yeni bir Aborter örneği oluşturun.

position
GeoJSON.Position

Temel nokta.

udidOrFeatureCollection

string | SpatialFeatureCollection

FeatureCollection Geçerli bir GeoJSON FeatureCollection nesnesi karşıya yüklendikten sonra Veri Yükleme API'sinden döndürülen hedef noktaları veya benzersiz kimliği içeren. Ayrıntılar için lütfen RFC 7946'ya bakın. Özelliğin tüm özellikleri, geometriyi tanımlamak için kullanılan ve büyük/küçük harfe duyarlı olan özelliklerini içermelidir geometryId.

options
GetClosestPointOptions

Döndürülenler

Promise<GetClosesPointResponse>

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

bir koordinatın istekte sağlanan veya Veri hizmetine yüklenmiş bir bölge sınırına yakınlığını alır. Coğrafi bölge veya çit kümesi yüklemek için Veri Yükleme API'sini kullanabilirsiniz. Coğrafi konum veri biçimi hakkında daha fazla ayrıntı için bkz. GeoJSON verilerini coğrafi sınırlama. Koordinatın yakınlığını sorgulamak için, izlediğiniz nesnenin konumunun yanı sıra çitin veya çit kümesinin kimliğini de sağlarsınız ve yanıt, coğrafi sınırın dış kenarından uzaklık hakkında bilgi içerir. Negatif bir değer, koordinatın çitin içinde olduğunu, pozitif bir değer ise çitin dışında olduğu anlamına gelir. Bu API varlık izleme, filo yönetimi veya nesneleri taşımak için uyarılar ayarlama gibi çeşitli senaryolar için kullanılabilir. API, Event Grid ile tümleştirmeyi destekler. isAsync parametresi Event Grid ile tümleştirmeyi etkinleştirmek için kullanılır (varsayılan olarak devre dışıdır). Bu API'yi test etmek için, Veri Yükleme API'sini kullanarak Post Geofence API örneklerinden (İstek Gövdesi) örnek verileri karşıya yükleyebilir ve aşağıdaki örnek istekten [udid] değerini Veri Yükleme API'sinin döndürdiği udid ile değiştirebilirsiniz.

Doğrudan coğrafi bölge sağlama işlemi Post Geofence API'sini kullanıyorsa: https://docs.microsoft.com/rest/api/maps/spatial/postgeofence

Aksi takdirde Get Geofence API'sini kullanır: https://docs.microsoft.com/en-us/rest/api/maps/spatial/getgeofence

InnerError kodunu coğrafi olarak sınırlama

Yanıt hata sözleşmesini coğrafi sınırlamada, innererror hata hakkında hizmete özgü bilgileri içeren bir nesnedir. code belirli bir coğrafi sınırlama hata türüne eşleyebileceğiniz bir özelliktir innererror . Aşağıdaki tabloda, bilinen tüm istemci hata türü ile ilgili coğrafi sınırlama hatası messagearasındaki kod eşlemesi gösterilmektedir.

innererror.code | error.message ---------------------------- | -------------------------------------- NullDeviceId | Cihaz Kimliği null olmamalıdır. NullUdid | Udid null olmamalıdır. UdidWrongFormat| Kullanıcı veri alımı API'sinden Udid alınmalıdır. InvalidUserTime| Usertime geçersiz. InvalidSearchBuffer| Searchbuffer geçersiz. InvalidSearchRange| Searchbuffer değeri aralığı 0 ile 500 metre arasında olmalıdır. InvalidLatLon| Lat ve/veya lon parametreleri geçersiz. InvalidIsAsyncValue| IsAsync parametresi geçersiz. InvalidModeValue| Mod parametresi geçersiz. InvalidJson| Verileri sınırlandırma geçerli bir json dosyası değil. NotSupportedGeoJson| Coğrafi sınırlama verileri Özellik veya FeatureCollections olarak okunamaz. InvalidGeoJson| Coğrafi sınırlama verileri geçersiz. NoUserDataWithAccountOrSubscription| Sağlanan hesap kimliği ve/veya abonelik kimliği ile kullanıcı bölge sınırlama verilerini bulamıyorum. NoUserDataWithUdid| Sağlanan udId ile kullanıcı coğrafi sınırlama verileri bulunamıyor.

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

Parametreler

aborter
Aborter

İstek iptali hakkında daha fazla örnek için Aborter.none veya Aborter.timeout() ile yeni bir Aborter örneği oluşturun.

deviceId

string

Cihazın kimliği

udidOrFeatureCollection

string | SpatialFeatureCollection

FeatureCollection Geçerli bir GeoJSON FeatureCollection nesnesi karşıya yüklendikten sonra Veri Yükleme API'sinden döndürülen çiti veya benzersiz kimliği içeren. Ayrıntılar için lütfen RFC 7946'ya bakın. Özelliğin tüm özellikleri, geometriyi tanımlamak için kullanılan ve büyük/küçük harfe duyarlı olan öğesini içermelidir geometryId.

position
GeoJSON.Position

Geçirilmekte olan konum.

options
GetGeofenceOptions

Döndürülenler

Promise<GetGeofenceResponse>

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

Kürenin yüzeyi boyunca ölçülen kürenin yüzeyindeki iki nokta arasındaki büyük daireyi veya en kısa mesafeyi döndürür. Bu, kürenin iç kısmı boyunca düz bir çizgi hesaplamadan farklıdır. Bu yöntem, havaalanları arasındaki en kısa mesafeyi hesaplayarak uçakların seyahat mesafelerini tahmin etmek için yararlıdır. Get Great Circle Distance API'sini kullanır: https://docs.microsoft.com/rest/api/maps/spatial/getgreatcircledistance

function getGreatCircleDistance(aborter: Aborter, coordinates: [GeoJSON.Position, GeoJSON.Position]): Promise<GetGreatCircleDistance>

Parametreler

aborter
Aborter

İstek iptali hakkında daha fazla örnek için Aborter.none veya Aborter.timeout() ile yeni bir Aborter örneği oluşturun.

coordinates

[GeoJSON.Position, GeoJSON.Position]

Mesafenin hesaplandığı koordinatlar. İki koordinat gereklidir. Birincisi kaynak noktası koordinatı, sonuncusu ise hedef nokta koordinatıdır.

Döndürülenler

Promise<GetGreatCircleDistance>

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

Bir noktanın çokgen kümesi içinde olup olmadığını döndürür. Çokgen kümesi istekte veya Veri Yükleme API'si aracılığıyla karşıya yüklenen ve benzersiz bir udid tarafından başvurulan bir GeoJSON dosyası tarafından sağlanır. GeoJSON dosyası Polygon ve MultiPolygon geometrileri içerebilir; sağlanan diğer geometriler yoksayılır. Nokta bu çokgenlerden birinin içinde veya sınırındaysa, döndürülen değer true olur. Diğer tüm durumlarda, döndürülen değer false olur. Nokta birden çok çokgen içinde olduğunda sonuç, kullanıcı verilerindeki tüm geçerli geometrileri (geometryId tarafından başvurulur) göstermek için kesişen geometriler bölümü verir. Çokgen oluşturmak için kabul edilen en fazla köşe sayısı 10.000'dir. Doğrudan sağlama, FeatureCollection ÇokGende Post Point API'sini kullanıyorsa: https://docs.microsoft.com/rest/api/maps/spatial/postpointinpolygon

Aksi takdirde ÇokGende Alma Noktası API'sini kullanır: https://docs.microsoft.com/rest/api/maps/spatial/getpointinpolygon

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

Parametreler

aborter
Aborter

İstek iptali hakkında daha fazla örnek için Aborter.none veya Aborter.timeout() ile yeni bir Aborter örneği oluşturun.

udidOrFeatureCollection

string | SpatialFeatureCollection

FeatureCollection Geçerli bir GeoJSON FeatureCollection nesnesi karşıya yüklendikten sonra Veri Yükleme API'sinden döndürülen çokgenleri veya benzersiz kimliği içeren bir. Ayrıntılar için lütfen RFC 7946'ya bakın. Özelliğin tüm özellikleri, geometriyi tanımlamak için kullanılan ve büyük/küçük harfe duyarlı olan öğesini içermelidir geometryId.

position
GeoJSON.Position

Temel nokta.

Döndürülenler

Promise<GetPointInPolygonResponse>

Devralınan Yöntemin Ayrıntıları

newPipeline(Credential, INewPipelineOptions)

Kimlik bilgileri sağlanmış yeni bir İşlem Hattı nesnesi oluşturmak için kullanılan statik bir yöntem.

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

Parametreler

credential
Credential

SubscriptionKeyCredential, TokenCredential ve MapControlCredential gibi.

pipelineOptions
INewPipelineOptions

Döndürülenler

Pipeline

Yeni bir İşlem Hattı nesnesi.

MapsURL.newPipeline'denDevralındı