@azure/maps-common package

Interfaces

BoundingBox	Caixa Delimitadora
GeoJsonFeature	GeoJSON Feature A Feature object represents a spatially bounded thing. Cada objeto de Funcionalidade é 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 MultiPoint. Referência
GeoJsonMultiPolygon	GeoJSON MultiPolygon. Referência
GeoJsonObject	Um objeto GeoJSON representa uma Geometria, Funcionalidade ou coleção de Funcionalidades. Referência
GeoJsonPoint	Ponto GeoJSON. Referência
GeoJsonPolygon	GeoJSON Polygon. Referência Para especificar uma restrição específica ao Polygons, é útil introduzir o conceito de um anel linear: Um anel linear é um LineString fechado com quatro ou mais posições. As primeiras e últimas posições são equivalentes e têm de conter valores idênticos; a sua representação também deve ser idêntica. Um anel linear é o limite de uma superfície ou o limite de um buraco numa superfície. Um anel linear TEM de seguir a regra da direita em relação à área que vincula, ou seja, os anéis exteriores são no sentido contrário ao dos ponteiros do relógio e os buracos são no sentido dos ponteiros do relógio.

Aliases de Tipo

BBox	Caixa delimitadora, incluindo informações sobre o intervalo de coordenadas das geometrias
BBox2D	Caixa delimitadora 2D
BBox3D	Caixa delimitadora 3D
GeoJsonGeometry	GeoJSON Geometry
GeoJsonType	Tipos geoJSON
GeometryType	Tipos de geometria
LatLon	Par de 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 um pedido com um AzureKeyCredential para Azure Maps
createMapsClientIdPolicy(string)	Criar uma política de pipeline HTTP para adicionar um cabeçalho x-ms-client-id para TokenCredential autenticação baseada para Azure Maps
createSendPollRequest<TOptions, TClient>({ client: TClient, options: TOptions, spec: OperationSpec })	Função Auxiliar para criar um método que pode ser transmitido para sendPollRequest em createHttpPoller.
getRawResponse<TOptions, TResponse>((options: TOptions) => Promise<TResponse>, TOptions)	Extrair vários campos da resposta ao rawResponse

Detalhes de Função

createAzureMapsKeyCredentialPolicy(KeyCredential)

Criar uma política de pipeline HTTP para autenticar um pedido com um AzureKeyCredential para Azure Maps

function createAzureMapsKeyCredentialPolicy(azureKeyCredential: KeyCredential): PipelinePolicy

Parâmetros

azureKeyCredential

KeyCredential

Devoluções

PipelinePolicy

createMapsClientIdPolicy(string)

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

function createMapsClientIdPolicy(mapsClientId: string): PipelinePolicy

Parâmetros

mapsClientId

string

Devoluções

PipelinePolicy

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

Função Auxiliar para criar um método que pode ser transmitido 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 definições do pedido de inquérito, incluindo o cliente, as opções e as especificações

Devoluções

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

Uma chamada de retorno que aceita o caminho como entrada e devolve a promessa de resposta Lro.

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

Extrair 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, na verdade, chama a API de back-end.

options

TOptions

As opções para a chamada de retorno getResponse

Devoluções

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

Uma promessa para a chamada à API.