@azure/maps-common package

Interfaces

BoundingBox	Caixa delimitadora
GeoJsonFeature	Recurso GeoJSON 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	LineString GeoJSON. Referência
GeoJsonMultiLineString	MultiLineString GeoJSON. Referência
GeoJsonMultiPoint	MultiPoint GeoJSON. Referência
GeoJsonMultiPolygon	MultiPolygon GeoJSON. Referência
GeoJsonObject	Um objeto GeoJSON representa uma geometria, um recurso ou uma coleção de recursos. Referência
GeoJsonPoint	Ponto GeoJSON. Referência
GeoJsonPolygon	Polígono GeoJSON. Referência Para especificar uma restrição específica aos Polígonos, é útil introduzir o conceito de um anel linear: Um anel linear é um LineString fechado com quatro ou mais posições. As primeira e a última posições são equivalentes e devem conter valores idênticos; sua representação TAMBÉM DEVE ser idêntica. Um anel linear é o limite de uma superfície ou o limite de um orifício em uma superfície. Um anel linear DEVE seguir a regra à direita em relação à área delimitada, ou seja, os anéis externos são no sentido anti-horário e os orifícios são no sentido horário.

Aliases de tipo

BBox	Caixa delimitadora, incluindo informações sobre o intervalo de coordenadas para suas geometrias
BBox2D	Caixa delimitadora 2D
BBox3D	Caixa delimitadora 3D
GeoJsonGeometry	Geometria GeoJSON
GeoJsonType	Tipos GeoJSON
GeometryType	Tipos de geometria
LatLon	Par latitude/longitude
Position	Uma matriz de números 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 Azure Mapas
createMapsClientIdPolicy(string)	Criar uma política de pipeline HTTP para adicionar o cabeçalho x-ms-client-id para TokenCredential autenticação baseada em Azure Mapas
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)	Extrair vários campos da resposta para rawResponse

Detalhes da função

createAzureMapsKeyCredentialPolicy(KeyCredential)

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

function createAzureMapsKeyCredentialPolicy(azureKeyCredential: KeyCredential): PipelinePolicy

Parâmetros

azureKeyCredential

KeyCredential

Retornos

PipelinePolicy

createMapsClientIdPolicy(string)

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

function createMapsClientIdPolicy(mapsClientId: string): PipelinePolicy

Parâmetros

mapsClientId

string

Retornos

PipelinePolicy

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 o cliente, as opções e a especificação

Retornos

(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)

Extrair vários campos da resposta para 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

Retornos

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

Uma promessa para a chamada à API.