SpatialURL class
Um SpatialURL representa um URL para as operações espaciais Azure Maps.
- Extends
Construtores
| SpatialURL(Pipeline, string) | Cria uma instância do SpatialURL. |
Propriedades Herdadas
| maps |
Valor da cadeia de URL base. |
Métodos
| get |
Devolve uma FeatureCollection em que cada Funcionalidade é uma memória intermédia em torno da Funcionalidade indexada correspondente da entrada. A memória intermédia pode estar no exterior ou no interior da Funcionalidade fornecida, dependendo da distância fornecida na entrada. Tem de existir uma distância fornecida por Funcionalidade na entrada FeatureCollection ou, se for fornecida apenas uma distância, essa distância é aplicada a todas as Funcionalidades da coleção. A memória intermédia positiva (ou negativa) de uma geometria é definida como a soma minkowski (ou diferença) da geometria com um círculo de raio igual ao valor absoluto da distância da memória intermédia. A API de memória intermédia devolve sempre um resultado poligonal. A memória intermédia negativa ou de distância zero de linhas e pontos é sempre um polígono vazio. As funcionalidades de entrada são fornecidas no pedido ou por um ficheiro GeoJSON que é carregado através da API de Carregamento de Dados e referenciado por um udid exclusivo. Os dados podem conter uma coleção de Point, MultiPoint, Polygon, MultiPolygon, LineString e MultiLineString. GeometryCollection será ignorado se for fornecido.
Se o fornecimento direto utilizar a Caso contrário, utiliza a API Obter Memória Intermédia: https://docs.microsoft.com/rest/api/maps/spatial/getbuffer |
| get |
Devolve o ponto mais próximo entre um ponto base e um determinado conjunto de pontos fornecidos pelos dados do utilizador no pedido ou num conjunto de dados carregado pelo utilizador identificado pela udid.
Se utilizar um udid, o conjunto de pontos de destino é fornecido por um ficheiro GeoJSON que é carregado através da API de Carregamento de Dados e referenciado por um udid exclusivo. O ficheiro GeoJSON só pode conter uma coleção de geometria de Ponto. Se for fornecido, o MultiPoint ou outras geometrias serão ignoradas. O número máximo de pontos aceites é 100 000.
O algoritmo não tem em conta o encaminhamento ou o tráfego. As informações devolvidas incluem a latitude de ponto mais próxima, a longitude e a distância em metros a partir do ponto mais próximo.
Se fornecer diretamente a Caso contrário, utiliza a API Get Closest Point: https://docs.microsoft.com/rest/api/maps/spatial/getclosestpoint |
| get |
Obtém a proximidade de uma coordenada para um geofence fornecido no pedido ou que foi carregado para o serviço de Dados. Pode utilizar a API de Carregamento de Dados para carregar um perímetro geográfico ou um conjunto de cercas. Veja Geofencing GeoJSON data (Dados GeoJSON de Perímetro Geográfico) para obter mais detalhes sobre o formato de dados georreplicação. Para consultar a proximidade de uma coordenada, forneça a localização do objeto que está a controlar, bem como o ID da vedação ou conjunto de vedações e a resposta irá conter informações sobre a distância da margem externa do perímetro geográfico. Um valor negativo significa que a coordenada está dentro da vedação, enquanto um valor positivo significa que está fora da vedação. Esta API pode ser utilizada para uma variedade de cenários que incluem elementos como o controlo de recursos, a gestão de frotas ou a configuração de alertas para mover objetos. A API suporta a integração com o Event Grid. O parâmetro isAsync é utilizado para ativar a integração com o Event Grid (desativado por predefinição). Para testar esta API, pode carregar os dados de exemplo dos exemplos da API Post Geofence (Corpo do Pedido) através da API de Carregamento de Dados e substituir o [udid] do pedido de exemplo abaixo pelo udid devolvido pela API de Carregamento de Dados. Se o fornecimento direto do geofence utilizar a API Pós-Geofence: https://docs.microsoft.com/rest/api/maps/spatial/postgeofence Caso contrário, utiliza a API Get Geofence: https://docs.microsoft.com/en-us/rest/api/maps/spatial/getgeofence Geofencing InnerError code (Código InnerError de perímetro geográfico)No contrato de erro de resposta de perímetro geográfico, innererror.code | error.message ---------------------------- | -------------------------------------- NullDeviceId | O ID do dispositivo não deve ser nulo. NullUdid | A Udid não deve ser nula. UdidWrongFormat| A Udid deve ser adquirida a partir da API de ingestão de dados do utilizador. InvalidUserTime| O tempo de utilizador é inválido. InvalidSearchBuffer| Searchbuffer é inválido. InvalidSearchRange| O intervalo de valores de searchbuffer deve ser de 0 a 500 metros. InvalidLatLon| Os parâmetros lat e/ou lon são inválidos. InvalidIsAsyncValue| O parâmetro IsAsync é inválido. InvalidModeValue| O parâmetro de modo é inválido. InvalidJson| Os dados geográficos não são um ficheiro json válido. NotSupportedGeoJson| Os dados geográficos não podem ser lidos como uma Funcionalidade ou FeatureCollections. InvalidGeoJson| Os dados geográficos são inválidos. NoUserDataWithAccountOrSubscription| Não é possível localizar dados geográficos do utilizador com id de conta fornecido e/ou id de subscrição. NoUserDataWithUdid| Não é possível localizar dados geográficos do utilizador com o udId fornecido. |
| get |
Devolva o círculo grande ou a distância mais curta entre dois pontos na superfície de uma esfera, medida ao longo da superfície da esfera. Isto difere do cálculo de uma linha reta através do interior da esfera. Este método é útil para estimar as distâncias de viagem dos aviões ao calcular a distância mais curta entre aeroportos. Utiliza a API Obter Grande Distância Circular: https://docs.microsoft.com/rest/api/maps/spatial/getgreatcircledistance |
| get |
Devolve se um ponto está dentro de um conjunto de polígonos. O conjunto de polígonos é fornecido no pedido ou por um ficheiro GeoJSON que é carregado através da API de Carregamento de Dados e referenciado por um udid exclusivo. O ficheiro GeoJSON pode conter geometrias Polygon e MultiPolygon, caso sejam fornecidas outras geometrias. Se o ponto estiver dentro ou no limite de um destes polígonos, o valor devolvido é verdadeiro. Em todos os outros casos, o valor devolvido é falso. Quando o ponto está dentro de vários polígonos, o resultado dará a secção geometrias de intersecção para mostrar todas as geometrias válidas (referenciadas por geometryId) nos dados do utilizador. O número máximo de vértices aceites para formar um Polígono é 10 000.
Se fornecer diretamente a Caso contrário, utiliza a API Get Point In Polygon: https://docs.microsoft.com/rest/api/maps/spatial/getpointinpolygon |
Métodos Herdados
| new |
Um método estático utilizado para criar um novo objeto pipeline com Credencial fornecida. |
Detalhes do Construtor
SpatialURL(Pipeline, string)
Cria uma instância do SpatialURL.
new SpatialURL(pipeline: Pipeline, mapsUrl?: string)Parâmetros
- pipeline
- Pipeline
Chame MapsURL.newPipeline() para criar um pipeline predefinido ou forneça um pipeline personalizado.
- mapsUrl
-
string
Uma cadeia de URL a apontar para Azure Maps serviço, a predefinição é "https://atlas.microsoft.com".
Se não for especificado nenhum protocolo, por exemplo "atlas.microsoft.com", , https será assumido.
Detalhes da Propriedade Herdada
mapsUrl
Detalhes de Método
getBuffer(Aborter, string | SpatialFeatureCollection, number[])
Devolve uma FeatureCollection em que cada Funcionalidade é uma memória intermédia em torno da Funcionalidade indexada correspondente da entrada. A memória intermédia pode estar no exterior ou no interior da Funcionalidade fornecida, dependendo da distância fornecida na entrada. Tem de existir uma distância fornecida por Funcionalidade na entrada FeatureCollection ou, se for fornecida apenas uma distância, essa distância é aplicada a todas as Funcionalidades da coleção. A memória intermédia positiva (ou negativa) de uma geometria é definida como a soma minkowski (ou diferença) da geometria com um círculo de raio igual ao valor absoluto da distância da memória intermédia. A API de memória intermédia devolve sempre um resultado poligonal. A memória intermédia negativa ou de distância zero de linhas e pontos é sempre um polígono vazio. As funcionalidades de entrada são fornecidas no pedido ou por um ficheiro GeoJSON que é carregado através da API de Carregamento de Dados e referenciado por um udid exclusivo. Os dados podem conter uma coleção de Point, MultiPoint, Polygon, MultiPolygon, LineString e MultiLineString. GeometryCollection será ignorado se for fornecido.
Se o fornecimento direto utilizar a FeatureCollection API Pós-Memória Intermédia: https://docs.microsoft.com/rest/api/maps/spatial/postbuffer
Caso contrário, utiliza a API Obter Memória Intermédia: https://docs.microsoft.com/rest/api/maps/spatial/getbuffer
function getBuffer(aborter: Aborter, udidOrFeatureCollection: string | SpatialFeatureCollection, distances: number[]): Promise<GetBufferResponse>Parâmetros
- aborter
- Aborter
Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), documentos goto do Aborter para obter mais exemplos sobre o cancelamento do pedido.
- udidOrFeatureCollection
-
string | SpatialFeatureCollection
Um FeatureCollection que contém as entradas ou o ID exclusivo devolvido da API de Carregamento de Dados depois de carregar um objeto GeoJSON FeatureCollection válido. Consulte RFC 7946 para obter detalhes. Todas as propriedades da funcionalidade devem conter geometryId, que é utilizada para identificar a geometria e é sensível às maiúsculas e minúsculas.
- distances
-
number[]
A lista de distâncias (uma por funcionalidade ou outra para todas as funcionalidades). A distância positiva irá gerar uma memória intermédia fora da funcionalidade, enquanto a distância negativa irá gerar uma memória intermédia dentro da funcionalidade. Se a distância negativa maior do que a geometria em si, será devolvido um polígono vazio.
Devoluções
Promise<GetBufferResponse>
getClosestPoint(Aborter, GeoJSON.Position, string | SpatialFeatureCollection, GetClosestPointOptions)
Devolve o ponto mais próximo entre um ponto base e um determinado conjunto de pontos fornecidos pelos dados do utilizador no pedido ou num conjunto de dados carregado pelo utilizador identificado pela udid.
Se utilizar um udid, o conjunto de pontos de destino é fornecido por um ficheiro GeoJSON que é carregado através da API de Carregamento de Dados e referenciado por um udid exclusivo. O ficheiro GeoJSON só pode conter uma coleção de geometria de Ponto. Se for fornecido, o MultiPoint ou outras geometrias serão ignoradas. O número máximo de pontos aceites é 100 000.
O algoritmo não tem em conta o encaminhamento ou o tráfego. As informações devolvidas incluem a latitude de ponto mais próxima, a longitude e a distância em metros a partir do ponto mais próximo.
Se fornecer diretamente a FeatureCollection utiliza a API Post Closest Point: https://docs.microsoft.com/rest/api/maps/spatial/postclosestpoint
Caso contrário, utiliza a API Get Closest Point: https://docs.microsoft.com/rest/api/maps/spatial/getclosestpoint
function getClosestPoint(aborter: Aborter, position: GeoJSON.Position, udidOrFeatureCollection: string | SpatialFeatureCollection, options?: GetClosestPointOptions): Promise<GetClosesPointResponse>Parâmetros
- aborter
- Aborter
Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), documentos goto do Aborter para obter mais exemplos sobre o cancelamento do pedido.
- position
- GeoJSON.Position
O ponto base.
- udidOrFeatureCollection
-
string | SpatialFeatureCollection
Um FeatureCollection que contém os pontos de destino ou o ID exclusivo devolvido da API de Carregamento de Dados depois de carregar um objeto GeoJSON FeatureCollection válido. Consulte RFC 7946 para obter detalhes. Todas as propriedades da funcionalidade devem conter geometryId, que é utilizada para identificar a geometria e é sensível às maiúsculas e minúsculas.
- options
- GetClosestPointOptions
Devoluções
Promise<GetClosesPointResponse>
getGeofence(Aborter, string, string | SpatialFeatureCollection, GeoJSON.Position, GetGeofenceOptions)
Obtém a proximidade de uma coordenada para um geofence fornecido no pedido ou que foi carregado para o serviço de Dados. Pode utilizar a API de Carregamento de Dados para carregar um perímetro geográfico ou um conjunto de cercas. Veja Geofencing GeoJSON data (Dados GeoJSON de Perímetro Geográfico) para obter mais detalhes sobre o formato de dados georreplicação. Para consultar a proximidade de uma coordenada, forneça a localização do objeto que está a controlar, bem como o ID da vedação ou conjunto de vedações e a resposta irá conter informações sobre a distância da margem externa do perímetro geográfico. Um valor negativo significa que a coordenada está dentro da vedação, enquanto um valor positivo significa que está fora da vedação. Esta API pode ser utilizada para uma variedade de cenários que incluem elementos como o controlo de recursos, a gestão de frotas ou a configuração de alertas para mover objetos. A API suporta a integração com o Event Grid. O parâmetro isAsync é utilizado para ativar a integração com o Event Grid (desativado por predefinição). Para testar esta API, pode carregar os dados de exemplo dos exemplos da API Post Geofence (Corpo do Pedido) através da API de Carregamento de Dados e substituir o [udid] do pedido de exemplo abaixo pelo udid devolvido pela API de Carregamento de Dados.
Se o fornecimento direto do geofence utilizar a API Pós-Geofence: https://docs.microsoft.com/rest/api/maps/spatial/postgeofence
Caso contrário, utiliza a API Get Geofence: https://docs.microsoft.com/en-us/rest/api/maps/spatial/getgeofence
Geofencing InnerError code (Código InnerError de perímetro geográfico)
No contrato de erro de resposta de perímetro geográfico, innererror é um objeto que contém informações específicas do serviço sobre o erro. code é uma propriedade na innererror qual pode mapear para um tipo de erro de perímetro geográfico específico. A tabela abaixo mostra o mapeamento de código entre todo o tipo de erro de cliente conhecido para o erro messagede perímetro geográfico correspondente.
innererror.code | error.message ---------------------------- | -------------------------------------- NullDeviceId | O ID do dispositivo não deve ser nulo. NullUdid | A Udid não deve ser nula. UdidWrongFormat| A Udid deve ser adquirida a partir da API de ingestão de dados do utilizador. InvalidUserTime| O tempo de utilizador é inválido. InvalidSearchBuffer| Searchbuffer é inválido. InvalidSearchRange| O intervalo de valores de searchbuffer deve ser de 0 a 500 metros. InvalidLatLon| Os parâmetros lat e/ou lon são inválidos. InvalidIsAsyncValue| O parâmetro IsAsync é inválido. InvalidModeValue| O parâmetro de modo é inválido. InvalidJson| Os dados geográficos não são um ficheiro json válido. NotSupportedGeoJson| Os dados geográficos não podem ser lidos como uma Funcionalidade ou FeatureCollections. InvalidGeoJson| Os dados geográficos são inválidos. NoUserDataWithAccountOrSubscription| Não é possível localizar dados geográficos do utilizador com id de conta fornecido e/ou id de subscrição. NoUserDataWithUdid| Não é possível localizar dados geográficos do utilizador com o udId fornecido.
function getGeofence(aborter: Aborter, deviceId: string, udidOrFeatureCollection: string | SpatialFeatureCollection, position: GeoJSON.Position, options?: GetGeofenceOptions): Promise<GetGeofenceResponse>Parâmetros
- aborter
- Aborter
Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), documentos goto do Aborter para obter mais exemplos sobre o cancelamento do pedido.
- deviceId
-
string
ID do dispositivo
- udidOrFeatureCollection
-
string | SpatialFeatureCollection
Um FeatureCollection que contém a vedação ou o ID exclusivo devolvido da API de Carregamento de Dados depois de carregar um objeto GeoJSON FeatureCollection válido. Consulte RFC 7946 para obter detalhes. Todas as propriedades da funcionalidade devem conter geometryId, que é utilizada para identificar a geometria e é sensível às maiúsculas e minúsculas.
- position
- GeoJSON.Position
A localização a ser transmitida.
- options
- GetGeofenceOptions
Devoluções
Promise<GetGeofenceResponse>
getGreatCircleDistance(Aborter, [GeoJSON.Position, GeoJSON.Position])
Devolva o círculo grande ou a distância mais curta entre dois pontos na superfície de uma esfera, medida ao longo da superfície da esfera. Isto difere do cálculo de uma linha reta através do interior da esfera. Este método é útil para estimar as distâncias de viagem dos aviões ao calcular a distância mais curta entre aeroportos. Utiliza a API Obter Grande Distância Circular: https://docs.microsoft.com/rest/api/maps/spatial/getgreatcircledistance
function getGreatCircleDistance(aborter: Aborter, coordinates: [GeoJSON.Position, GeoJSON.Position]): Promise<GetGreatCircleDistance>Parâmetros
- aborter
- Aborter
Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), documentos goto do Aborter para obter mais exemplos sobre o cancelamento do pedido.
- coordinates
-
[GeoJSON.Position, GeoJSON.Position]
As coordenadas através das quais a distância é calculada. São necessárias duas coordenadas. A primeira é a coordenada do ponto de origem e a última é a coordenada do ponto de destino.
Devoluções
Promise<GetGreatCircleDistance>
getPointInPolygon(Aborter, string | SpatialFeatureCollection, GeoJSON.Position)
Devolve se um ponto está dentro de um conjunto de polígonos. O conjunto de polígonos é fornecido no pedido ou por um ficheiro GeoJSON que é carregado através da API de Carregamento de Dados e referenciado por um udid exclusivo. O ficheiro GeoJSON pode conter geometrias Polygon e MultiPolygon, caso sejam fornecidas outras geometrias. Se o ponto estiver dentro ou no limite de um destes polígonos, o valor devolvido é verdadeiro. Em todos os outros casos, o valor devolvido é falso. Quando o ponto está dentro de vários polígonos, o resultado dará a secção geometrias de intersecção para mostrar todas as geometrias válidas (referenciadas por geometryId) nos dados do utilizador. O número máximo de vértices aceites para formar um Polígono é 10 000.
Se fornecer diretamente a FeatureCollection utiliza a API Post Point In Polygon: https://docs.microsoft.com/rest/api/maps/spatial/postpointinpolygon
Caso contrário, utiliza a 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>Parâmetros
- aborter
- Aborter
Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), documentos goto do Aborter para obter mais exemplos sobre o cancelamento do pedido.
- udidOrFeatureCollection
-
string | SpatialFeatureCollection
Um FeatureCollection que contém os polígonos ou o ID exclusivo devolvido da API de Carregamento de Dados depois de carregar um objeto GeoJSON FeatureCollection válido. Consulte RFC 7946 para obter detalhes. Todas as propriedades da funcionalidade devem conter geometryId, que é utilizada para identificar a geometria e é sensível às maiúsculas e minúsculas.
- position
- GeoJSON.Position
O ponto base.
Devoluções
Promise<GetPointInPolygonResponse>
Detalhes do Método Herdado
newPipeline(Credential, INewPipelineOptions)
Um método estático utilizado para criar um novo objeto pipeline com Credencial fornecida.
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): PipelineParâmetros
- credential
- Credential
Como SubscriptionKeyCredential, TokenCredential e MapControlCredential.
- pipelineOptions
- INewPipelineOptions
Devoluções
Um novo objeto pipeline.
Herdado deMapsURL.newPipeline