SpatialURL class
SpatialURL představuje adresu URL Azure Maps prostorových operací.
- Extends
Konstruktory
SpatialURL(Pipeline, string) | Vytvoří instanci SpatialURL. |
Zděděné vlastnosti
maps |
Hodnota základního řetězce adresy URL |
Metody
get |
Vrátí hodnotu FeatureCollection, kde každá funkce je vyrovnávací pamětí kolem odpovídající indexované funkce vstupu. Vyrovnávací paměť může být buď na vnější straně, nebo uvnitř zadané funkce, v závislosti na vzdálenosti zadané ve vstupu. Ve vstupu FeatureCollection musí být k dispozici jedna vzdálenost pro každou funkci, nebo pokud je k dispozici pouze jedna vzdálenost, pak se tato vzdálenost použije pro každou funkci v kolekci. Kladný (nebo záporný) vyrovnávací paměť geometrie je definován jako Minkowskiho součet (nebo rozdíl) geometrie s kruhem o poloměru, který se rovná absolutní hodnotě vzdálenosti vyrovnávací paměti. Rozhraní API vyrovnávací paměti vždy vrátí polygonální výsledek. Vyrovnávací paměť řádků a bodů se zápornou nebo nulovou vzdáleností je vždy prázdný mnohoúhelník. Vstupní funkce jsou poskytovány v požadavku nebo prostřednictvím souboru GeoJSON, který se nahraje prostřednictvím rozhraní API pro nahrávání dat a odkazuje na něho jedinečný identifikátor. Data mohou obsahovat kolekci Point, MultiPoint, Polygon, MultiPolygon, LineString a MultiLineString. GeometryCollection bude ignorován, pokud je poskytnuta.
Pokud přímo zadáte , V opačném případě použije rozhraní API pro získání vyrovnávací paměti: https://docs.microsoft.com/rest/api/maps/spatial/getbuffer |
get |
Vrátí nejbližší bod mezi základním bodem a danou množinou bodů poskytovanou uživatelskými daty v požadavku nebo v sadě dat nahrané uživatelem identifikovanou podle udid.
Pokud používáte udid, sada cílových bodů je poskytována souborem GeoJSON, který se nahraje prostřednictvím rozhraní API pro nahrávání dat a odkazuje na něho jedinečný identifikátor udid. Soubor GeoJSON může obsahovat pouze kolekci geometrie bodu. MultiPoint nebo jiné geometrie budou ignorovány, pokud jsou zadané. Maximální počet přijatých bodů je 100 000.
Algoritmus nebere v úvahu směrování ani provoz. Vrácené informace zahrnují zeměpisnou šířku a délku nejbližšího bodu a vzdálenost v metrech od nejbližšího bodu.
Pokud přímo zadáte nástroj , V opačném případě použije rozhraní API Pro získání nejbližšího bodu: https://docs.microsoft.com/rest/api/maps/spatial/getclosestpoint |
get |
Načte vzdálenost souřadnice od geografické zóny zadané v požadavku nebo nahrané do datové služby. K nahrání geografické zóny nebo sady plotů můžete použít rozhraní API pro nahrávání dat. Další podrobnosti o formátu dat geografické zóny najdete v tématu Geofencing GeoJSON data. Pokud chcete zadat dotaz na blízkost souřadnic, zadejte umístění objektu, který sledujete, a ID plotu nebo sady plotů a odpověď bude obsahovat informace o vzdálenosti od vnějšího okraje geografické zóny. Záporná hodnota znamená, že souřadnice je uvnitř plotu, zatímco kladná hodnota znamená, že je mimo plot. Toto rozhraní API je možné použít pro různé scénáře, mezi které patří sledování majetku, správa vozového parku nebo nastavení upozornění na přesun objektů. Rozhraní API podporuje integraci se službou Event Grid. Parametr isAsync se používá k povolení integrace se službou Event Grid (ve výchozím nastavení je zakázaný). Pokud chcete toto rozhraní API otestovat, můžete nahrát ukázková data z příkladů rozhraní POST Geofence API (text požadavku) prostřednictvím rozhraní API pro nahrávání dat a nahradit [udid] z ukázkového požadavku níže za udid vrácenou rozhraním API pro nahrávání dat. Pokud přímé poskytnutí geografické zóny používá rozhraní POST Geofence API: https://docs.microsoft.com/rest/api/maps/spatial/postgeofence V opačném případě použije rozhraní API Pro získání geografické zóny: https://docs.microsoft.com/en-us/rest/api/maps/spatial/getgeofence Kód InnerError geografické fencingVe kontraktu chyby odpovědi geografické fencing je objekt obsahující innererror.code | error.message ---------------------------- | -------------------------------------- NullDeviceId | ID zařízení by nemělo být null. NullUdid | Udid by neměl být null. UdidWrongFormat| Udid by se měl získat z rozhraní API pro příjem uživatelských dat. InvalidUserTime | Čas uživatele je neplatný. InvalidSearchBuffer | Searchbuffer je neplatný. InvalidSearchRange | Rozsah hodnot searchbuffer by měl být od 0 do 500 metrů. InvalidLatLon| Parametry lat a/nebo lon jsou neplatné. InvalidIsAsyncValue| Parametr IsAsync je neplatný. InvalidModeValue| Parametr mode je neplatný. InvalidJson| Data geografické fencing nejsou platným souborem JSON. NotSupportedGeoJson| Data geografické fencing nelze číst jako funkce nebo funkce. InvalidGeoJson| Data geografické fencingu jsou neplatná. NoUserDataWithAccountOrSubscription| Nelze najít data geografické fencingu uživatelů se zadaným ID účtu nebo ID předplatného. NoUserDataWithUdid| Nejde najít data geografické fencingu uživatelů se zadaným udId. |
get |
Vrátí velký kruh nebo nejkratší vzdálenost mezi dvěma body na povrchu koule měřenou podél povrchu koule. To se liší od výpočtu přímky vnitřku koule. Tato metoda je užitečná pro odhad cestovních vzdáleností letadel pomocí výpočtu nejkratší vzdálenosti mezi letišti. Používá rozhraní API Get Great Circle Distance: https://docs.microsoft.com/rest/api/maps/spatial/getgreatcircledistance |
get |
Vrátí, zda je bod uvnitř sady mnohoúhelníků. Sada mnohoúhelníků je poskytována v požadavku nebo souborem GeoJSON, který se nahraje prostřednictvím rozhraní API pro nahrávání dat a odkazuje na něho jedinečný identifikátor udid. Soubor GeoJSON může obsahovat geometrie Polygon a MultiPolygon, ostatní geometrie budou ignorovány, pokud jsou k dispozici. Pokud je bod uvnitř nebo na hranici jednoho z těchto mnohoúhelníku, je vrácená hodnota true. Ve všech ostatních případech je vrácená hodnota false. Když je bod uvnitř více mnohoúhelníku, výsledek poskytne oddíl protínající se geometrie, který zobrazí všechny platné geometrie (odkazované pomocí geometryId) v uživatelských datech. Maximální počet vrcholů přijatých k vytvoření mnohoúhelníku je 10 000.
Pokud přímo poskytujete V opačném případě použije rozhraní API Get Point In Polygon: https://docs.microsoft.com/rest/api/maps/spatial/getpointinpolygon |
Zděděné metody
new |
Statická metoda používaná k vytvoření nového objektu pipeline se zadanými přihlašovacími údaji. |
Podrobnosti konstruktoru
SpatialURL(Pipeline, string)
Vytvoří instanci SpatialURL.
new SpatialURL(pipeline: Pipeline, mapsUrl?: string)
Parametry
- pipeline
- Pipeline
Volejte MapsURL.newPipeline() a vytvořte výchozí kanál nebo poskytněte vlastní kanál.
- mapsUrl
-
string
Řetězec adresy URL odkazující na službu Azure Maps, výchozí hodnota je "https://atlas.microsoft.com"
.
Pokud není zadaný žádný protokol, například "atlas.microsoft.com"
, https
bude se předpokládat.
Podrobnosti zděděných vlastností
mapsUrl
Hodnota základního řetězce adresy URL
mapsUrl: string
Hodnota vlastnosti
string
Zděděno zmapsURL.mapsUrl
Podrobnosti metody
getBuffer(Aborter, string | SpatialFeatureCollection, number[])
Vrátí hodnotu FeatureCollection, kde každá funkce je vyrovnávací pamětí kolem odpovídající indexované funkce vstupu. Vyrovnávací paměť může být buď na vnější straně, nebo uvnitř zadané funkce, v závislosti na vzdálenosti zadané ve vstupu. Ve vstupu FeatureCollection musí být k dispozici jedna vzdálenost pro každou funkci, nebo pokud je k dispozici pouze jedna vzdálenost, pak se tato vzdálenost použije pro každou funkci v kolekci. Kladný (nebo záporný) vyrovnávací paměť geometrie je definován jako Minkowskiho součet (nebo rozdíl) geometrie s kruhem o poloměru, který se rovná absolutní hodnotě vzdálenosti vyrovnávací paměti. Rozhraní API vyrovnávací paměti vždy vrátí polygonální výsledek. Vyrovnávací paměť řádků a bodů se zápornou nebo nulovou vzdáleností je vždy prázdný mnohoúhelník. Vstupní funkce jsou poskytovány v požadavku nebo prostřednictvím souboru GeoJSON, který se nahraje prostřednictvím rozhraní API pro nahrávání dat a odkazuje na něho jedinečný identifikátor. Data mohou obsahovat kolekci Point, MultiPoint, Polygon, MultiPolygon, LineString a MultiLineString. GeometryCollection bude ignorován, pokud je poskytnuta.
Pokud přímo zadáte , FeatureCollection
použije se rozhraní POST BUFFER API: https://docs.microsoft.com/rest/api/maps/spatial/postbuffer
V opačném případě použije rozhraní API pro získání vyrovnávací paměti: https://docs.microsoft.com/rest/api/maps/spatial/getbuffer
function getBuffer(aborter: Aborter, udidOrFeatureCollection: string | SpatialFeatureCollection, distances: number[]): Promise<GetBufferResponse>
Parametry
- aborter
- Aborter
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), další příklady zrušení požadavku najdete v dokumentech Aborter.
- udidOrFeatureCollection
-
string | SpatialFeatureCollection
Obsahující FeatureCollection
vstupy nebo jedinečné ID vrácené z rozhraní API pro nahrávání dat po nahrání platného objektu GeoJSON FeatureCollection. Podrobnosti najdete v dokumentu RFC 7946 . Všechny vlastnosti prvku by měly obsahovat geometryId
, který slouží k identifikaci geometrie a rozlišuje malá a velká písmena.
- distances
-
number[]
Seznam vzdáleností (jedna na součást nebo jedna pro všechny funkce) Kladná vzdálenost vygeneruje vyrovnávací paměť mimo funkci, zatímco záporná vzdálenost vygeneruje vyrovnávací paměť uvnitř funkce. Pokud je záporná vzdálenost větší než samotná geometrie, vrátí se prázdný mnohoúhelník.
Návraty
Promise<GetBufferResponse>
getClosestPoint(Aborter, GeoJSON.Position, string | SpatialFeatureCollection, GetClosestPointOptions)
Vrátí nejbližší bod mezi základním bodem a danou množinou bodů poskytovanou uživatelskými daty v požadavku nebo v sadě dat nahrané uživatelem identifikovanou podle udid.
Pokud používáte udid, sada cílových bodů je poskytována souborem GeoJSON, který se nahraje prostřednictvím rozhraní API pro nahrávání dat a odkazuje na něho jedinečný identifikátor udid. Soubor GeoJSON může obsahovat pouze kolekci geometrie bodu. MultiPoint nebo jiné geometrie budou ignorovány, pokud jsou zadané. Maximální počet přijatých bodů je 100 000.
Algoritmus nebere v úvahu směrování ani provoz. Vrácené informace zahrnují zeměpisnou šířku a délku nejbližšího bodu a vzdálenost v metrech od nejbližšího bodu.
Pokud přímo zadáte nástroj , FeatureCollection
použije se rozhraní POST Closest Point API: https://docs.microsoft.com/rest/api/maps/spatial/postclosestpoint
V opačném případě použije rozhraní API Pro získání nejbližšího bodu: https://docs.microsoft.com/rest/api/maps/spatial/getclosestpoint
function getClosestPoint(aborter: Aborter, position: GeoJSON.Position, udidOrFeatureCollection: string | SpatialFeatureCollection, options?: GetClosestPointOptions): Promise<GetClosesPointResponse>
Parametry
- aborter
- Aborter
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), další příklady zrušení požadavku najdete v dokumentech Aborter.
- position
- GeoJSON.Position
Základní bod.
- udidOrFeatureCollection
-
string | SpatialFeatureCollection
Obsahující FeatureCollection
cílové body nebo jedinečné ID vrácené z rozhraní API pro nahrávání dat po nahrání platného objektu GeoJSON FeatureCollection. Podrobnosti najdete v dokumentu RFC 7946 . Všechny vlastnosti prvku by měly obsahovat geometryId
, který slouží k identifikaci geometrie a rozlišuje malá a velká písmena.
- options
- GetClosestPointOptions
Návraty
Promise<GetClosesPointResponse>
getGeofence(Aborter, string, string | SpatialFeatureCollection, GeoJSON.Position, GetGeofenceOptions)
Načte vzdálenost souřadnice od geografické zóny zadané v požadavku nebo nahrané do datové služby. K nahrání geografické zóny nebo sady plotů můžete použít rozhraní API pro nahrávání dat. Další podrobnosti o formátu dat geografické zóny najdete v tématu Geofencing GeoJSON data. Pokud chcete zadat dotaz na blízkost souřadnic, zadejte umístění objektu, který sledujete, a ID plotu nebo sady plotů a odpověď bude obsahovat informace o vzdálenosti od vnějšího okraje geografické zóny. Záporná hodnota znamená, že souřadnice je uvnitř plotu, zatímco kladná hodnota znamená, že je mimo plot. Toto rozhraní API je možné použít pro různé scénáře, mezi které patří sledování majetku, správa vozového parku nebo nastavení upozornění na přesun objektů. Rozhraní API podporuje integraci se službou Event Grid. Parametr isAsync se používá k povolení integrace se službou Event Grid (ve výchozím nastavení je zakázaný). Pokud chcete toto rozhraní API otestovat, můžete nahrát ukázková data z příkladů rozhraní POST Geofence API (text požadavku) prostřednictvím rozhraní API pro nahrávání dat a nahradit [udid] z ukázkového požadavku níže za udid vrácenou rozhraním API pro nahrávání dat.
Pokud přímé poskytnutí geografické zóny používá rozhraní POST Geofence API: https://docs.microsoft.com/rest/api/maps/spatial/postgeofence
V opačném případě použije rozhraní API Pro získání geografické zóny: https://docs.microsoft.com/en-us/rest/api/maps/spatial/getgeofence
Kód InnerError geografické fencing
Ve kontraktu chyby odpovědi geografické fencing je objekt obsahující innererror
informace o chybě specifické pro službu. code
je vlastnost, ve innererror
které se může mapovat na konkrétní typ chyby geografické fencing. Následující tabulka ukazuje mapování kódu mezi všemi známými typy chyb klienta na odpovídající chybu message
geografické fencing .
innererror.code | error.message ---------------------------- | -------------------------------------- NullDeviceId | ID zařízení by nemělo být null. NullUdid | Udid by neměl být null. UdidWrongFormat| Udid by se měl získat z rozhraní API pro příjem uživatelských dat. InvalidUserTime | Čas uživatele je neplatný. InvalidSearchBuffer | Searchbuffer je neplatný. InvalidSearchRange | Rozsah hodnot searchbuffer by měl být od 0 do 500 metrů. InvalidLatLon| Parametry lat a/nebo lon jsou neplatné. InvalidIsAsyncValue| Parametr IsAsync je neplatný. InvalidModeValue| Parametr mode je neplatný. InvalidJson| Data geografické fencing nejsou platným souborem JSON. NotSupportedGeoJson| Data geografické fencing nelze číst jako funkce nebo funkce. InvalidGeoJson| Data geografické fencingu jsou neplatná. NoUserDataWithAccountOrSubscription| Nelze najít data geografické fencingu uživatelů se zadaným ID účtu nebo ID předplatného. NoUserDataWithUdid| Nejde najít data geografické fencingu uživatelů se zadaným udId.
function getGeofence(aborter: Aborter, deviceId: string, udidOrFeatureCollection: string | SpatialFeatureCollection, position: GeoJSON.Position, options?: GetGeofenceOptions): Promise<GetGeofenceResponse>
Parametry
- aborter
- Aborter
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), získat dokumenty Aborter, kde najdete další příklady zrušení žádosti.
- deviceId
-
string
ID zařízení
- udidOrFeatureCollection
-
string | SpatialFeatureCollection
Obsahující FeatureCollection
plot nebo jedinečné ID vrácené z rozhraní API pro nahrávání dat po nahrání platného objektu GeoJSON FeatureCollection. Podrobnosti najdete v dokumentu RFC 7946 . Všechny vlastnosti funkce by měly obsahovat geometryId
, který se používá k identifikaci geometrie a rozlišuje velká a malá písmena.
- position
- GeoJSON.Position
Umístění, které se předává.
- options
- GetGeofenceOptions
Návraty
Promise<GetGeofenceResponse>
getGreatCircleDistance(Aborter, [GeoJSON.Position, GeoJSON.Position])
Vrátí velký kruh nebo nejkratší vzdálenost mezi dvěma body na povrchu koule měřenou podél povrchu koule. To se liší od výpočtu přímky vnitřku koule. Tato metoda je užitečná pro odhad cestovních vzdáleností letadel pomocí výpočtu nejkratší vzdálenosti mezi letišti. Používá rozhraní API Get Great Circle Distance: https://docs.microsoft.com/rest/api/maps/spatial/getgreatcircledistance
function getGreatCircleDistance(aborter: Aborter, coordinates: [GeoJSON.Position, GeoJSON.Position]): Promise<GetGreatCircleDistance>
Parametry
- aborter
- Aborter
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), získat dokumenty Aborter, kde najdete další příklady zrušení žádosti.
- coordinates
-
[GeoJSON.Position, GeoJSON.Position]
Souřadnice, přes které se vzdálenost vypočítá. Vyžadují se dvě souřadnice. První je souřadnice zdrojového bodu a poslední je souřadnice cílového bodu.
Návraty
Promise<GetGreatCircleDistance>
getPointInPolygon(Aborter, string | SpatialFeatureCollection, GeoJSON.Position)
Vrátí, zda je bod uvnitř sady mnohoúhelníků. Sada mnohoúhelníků je poskytována v požadavku nebo souborem GeoJSON, který se nahraje prostřednictvím rozhraní API pro nahrávání dat a odkazuje na něho jedinečný identifikátor udid. Soubor GeoJSON může obsahovat geometrie Polygon a MultiPolygon, ostatní geometrie budou ignorovány, pokud jsou k dispozici. Pokud je bod uvnitř nebo na hranici jednoho z těchto mnohoúhelníku, je vrácená hodnota true. Ve všech ostatních případech je vrácená hodnota false. Když je bod uvnitř více mnohoúhelníku, výsledek poskytne oddíl protínající se geometrie, který zobrazí všechny platné geometrie (odkazované pomocí geometryId) v uživatelských datech. Maximální počet vrcholů přijatých k vytvoření mnohoúhelníku je 10 000.
Pokud přímo poskytujete FeatureCollection
rozhraní API post point in polygon: https://docs.microsoft.com/rest/api/maps/spatial/postpointinpolygon
V opačném případě použije rozhraní API Get Point In Polygon: https://docs.microsoft.com/rest/api/maps/spatial/getpointinpolygon
function getPointInPolygon(aborter: Aborter, udidOrFeatureCollection: string | SpatialFeatureCollection, position: GeoJSON.Position): Promise<GetPointInPolygonResponse>
Parametry
- aborter
- Aborter
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), získat dokumenty Aborter, kde najdete další příklady zrušení žádosti.
- udidOrFeatureCollection
-
string | SpatialFeatureCollection
Obsahuje FeatureCollection
mnohoúhelníky nebo jedinečné ID vrácené z rozhraní API pro nahrávání dat po nahrání platného objektu GeoJSON FeatureCollection. Podrobnosti najdete v dokumentu RFC 7946 . Všechny vlastnosti funkce by měly obsahovat geometryId
, který se používá k identifikaci geometrie a rozlišuje velká a malá písmena.
- position
- GeoJSON.Position
Základní bod.
Návraty
Promise<GetPointInPolygonResponse>
Podrobnosti zděděných metod
newPipeline(Credential, INewPipelineOptions)
Statická metoda používaná k vytvoření nového objektu pipeline se zadanými přihlašovacími údaji.
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipeline
Parametry
- credential
- Credential
Například SubscriptionKeyCredential, TokenCredential a MapControlCredential.
- pipelineOptions
- INewPipelineOptions
Návraty
Nový objekt kanálu.
Zděděno zMapsURL.newPipeline