Partilhar via


@azure/maps-common package

Interfaces

BoundingBox

Caixa delimitadora

GeoJsonFeature

GeoJSON Feature Um objeto Feature representa uma coisa espacialmente limitada. Cada objeto Feature é um objeto GeoJSON. Referência

GeoJsonFeatureCollection

GeoJSON FeatureCollection. Referência

GeoJsonGeometryCollection

GeoJSON GeometryCollection. Referência

GeoJsonLineString

GeoJSON LineString. Referência

GeoJsonMultiLineString

GeoJSON MultiLineString. Referência

GeoJsonMultiPoint

GeoJSON MultiPonto. Referência

GeoJsonMultiPolygon

GeoJSON MultiPolígono. Referência

GeoJsonObject

Um objeto GeoJSON representa uma Geometria, Recurso ou coleção de Recursos. Referência

GeoJsonPoint

Ponto GeoJSON. Referência

GeoJsonPolygon

Polígono GeoJSON. Referência

Para especificar uma restrição específica para Polígonos, é útil introduzir o conceito de um anel linear:

  • Um anel linear é um LineString fechado com quatro ou mais posições.
  • A primeira e a última posições são equivalentes, e DEVEM conter valores idênticos; a sua representação DEVE também ser idêntica.
  • Um anel linear é o limite de uma superfície ou o limite de um buraco em uma superfície.
  • Um anel linear DEVE seguir a regra da mão direita em relação à área que delimita, ou seja, os anéis externos são no sentido anti-horário, e os buracos são no sentido horário.

Aliases de Tipo

BBox

Caixa delimitadora, incluindo informações sobre o intervalo de coordenadas para as suas geometrias

BBox2D

Caixa delimitadora 2D

BBox3D

Caixa delimitadora 3D

GeoJsonGeometry

Geometria GeoJSON

GeoJsonType

Tipos de GeoJSON

GeometryType

Tipos de geometria

LatLon

Par Latitude/Longitude

Position

Uma matriz de número que representa um ponto

Position2D

Posição 2D

Position3D

Posição 3D

Funções

createAzureMapsKeyCredentialPolicy(KeyCredential)

Criar uma política de pipeline HTTP para autenticar uma solicitação usando um AzureKeyCredential para o Azure Maps

createMapsClientIdPolicy(string)

Criar uma política de pipeline HTTP para adicionar o cabeçalho x-ms-client-id para TokenCredential autenticação baseada no Azure Maps

createSendPollRequest<TOptions, TClient>({ client: TClient, options: TOptions, spec: OperationSpec })

Função auxiliar para criar um método que pode ser passado para sendPollRequest em createHttpPoller.

getRawResponse<TOptions, TResponse>((options: TOptions) => Promise<TResponse>, TOptions)

Extraia vários campos da resposta ao rawResponse

Detalhes de Função

createAzureMapsKeyCredentialPolicy(KeyCredential)

Criar uma política de pipeline HTTP para autenticar uma solicitação usando um AzureKeyCredential para o Azure Maps

function createAzureMapsKeyCredentialPolicy(azureKeyCredential: KeyCredential): PipelinePolicy

Parâmetros

azureKeyCredential
KeyCredential

Devoluções

createMapsClientIdPolicy(string)

Criar uma política de pipeline HTTP para adicionar o cabeçalho x-ms-client-id para TokenCredential autenticação baseada no Azure Maps

function createMapsClientIdPolicy(mapsClientId: string): PipelinePolicy

Parâmetros

mapsClientId

string

Devoluções

createSendPollRequest<TOptions, TClient>({ client: TClient, options: TOptions, spec: OperationSpec })

Função auxiliar para criar um método que pode ser passado para sendPollRequest em createHttpPoller.

function createSendPollRequest<TOptions, TClient>(settings: { client: TClient, options: TOptions, spec: OperationSpec }): (path: string) => Promise<LroResponse<unknown>>

Parâmetros

settings

{ client: TClient, options: TOptions, spec: OperationSpec }

As configurações da solicitação de sondagem, incluindo cliente, opções e as especificações

Devoluções

(path: string) => Promise<LroResponse<unknown>>

Um retorno de chamada que aceita o caminho como entrada e retorna a promessa de resposta Lro.

getRawResponse<TOptions, TResponse>((options: TOptions) => Promise<TResponse>, TOptions)

Extraia vários campos da resposta ao rawResponse

function getRawResponse<TOptions, TResponse>(getResponse: (options: TOptions) => Promise<TResponse>, options: TOptions): Promise<LroResponse<TResponse>>

Parâmetros

getResponse

(options: TOptions) => Promise<TResponse>

Uma função assíncrona que realmente chama a API de back-end.

options

TOptions

As opções para o retorno de chamada getResponse

Devoluções

Promise<@azure/core-lro.LroResponse<TResponse>>

Uma promessa para a chamada de API.