@azure/maps-common package

Interfaces

BoundingBox	Cuadro de límite
GeoJsonFeature	Característica GeoJSON Un objeto Feature representa una cosa espacialmente delimitada. Cada objeto Feature es un objeto GeoJSON. Referencia
GeoJsonFeatureCollection	GeoJSON FeatureCollection. Referencia
GeoJsonGeometryCollection	GeoJSON GeometryCollection. Referencia
GeoJsonLineString	GeoJSON LineString. Referencia
GeoJsonMultiLineString	GeoJSON MultiLineString. Referencia
GeoJsonMultiPoint	GeoJSON MultiPoint. Referencia
GeoJsonMultiPolygon	Multipolígono GeoJSON. Referencia
GeoJsonObject	Un objeto GeoJSON representa una geometría, una entidad o un conjunto de entidades. Referencia
GeoJsonPoint	Punto GeoJSON. Referencia
GeoJsonPolygon	Polígono GeoJSON. Referencia Para especificar una restricción específica de los polígonos, es útil introducir el concepto de anillo lineal: Un anillo lineal es un LineString cerrado con cuatro o más posiciones. La primera y la última posición son equivalentes y DEBEN contener valores idénticos; su representación también DEBERÍA ser idéntica. Un anillo lineal es el límite de una superficie o el límite de un agujero en una superficie. Un anillo lineal DEBE seguir la regla de la mano derecha con respecto al área que delimita, es decir, los anillos exteriores están en sentido contrario a las agujas del reloj y los agujeros están en el sentido de las agujas del reloj.

Alias de tipos

BBox	Cuadro delimitador que incluye información sobre el rango de coordenadas de sus geometrías
BBox2D	Cuadro delimitador 2D
BBox3D	Cuadro delimitador 3D
GeoJsonGeometry	Geometría GeoJSON
GeoJsonType	Tipos de GeoJSON
GeometryType	Tipos de geometría
LatLon	Par de latitud / longitud
Position	Una matriz de números que representa un punto
Position2D	Posición 2D
Position3D	Posición 3D

Funciones

createAzureMapsKeyCredentialPolicy(KeyCredential)	Creación de una directiva de canalización HTTP para autenticar una solicitud mediante Azure AzureKeyCredential Maps
createMapsClientIdPolicy(string)	Creación de una directiva de canalización HTTP para agregar el encabezado x-ms-client-id para TokenCredential la autenticación basada en Azure Maps
createSendPollRequest<TOptions, TClient>({ client: TClient, options: TOptions, spec: OperationSpec })	Función auxiliar para crear un método que se pueda pasar a sendPollRequest en createHttpPoller.
getRawResponse<TOptions, TResponse>((options: TOptions) => Promise<TResponse>, TOptions)	Extraer varios campos de la respuesta a rawResponse

Detalles de la función

createAzureMapsKeyCredentialPolicy(KeyCredential)

Creación de una directiva de canalización HTTP para autenticar una solicitud mediante Azure AzureKeyCredential Maps

function createAzureMapsKeyCredentialPolicy(azureKeyCredential: KeyCredential): PipelinePolicy

Parámetros

azureKeyCredential

KeyCredential

Devoluciones

PipelinePolicy

createMapsClientIdPolicy(string)

Creación de una directiva de canalización HTTP para agregar el encabezado x-ms-client-id para TokenCredential la autenticación basada en Azure Maps

function createMapsClientIdPolicy(mapsClientId: string): PipelinePolicy

Parámetros

mapsClientId

string

Devoluciones

PipelinePolicy

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

Función auxiliar para crear un método que se pueda pasar a sendPollRequest en 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 }

La configuración de la solicitud de sondeo, incluido el cliente, las opciones y la especificación

Devoluciones

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

Una devolución de llamada que acepta la ruta como entrada y devuelve la promesa de respuesta Lro.

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

Extraer varios campos de la respuesta a rawResponse

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

Parámetros

getResponse

(options: TOptions) => Promise<TResponse>

Una función asincrónica que realmente llama a la API de backend.

options

TOptions

Las opciones para la devolución de llamada getResponse

Devoluciones

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

Una promesa para la llamada a la API.