SpatialURL class

  • Referenz
Paket:
azure-maps-rest

Ein SpatialURL stellt eine URL zum Azure Maps räumlichen Vorgängen dar.

Extends
MapsURL

Konstruktoren

SpatialURL(Pipeline, string)

Erstellt eine instance von SpatialURL.

Geerbte Eigenschaften

mapsUrl

Basis-URL-Zeichenfolgenwert.

Methoden

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

Gibt eine FeatureCollection zurück, wobei jedes Feature ein Puffer um das entsprechende indizierte Feature der Eingabe ist. Der Puffer kann sich je nach dem in der Eingabe angegebenen Abstand entweder außen oder innen des bereitgestellten Features befinden. Es muss entweder eine Entfernung pro Feature in der FeatureCollection-Eingabe angegeben sein, oder wenn nur eine Entfernung angegeben wird, wird diese Entfernung auf jedes Feature in der Auflistung angewendet. Der positive (oder negative) Puffer einer Geometrie wird als Minkowski-Summe (oder Differenz) der Geometrie mit einem Radiuskreis definiert, der dem absoluten Wert des Pufferabstands entspricht. Die Puffer-API gibt immer ein polygonales Ergebnis zurück. Der Negative oder Nullabstandspuffer von Linien und Punkten ist immer ein leeres Polygon. Die Eingabefeatures werden in der Anforderung oder von einer GeoJSON-Datei bereitgestellt, die über die Datenupload-API hochgeladen und von einem eindeutigen udid referenziert wird. Die Daten können eine Sammlung von Point, MultiPoint, Polygon, MultiPolygon, LineString und MultiLineString enthalten. GeometryCollection wird ignoriert, wenn dies angegeben ist. Wenn direkt bereitgestellt wird, FeatureCollection wird die Post Buffer-API verwendet: https://docs.microsoft.com/rest/api/maps/spatial/postbuffer

Verwendet andernfalls die Get Buffer-API: https://docs.microsoft.com/rest/api/maps/spatial/getbuffer
getClosestPoint(Aborter, GeoJSON.Position, string | SpatialFeatureCollection, GetClosestPointOptions)

Gibt den nächstgelegenen Punkt zwischen einem Basispunkt und einem bestimmten Satz von Punkten zurück, die von Benutzerdaten in der Anforderung oder in einem von udid identifizierten Benutzerdatensatz bereitgestellt werden. Bei Verwendung einer udid wird der Satz von Zielpunkten von einer GeoJSON-Datei bereitgestellt, die über die Datenupload-API hochgeladen und von einem eindeutigen udid referenziert wird. Die GeoJSON-Datei darf nur eine Auflistung der Punktgeometrie enthalten. MultiPoint oder andere Geometrien werden ignoriert, wenn sie angegeben werden. Die maximale Anzahl der akzeptierten Punkte beträgt 100.000. Routing oder Datenverkehr werden vom Algorithmus nicht berücksichtigt. Die zurückgegebenen Informationen umfassen den nächsten Breitengrad, längengrad und entfernung in Metern vom nächstgelegenen Punkt. Wenn Die direkte Bereitstellung von verwendet FeatureCollection die Post Closest Point-API: https://docs.microsoft.com/rest/api/maps/spatial/postclosestpoint

Verwendet andernfalls die API zum Abrufen des nächstgelegenen Punkts: https://docs.microsoft.com/rest/api/maps/spatial/getclosestpoint
getGeofence(Aborter, string, string | SpatialFeatureCollection, GeoJSON.Position, GetGeofenceOptions)

Ruft die Nähe einer Koordinate zu einem Geofence ab, der in der Anforderung angegeben oder in den Datendienst hochgeladen wurde. Sie können die Datenupload-API verwenden, um einen Geofence oder eine Reihe von Zäunen hochzuladen. Weitere Informationen zum Geofence-Datenformat finden Sie unter Geofencing GeoJSON-Daten . Um die Nähe einer Koordinate abzufragen, geben Sie die Position des Objekts an, das Sie verfolgen, sowie die ID für den Zaun oder satz von Zäunen, und die Antwort enthält Informationen über die Entfernung vom äußeren Rand des Geofence. Ein negativer Wert bedeutet, dass sich die Koordinate innerhalb des Zauns befindet, während ein positiver Wert bedeutet, dass er sich außerhalb des Zauns befindet. Diese API kann für eine Vielzahl von Szenarien verwendet werden, z. B. Ressourcenverfolgung, Flottenverwaltung oder Einrichten von Warnungen für das Verschieben von Objekten. Die API unterstützt die Integration in Event Grid. Der IsAsync-Parameter wird verwendet, um die Integration in Event Grid zu aktivieren (standardmäßig deaktiviert). Zum Testen dieser API können Sie die Beispieldaten aus Beispielen der Post Geofence-API (Anforderungstext) über die Datenupload-API hochladen und die [udid] aus der folgenden Beispielanforderung durch die udid ersetzen, die von der Datenupload-API zurückgegeben wird.

Wenn der Geofence direkt bereitgestellt wird, wird die Post Geofence-API verwendet: https://docs.microsoft.com/rest/api/maps/spatial/postgeofence

Verwendet andernfalls die Get Geofence-API: https://docs.microsoft.com/en-us/rest/api/maps/spatial/getgeofence

Geofencing InnerError-Code

Im Geofencing-Antwortfehlervertrag ist ein Objekt, innererror das dienstspezifische Informationen zum Fehler enthält. code ist eine Eigenschaft, in innererror der einem bestimmten Geofencingfehlertyp zugeordnet werden kann. Die folgende Tabelle zeigt die Codezuordnung zwischen allen bekannten Clientfehlertypen und dem entsprechenden Geofencingfehler message.

innererror.code | error.message ---------------------------- | -------------------------------------- NullDeviceId | Die Geräte-ID sollte nicht NULL sein. NullUdid | Udid sollte nicht NULL sein. UdidWrongFormat| Udid sollte über die Benutzerdatenerfassungs-API abgerufen werden. InvalidUserTime| Usertime ist ungültig. InvalidSearchBuffer| Der Suchbuffer ist ungültig. InvalidSearchRange| Der Wertbereich des Suchbuffers sollte zwischen 0 und 500 Metern liegen. InvalidLatLon| Lat- und/oder lon-Parameter sind ungültig. InvalidIsAsyncValue| Der IsAsync-Parameter ist ungültig. InvalidModeValue| Der Modusparameter ist ungültig. InvalidJson| Das Geofencing von Daten ist keine gültige JSON-Datei. NotSupportedGeoJson| Geofencing-Daten können nicht als Feature oder FeatureCollections gelesen werden. InvalidGeoJson| Das Geofencing von Daten ist ungültig. NoUserDataWithAccountOrSubscription| Benutzergeofencingdaten mit der angegebenen Konto-ID und/oder Abonnement-ID können nicht gefunden werden. NoUserDataWithUdid| Benutzergeofencingdaten mit der bereitgestellten udId können nicht gefunden werden.
getGreatCircleDistance(Aborter, [GeoJSON.Position, GeoJSON.Position])

Gibt den großen Kreis oder den kürzesten Abstand zwischen zwei Punkten auf der Oberfläche einer Kugel zurück, gemessen entlang der Oberfläche der Kugel. Dies unterscheidet sich von der Berechnung einer geraden Linie durch das Innere der Kugel. Diese Methode ist hilfreich, um die Entfernungen für Flugzeuge zu schätzen, indem die kürzeste Entfernung zwischen Flughäfen berechnet wird. Verwendet die GET GREAT CIRCLE DISTANCE-API: https://docs.microsoft.com/rest/api/maps/spatial/getgreatcircledistance
getPointInPolygon(Aborter, string | SpatialFeatureCollection, GeoJSON.Position)

Gibt zurück, ob sich ein Punkt innerhalb einer Reihe von Polygonen befindet. Der Satz von Polygonen wird in der Anforderung oder von einer GeoJSON-Datei bereitgestellt, die über die Datenupload-API hochgeladen und von einem eindeutigen udid referenziert wird. Die GeoJSON-Datei kann Polygon- und MultiPolygongeometrien enthalten. Andere Geometrien werden ignoriert, wenn sie angegeben werden. Wenn sich der Punkt innerhalb oder an der Grenze eines dieser Polygone befindet, ist der zurückgegebene Wert true. In allen anderen Fällen ist der zurückgegebene Wert false. Wenn sich der Punkt in mehreren Polygonen befindet, gibt das Ergebnis einen abschnitt mit sich überschneidenden Geometrien, um alle gültigen Geometrien (auf die von geometryId verwiesen wird) in Benutzerdaten anzuzeigen. Die maximale Anzahl von Scheitelpunkten, die zum Bilden eines Polygons akzeptiert werden, beträgt 10.000. Wenn die direkte Bereitstellung der FeatureCollection die Post Point In Polygon-API verwendet: https://docs.microsoft.com/rest/api/maps/spatial/postpointinpolygon

Verwendet andernfalls die API zum Abrufen von Punkten in Polygonen: https://docs.microsoft.com/rest/api/maps/spatial/getpointinpolygon

Geerbte Methoden

newPipeline(Credential, INewPipelineOptions)

Eine statische Methode zum Erstellen eines neuen Pipelineobjekts mit bereitgestellten Anmeldeinformationen.

Details zum Konstruktor

SpatialURL(Pipeline, string)

Erstellt eine instance von SpatialURL.

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

Parameter

pipeline
Pipeline

Rufen Sie MapsURL.newPipeline() auf, um eine Standardpipeline zu erstellen oder eine benutzerdefinierte Pipeline bereitzustellen.

mapsUrl

string

Eine URL-Zeichenfolge, die auf Azure Maps Dienst zeigt. Der Standardwert ist "https://atlas.microsoft.com". Wenn kein Protokoll angegeben wird, z. B. "atlas.microsoft.com", https wird angenommen.

Geerbte Eigenschaftsdetails

mapsUrl

Basis-URL-Zeichenfolgenwert.

mapsUrl: string

Eigenschaftswert

string

Geerbt vonMapsURL.mapsUrl

Details zur Methode

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

Gibt eine FeatureCollection zurück, wobei jedes Feature ein Puffer um das entsprechende indizierte Feature der Eingabe ist. Der Puffer kann sich je nach dem in der Eingabe angegebenen Abstand entweder außen oder innen des bereitgestellten Features befinden. Es muss entweder eine Entfernung pro Feature in der FeatureCollection-Eingabe angegeben sein, oder wenn nur eine Entfernung angegeben wird, wird diese Entfernung auf jedes Feature in der Auflistung angewendet. Der positive (oder negative) Puffer einer Geometrie wird als Minkowski-Summe (oder Differenz) der Geometrie mit einem Radiuskreis definiert, der dem absoluten Wert des Pufferabstands entspricht. Die Puffer-API gibt immer ein polygonales Ergebnis zurück. Der Negative oder Nullabstandspuffer von Linien und Punkten ist immer ein leeres Polygon. Die Eingabefeatures werden in der Anforderung oder von einer GeoJSON-Datei bereitgestellt, die über die Datenupload-API hochgeladen und von einem eindeutigen udid referenziert wird. Die Daten können eine Sammlung von Point, MultiPoint, Polygon, MultiPolygon, LineString und MultiLineString enthalten. GeometryCollection wird ignoriert, wenn dies angegeben ist. Wenn direkt bereitgestellt wird, FeatureCollection wird die Post Buffer-API verwendet: https://docs.microsoft.com/rest/api/maps/spatial/postbuffer

Verwendet andernfalls die 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

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

udidOrFeatureCollection

string | SpatialFeatureCollection

Ein FeatureCollection , der die Eingaben oder die eindeutige ID enthält, die nach dem Hochladen eines gültigen GeoJSON FeatureCollection-Objekts von der Datenupload-API zurückgegeben wird. Weitere Informationen finden Sie unter RFC 7946 . Alle Eigenschaften des Features sollten enthalten geometryId, was zum Identifizieren der Geometrie verwendet wird und die Groß-/Kleinschreibung beachtet.

distances

number[]

Die Liste der Entfernungen (eine pro Feature oder eine für alle Features). Positive Entfernung generiert einen Puffer außerhalb des Features, während ein negativer Abstand einen Puffer innerhalb des Features generiert. Wenn der negative Abstand größer als die Geometrie selbst ist, wird ein leeres Polygon zurückgegeben.

Gibt zurück

Promise<GetBufferResponse>

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

Gibt den nächstgelegenen Punkt zwischen einem Basispunkt und einem bestimmten Satz von Punkten zurück, die von Benutzerdaten in der Anforderung oder in einem von udid identifizierten Benutzerdatensatz bereitgestellt werden. Bei Verwendung einer udid wird der Satz von Zielpunkten von einer GeoJSON-Datei bereitgestellt, die über die Datenupload-API hochgeladen und von einem eindeutigen udid referenziert wird. Die GeoJSON-Datei darf nur eine Auflistung der Punktgeometrie enthalten. MultiPoint oder andere Geometrien werden ignoriert, wenn sie angegeben werden. Die maximale Anzahl der akzeptierten Punkte beträgt 100.000. Routing oder Datenverkehr werden vom Algorithmus nicht berücksichtigt. Die zurückgegebenen Informationen umfassen den nächsten Breitengrad, längengrad und entfernung in Metern vom nächstgelegenen Punkt. Wenn Die direkte Bereitstellung von verwendet FeatureCollection die Post Closest Point-API: https://docs.microsoft.com/rest/api/maps/spatial/postclosestpoint

Verwendet andernfalls die API zum Abrufen des nächstgelegenen Punkts: 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

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

position
GeoJSON.Position

Der Ausgangspunkt.

udidOrFeatureCollection

string | SpatialFeatureCollection

Eine FeatureCollection , die die Zielpunkte oder die eindeutige ID enthält, die von der Datenupload-API nach dem Hochladen eines gültigen GeoJSON FeatureCollection-Objekts zurückgegeben wurde. Weitere Informationen finden Sie unter RFC 7946 . Alle Eigenschaften des Features sollten enthalten geometryId, was zum Identifizieren der Geometrie verwendet wird und die Groß-/Kleinschreibung beachtet.

options
GetClosestPointOptions

Gibt zurück

Promise<GetClosesPointResponse>

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

Ruft die Nähe einer Koordinate zu einem Geofence ab, der in der Anforderung angegeben oder in den Datendienst hochgeladen wurde. Sie können die Datenupload-API verwenden, um einen Geofence oder eine Reihe von Zäunen hochzuladen. Weitere Informationen zum Geofence-Datenformat finden Sie unter Geofencing GeoJSON-Daten . Um die Nähe einer Koordinate abzufragen, geben Sie die Position des Objekts an, das Sie verfolgen, sowie die ID für den Zaun oder satz von Zäunen, und die Antwort enthält Informationen über die Entfernung vom äußeren Rand des Geofence. Ein negativer Wert bedeutet, dass sich die Koordinate innerhalb des Zauns befindet, während ein positiver Wert bedeutet, dass er sich außerhalb des Zauns befindet. Diese API kann für eine Vielzahl von Szenarien verwendet werden, z. B. Ressourcenverfolgung, Flottenverwaltung oder Einrichten von Warnungen für das Verschieben von Objekten. Die API unterstützt die Integration in Event Grid. Der IsAsync-Parameter wird verwendet, um die Integration in Event Grid zu aktivieren (standardmäßig deaktiviert). Zum Testen dieser API können Sie die Beispieldaten aus Beispielen der Post Geofence-API (Anforderungstext) über die Datenupload-API hochladen und die [udid] aus der folgenden Beispielanforderung durch die udid ersetzen, die von der Datenupload-API zurückgegeben wird.

Wenn der Geofence direkt bereitgestellt wird, wird die Post Geofence-API verwendet: https://docs.microsoft.com/rest/api/maps/spatial/postgeofence

Verwendet andernfalls die Get Geofence-API: https://docs.microsoft.com/en-us/rest/api/maps/spatial/getgeofence

Geofencing InnerError-Code

Im Geofencing-Antwortfehlervertrag ist ein Objekt, innererror das dienstspezifische Informationen zum Fehler enthält. code ist eine Eigenschaft, in innererror der einem bestimmten Geofencingfehlertyp zugeordnet werden kann. Die folgende Tabelle zeigt die Codezuordnung zwischen allen bekannten Clientfehlertypen und dem entsprechenden Geofencingfehler message.

innererror.code | error.message ---------------------------- | -------------------------------------- NullDeviceId | Die Geräte-ID sollte nicht NULL sein. NullUdid | Udid sollte nicht NULL sein. UdidWrongFormat| Udid sollte über die Benutzerdatenerfassungs-API abgerufen werden. InvalidUserTime| Usertime ist ungültig. InvalidSearchBuffer| Der Suchbuffer ist ungültig. InvalidSearchRange| Der Wertbereich des Suchbuffers sollte zwischen 0 und 500 Metern liegen. InvalidLatLon| Lat- und/oder lon-Parameter sind ungültig. InvalidIsAsyncValue| Der IsAsync-Parameter ist ungültig. InvalidModeValue| Der Modusparameter ist ungültig. InvalidJson| Das Geofencing von Daten ist keine gültige JSON-Datei. NotSupportedGeoJson| Geofencing-Daten können nicht als Feature oder FeatureCollections gelesen werden. InvalidGeoJson| Das Geofencing von Daten ist ungültig. NoUserDataWithAccountOrSubscription| Benutzergeofencingdaten mit der angegebenen Konto-ID und/oder Abonnement-ID können nicht gefunden werden. NoUserDataWithUdid| Benutzergeofencingdaten mit der bereitgestellten udId können nicht gefunden werden.

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

Parameter

aborter
Aborter

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

deviceId

string

ID des Geräts

udidOrFeatureCollection

string | SpatialFeatureCollection

Eine FeatureCollection , die den Zaun oder die eindeutige ID enthält, die nach dem Hochladen eines gültigen GeoJSON FeatureCollection-Objekts von der Datenupload-API zurückgegeben wird. Weitere Informationen finden Sie unter RFC 7946 . Alle Eigenschaften des Features sollten enthalten geometryId, was zum Identifizieren der Geometrie verwendet wird und die Groß-/Kleinschreibung beachtet.

position
GeoJSON.Position

Der übergebene Speicherort.

options
GetGeofenceOptions

Gibt zurück

Promise<GetGeofenceResponse>

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

Gibt den großen Kreis oder den kürzesten Abstand zwischen zwei Punkten auf der Oberfläche einer Kugel zurück, gemessen entlang der Oberfläche der Kugel. Dies unterscheidet sich von der Berechnung einer geraden Linie durch das Innere der Kugel. Diese Methode ist hilfreich, um die Entfernungen für Flugzeuge zu schätzen, indem die kürzeste Entfernung zwischen Flughäfen berechnet wird. Verwendet die 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

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

coordinates

[GeoJSON.Position, GeoJSON.Position]

Die Koordinaten, mit denen der Abstand berechnet wird. Zwei Koordinaten sind erforderlich. Die erste ist die Quellpunktkoordinate und die letzte die Zielpunktkoordinate.

Gibt zurück

Promise<GetGreatCircleDistance>

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

Gibt zurück, ob sich ein Punkt innerhalb einer Reihe von Polygonen befindet. Der Satz von Polygonen wird in der Anforderung oder von einer GeoJSON-Datei bereitgestellt, die über die Datenupload-API hochgeladen und von einem eindeutigen udid referenziert wird. Die GeoJSON-Datei kann Polygon- und MultiPolygongeometrien enthalten. Andere Geometrien werden ignoriert, wenn sie angegeben werden. Wenn sich der Punkt innerhalb oder an der Grenze eines dieser Polygone befindet, ist der zurückgegebene Wert true. In allen anderen Fällen ist der zurückgegebene Wert false. Wenn sich der Punkt in mehreren Polygonen befindet, gibt das Ergebnis einen abschnitt mit sich überschneidenden Geometrien, um alle gültigen Geometrien (auf die von geometryId verwiesen wird) in Benutzerdaten anzuzeigen. Die maximale Anzahl von Scheitelpunkten, die zum Bilden eines Polygons akzeptiert werden, beträgt 10.000. Wenn die direkte Bereitstellung der FeatureCollection die Post Point In Polygon-API verwendet: https://docs.microsoft.com/rest/api/maps/spatial/postpointinpolygon

Verwendet andernfalls die API zum Abrufen von Punkten in Polygonen: https://docs.microsoft.com/rest/api/maps/spatial/getpointinpolygon

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

Parameter

aborter
Aborter

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

udidOrFeatureCollection

string | SpatialFeatureCollection

Eine FeatureCollection , die die Polygone oder die eindeutige ID enthält, die nach dem Hochladen eines gültigen GeoJSON FeatureCollection-Objekts von der Datenupload-API zurückgegeben wird. Weitere Informationen finden Sie unter RFC 7946 . Alle Eigenschaften des Features sollten enthalten geometryId, was zum Identifizieren der Geometrie verwendet wird und die Groß-/Kleinschreibung beachtet.

position
GeoJSON.Position

Der Ausgangspunkt.

Gibt zurück

Promise<GetPointInPolygonResponse>

Details zur geerbten Methode

newPipeline(Credential, INewPipelineOptions)

Eine statische Methode zum Erstellen eines neuen Pipelineobjekts mit bereitgestellten Anmeldeinformationen.

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

Parameter

credential
Credential

Beispielsweise SubscriptionKeyCredential, TokenCredential und MapControlCredential.

pipelineOptions
INewPipelineOptions

Gibt zurück

Pipeline

Ein neues Pipelineobjekt.

Geerbt vonMapsURL.newPipeline