SpatialURL class
Uma SpatialURL representa uma URL para as operações espaciais Azure Mapas.
- Extends
Construtores
| SpatialURL(Pipeline, string) | Cria uma instância de SpatialURL. |
Propriedades herdadas
| maps |
Valor da cadeia de caracteres de URL base. |
Métodos
| get |
Retorna um FeatureCollection em que cada Recurso é um buffer em torno do Recurso indexado correspondente da entrada. O buffer pode estar por fora ou dentro do Recurso fornecido, dependendo da distância fornecida na entrada. Deve haver uma distância fornecida por Recurso na entrada FeatureCollection ou, se apenas uma distância for fornecida, essa distância será aplicada a cada Recurso da coleção. O buffer positivo (ou negativo) de uma geometria é definido como a soma minkowski (ou diferença) da geometria com um círculo de raio igual ao valor absoluto da distância do buffer. A API de buffer sempre retorna um resultado poligonal. O buffer negativo ou de distância zero de linhas e pontos é sempre um polígono vazio. Os recursos de entrada são fornecidos na solicitação ou por um arquivo GeoJSON que é carregado por meio 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 for fornecido diretamente, o Caso contrário, usa a API Obter Buffer: https://docs.microsoft.com/rest/api/maps/spatial/getbuffer |
| get |
Retorna o ponto mais próximo entre um ponto base e um determinado conjunto de pontos fornecidos pelos dados do usuário na solicitação ou em um conjunto de dados carregado pelo usuário identificado pelo udid.
Se estiver usando um udid, o conjunto de pontos de destino será fornecido por um arquivo GeoJSON que é carregado por meio da API de Carregamento de Dados e referenciado por um udid exclusivo. O arquivo GeoJSON pode conter apenas uma coleção de geometria point. MultiPoint ou outras geometrias serão ignoradas se fornecidos. O número máximo de pontos aceitos é 100.000.
O algoritmo não leva em conta o roteamento ou o tráfego. As informações retornadas incluem latitude de ponto mais próxima, longitude e distância em metros do ponto mais próximo.
Se fornecer diretamente o, o Caso contrário, usa a API Obter Ponto Mais Próximo: https://docs.microsoft.com/rest/api/maps/spatial/getclosestpoint |
| get |
Recupera a proximidade de uma coordenada para uma cerca geográfica fornecida na solicitação ou que foi carregada no serviço De dados. Você pode usar a API de Carregamento de Dados para carregar uma cerca geográfica ou um conjunto de cercas. Consulte Geofencing GeoJSON data for more details on the geofence data format. Para consultar a proximidade de uma coordenada, forneça o local do objeto que você está rastreando, bem como a ID da cerca ou conjunto de cercas, e a resposta conterá informações sobre a distância da borda externa da cerca geográfica. Um valor negativo significa que a coordenada está dentro da cerca, enquanto um valor positivo significa que ela está fora da cerca. Essa API pode ser usada para uma variedade de cenários que incluem itens como acompanhamento de ativos, gerenciamento de frota ou configuração de alertas para mover objetos. A API dá suporte à integração com a Grade de Eventos. O parâmetro isAsync é usado para habilitar a integração com a Grade de Eventos (desabilitada por padrão). Para testar essa API, você pode carregar os dados de exemplo dos exemplos da API post geofence (Corpo da Solicitação) por meio da API de Carregamento de Dados e substituir o [udid] da solicitação de exemplo abaixo pelo udid retornado pela API de Carregamento de Dados. Se o fornecimento direto da cerca geográfica usar a API post geofence: https://docs.microsoft.com/rest/api/maps/spatial/postgeofence Caso contrário, usa a API Get Geofence: https://docs.microsoft.com/en-us/rest/api/maps/spatial/getgeofence Código InnerError de cerca geográficaNo contrato de erro de resposta de cerca geográfica, innererror.code | error.message ---------------------------- | -------------------------------------- NullDeviceId | A ID do dispositivo não deve ser nula. NullUdid | Udid não deve ser nulo. UdidWrongFormat| A Udid deve ser adquirida da API de ingestão de dados do usuário. InvalidUserTime| O tempo de usuário é inválido. InvalidSearchBuffer| Searchbuffer é inválido. InvalidSearchRange| O intervalo de valor do searchbuffer deve ser de 0 a 500 metros. InvalidLatLon| 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 de geofencing não são um arquivo json válido. NotSupportedGeoJson| Os dados de cerca geográfica não podem ser lidos como um Recurso ou FeatureCollections. InvalidGeoJson| Os dados de cerca geográfica são inválidos. NoUserDataWithAccountOrSubscription| Não é possível encontrar dados de cerca geográfica do usuário com id de conta e/ou id de assinatura fornecidos. NoUserDataWithUdid| Não é possível encontrar dados de cerca geográfica do usuário com udId fornecido. |
| get |
Retorne o grande círculo ou a distância mais curta entre dois pontos na superfície de uma esfera, medida ao longo da superfície da esfera. Isso difere do cálculo de uma linha reta pelo interior da esfera. Esse método é útil para estimar as distâncias de viagem para aviões calculando a distância mais curta entre os aeroportos. Usa a API Obter Grande Distância do Círculo: https://docs.microsoft.com/rest/api/maps/spatial/getgreatcircledistance |
| get |
Retorna se um ponto está dentro de um conjunto de polígonos. O conjunto de polígonos é fornecido na solicitação ou por um arquivo GeoJSON que é carregado por meio da API de Carregamento de Dados e referenciado por um udid exclusivo. O arquivo GeoJSON pode conter geometrias Polygon e MultiPolygon, outras geometrias serão ignoradas se fornecidas. Se o ponto estiver dentro ou no limite de um desses polígonos, o valor retornado será true. Em todos os outros casos, o valor retornado é false. Quando o ponto estiver dentro de vários polígonos, o resultado fornecerá a seção geometrias interseccionais para mostrar todas as geometrias válidas (referenciadas por geometryId) nos dados do usuário. O número máximo de vértices aceitos para formar um Polígono é 10.000.
Se fornecer diretamente o Caso contrário, usa a API Obter Ponto no Polígono: https://docs.microsoft.com/rest/api/maps/spatial/getpointinpolygon |
Métodos herdados
| new |
Um método estático usado para criar um novo objeto Pipeline com a Credencial fornecida. |
Detalhes do construtor
SpatialURL(Pipeline, string)
Cria uma instância de SpatialURL.
new SpatialURL(pipeline: Pipeline, mapsUrl?: string)Parâmetros
- pipeline
- Pipeline
Chame MapsURL.newPipeline() para criar um pipeline padrão ou forneça um pipeline personalizado.
- mapsUrl
-
string
Uma cadeia de caracteres de URL que aponta para Azure Mapas serviço, o padrão é "https://atlas.microsoft.com".
Se nenhum protocolo for especificado, por exemplo "atlas.microsoft.com", , será https assumido.
Detalhes das propriedades herdadas
mapsUrl
Valor da cadeia de caracteres de URL base.
mapsUrl: stringValor da propriedade
string
Herdado deMapsURL.mapsUrl
Detalhes do método
getBuffer(Aborter, string | SpatialFeatureCollection, number[])
Retorna um FeatureCollection em que cada Recurso é um buffer em torno do Recurso indexado correspondente da entrada. O buffer pode estar por fora ou dentro do Recurso fornecido, dependendo da distância fornecida na entrada. Deve haver uma distância fornecida por Recurso na entrada FeatureCollection ou, se apenas uma distância for fornecida, essa distância será aplicada a cada Recurso da coleção. O buffer positivo (ou negativo) de uma geometria é definido como a soma minkowski (ou diferença) da geometria com um círculo de raio igual ao valor absoluto da distância do buffer. A API de buffer sempre retorna um resultado poligonal. O buffer negativo ou de distância zero de linhas e pontos é sempre um polígono vazio. Os recursos de entrada são fornecidos na solicitação ou por um arquivo GeoJSON que é carregado por meio 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 for fornecido diretamente, o FeatureCollection usará a API de Post Buffer: https://docs.microsoft.com/rest/api/maps/spatial/postbuffer
Caso contrário, usa a API Obter Buffer: 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 cancelamento de solicitação.
- udidOrFeatureCollection
-
string | SpatialFeatureCollection
Um FeatureCollection que contém as entradas ou a ID exclusiva retornada da API de Carregamento de Dados depois de carregar um objeto FeatureCollection GeoJSON válido. Consulte RFC 7946 para obter detalhes. Todas as propriedades do recurso devem conter geometryId, que é usado para identificar a geometria e diferencia maiúsculas de minúsculas.
- distances
-
number[]
A lista de distâncias (uma por recurso ou outra para todos os recursos). A distância positiva gerará um buffer fora do recurso, enquanto a distância negativa gerará um buffer dentro do recurso. Se a distância negativa maior que a geometria em si, um polígono vazio será retornado.
Retornos
Promise<GetBufferResponse>
getClosestPoint(Aborter, GeoJSON.Position, string | SpatialFeatureCollection, GetClosestPointOptions)
Retorna o ponto mais próximo entre um ponto base e um determinado conjunto de pontos fornecidos pelos dados do usuário na solicitação ou em um conjunto de dados carregado pelo usuário identificado pelo udid.
Se estiver usando um udid, o conjunto de pontos de destino será fornecido por um arquivo GeoJSON que é carregado por meio da API de Carregamento de Dados e referenciado por um udid exclusivo. O arquivo GeoJSON pode conter apenas uma coleção de geometria point. MultiPoint ou outras geometrias serão ignoradas se fornecidos. O número máximo de pontos aceitos é 100.000.
O algoritmo não leva em conta o roteamento ou o tráfego. As informações retornadas incluem latitude de ponto mais próxima, longitude e distância em metros do ponto mais próximo.
Se fornecer diretamente o, o FeatureCollection usará a API post closest point: https://docs.microsoft.com/rest/api/maps/spatial/postclosestpoint
Caso contrário, usa a API Obter Ponto Mais Próximo: 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 cancelamento de solicitação.
- position
- GeoJSON.Position
O ponto de base.
- udidOrFeatureCollection
-
string | SpatialFeatureCollection
Um FeatureCollection que contém os pontos de destino ou a ID exclusiva retornada da API de Carregamento de Dados depois de carregar um objeto FeatureCollection GeoJSON válido. Consulte RFC 7946 para obter detalhes. Todas as propriedades do recurso devem conter geometryId, que é usado para identificar a geometria e diferencia maiúsculas de minúsculas.
- options
- GetClosestPointOptions
Retornos
Promise<GetClosesPointResponse>
getGeofence(Aborter, string, string | SpatialFeatureCollection, GeoJSON.Position, GetGeofenceOptions)
Recupera a proximidade de uma coordenada para uma cerca geográfica fornecida na solicitação ou que foi carregada no serviço De dados. Você pode usar a API de Carregamento de Dados para carregar uma cerca geográfica ou um conjunto de cercas. Consulte Geofencing GeoJSON data for more details on the geofence data format. Para consultar a proximidade de uma coordenada, forneça o local do objeto que você está rastreando, bem como a ID da cerca ou conjunto de cercas, e a resposta conterá informações sobre a distância da borda externa da cerca geográfica. Um valor negativo significa que a coordenada está dentro da cerca, enquanto um valor positivo significa que ela está fora da cerca. Essa API pode ser usada para uma variedade de cenários que incluem itens como acompanhamento de ativos, gerenciamento de frota ou configuração de alertas para mover objetos. A API dá suporte à integração com a Grade de Eventos. O parâmetro isAsync é usado para habilitar a integração com a Grade de Eventos (desabilitada por padrão). Para testar essa API, você pode carregar os dados de exemplo dos exemplos da API post geofence (Corpo da Solicitação) por meio da API de Carregamento de Dados e substituir o [udid] da solicitação de exemplo abaixo pelo udid retornado pela API de Carregamento de Dados.
Se o fornecimento direto da cerca geográfica usar a API post geofence: https://docs.microsoft.com/rest/api/maps/spatial/postgeofence
Caso contrário, usa a API Get Geofence: https://docs.microsoft.com/en-us/rest/api/maps/spatial/getgeofence
Código InnerError de cerca geográfica
No contrato de erro de resposta de cerca geográfica, 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 cerca geográfica específico. A tabela abaixo mostra o mapeamento de código entre todo o tipo de erro de cliente conhecido para o erro messagede geofencing correspondente.
innererror.code | error.message ---------------------------- | -------------------------------------- NullDeviceId | A ID do dispositivo não deve ser nula. NullUdid | Udid não deve ser nulo. UdidWrongFormat| A Udid deve ser adquirida da API de ingestão de dados do usuário. InvalidUserTime| O tempo de usuário é inválido. InvalidSearchBuffer| Searchbuffer é inválido. InvalidSearchRange| O intervalo de valor do searchbuffer deve ser de 0 a 500 metros. InvalidLatLon| 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 de geofencing não são um arquivo json válido. NotSupportedGeoJson| Os dados de cerca geográfica não podem ser lidos como um Recurso ou FeatureCollections. InvalidGeoJson| Os dados de cerca geográfica são inválidos. NoUserDataWithAccountOrSubscription| Não é possível encontrar dados de cerca geográfica do usuário com id de conta e/ou id de assinatura fornecidos. NoUserDataWithUdid| Não é possível encontrar dados de cerca geográfica do usuário com 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 cancelamento de solicitação.
- deviceId
-
string
ID do dispositivo
- udidOrFeatureCollection
-
string | SpatialFeatureCollection
Um FeatureCollection que contém a cerca ou a ID exclusiva retornada da API de Carregamento de Dados depois de carregar um objeto FeatureCollection GeoJSON válido. Consulte RFC 7946 para obter detalhes. Todas as propriedades do recurso devem conter geometryId, que é usado para identificar a geometria e diferencia maiúsculas de minúsculas.
- position
- GeoJSON.Position
O local que está sendo passado.
- options
- GetGeofenceOptions
Retornos
Promise<GetGeofenceResponse>
getGreatCircleDistance(Aborter, [GeoJSON.Position, GeoJSON.Position])
Retorne o grande círculo ou a distância mais curta entre dois pontos na superfície de uma esfera, medida ao longo da superfície da esfera. Isso difere do cálculo de uma linha reta pelo interior da esfera. Esse método é útil para estimar as distâncias de viagem para aviões calculando a distância mais curta entre os aeroportos. Usa a API Obter Grande Distância do Círculo: 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 cancelamento de solicitação.
- coordinates
-
[GeoJSON.Position, GeoJSON.Position]
As coordenadas pelas quais a distância é calculada. Duas coordenadas são necessárias. A primeira é a coordenada do ponto de origem e a última é a coordenada do ponto de destino.
Retornos
Promise<GetGreatCircleDistance>
getPointInPolygon(Aborter, string | SpatialFeatureCollection, GeoJSON.Position)
Retorna se um ponto está dentro de um conjunto de polígonos. O conjunto de polígonos é fornecido na solicitação ou por um arquivo GeoJSON que é carregado por meio da API de Carregamento de Dados e referenciado por um udid exclusivo. O arquivo GeoJSON pode conter geometrias Polygon e MultiPolygon, outras geometrias serão ignoradas se fornecidas. Se o ponto estiver dentro ou no limite de um desses polígonos, o valor retornado será true. Em todos os outros casos, o valor retornado é false. Quando o ponto estiver dentro de vários polígonos, o resultado fornecerá a seção geometrias interseccionais para mostrar todas as geometrias válidas (referenciadas por geometryId) nos dados do usuário. O número máximo de vértices aceitos para formar um Polígono é 10.000.
Se fornecer diretamente o FeatureCollection usa a API post point in polygon: https://docs.microsoft.com/rest/api/maps/spatial/postpointinpolygon
Caso contrário, usa a API Obter Ponto no Polígono: 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 cancelamento de solicitação.
- udidOrFeatureCollection
-
string | SpatialFeatureCollection
Um FeatureCollection que contém os polígonos ou a ID exclusiva retornada da API de Carregamento de Dados depois de carregar um objeto FeatureCollection GeoJSON válido. Consulte RFC 7946 para obter detalhes. Todas as propriedades do recurso devem conter geometryId, que é usado para identificar a geometria e diferencia maiúsculas de minúsculas.
- position
- GeoJSON.Position
O ponto de base.
Retornos
Promise<GetPointInPolygonResponse>
Detalhes do método herdado
newPipeline(Credential, INewPipelineOptions)
Um método estático usado para criar um novo objeto Pipeline com a Credencial fornecida.
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): PipelineParâmetros
- credential
- Credential
Como SubscriptionKeyCredential, TokenCredential e MapControlCredential.
- pipelineOptions
- INewPipelineOptions
Retornos
Um novo objeto Pipeline.
Herdado deMapsURL.newPipeline