@azure/maps-common package

Интерфейсы

BoundingBox	Ограничивающий прямоугольник
GeoJsonFeature	Функция GeoJSON Объект Feature представляет собой пространственно ограниченный объект. Каждый объект Feature является объектом GeoJSON. Справочные материалы
GeoJsonFeatureCollection	GeoJSON FeatureCollection. Справочные материалы
GeoJsonGeometryCollection	GeoJSON GeometryCollection. Справочные материалы
GeoJsonLineString	Строка строки GeoJSON. Справочные материалы
GeoJsonMultiLineString	GeoJSON MultiLineString. Справочные материалы
GeoJsonMultiPoint	GeoJSON MultiPoint. Справочные материалы
GeoJsonMultiPolygon	GeoJSON MultiPolygon. Справочные материалы
GeoJsonObject	Объект GeoJSON представляет геометрию, функцию или коллекцию функций. Справочные материалы
GeoJsonPoint	Точка GeoJSON. Справочные материалы
GeoJsonPolygon	ГеоJSON Полигон. Справочные материалы Чтобы задать ограничение, специфичное для полигонов, полезно ввести понятие линейного кольца: Линейное кольцо — это замкнутая строка LineString с четырьмя или более позициями. Первая и последняя позиции эквивалентны, и они ДОЛЖНЫ содержать идентичные значения; их представительство также должно быть идентичным. Линейное кольцо — это граница поверхности или граница отверстия в поверхности. Линейное кольцо должно следовать правилу правой руки в отношении области, которую оно ограничивает, т.е. внешние кольца расположены против часовой стрелки, а отверстия - по часовой стрелке.

Псевдонимы типа

BBox	Ограничивающий прямоугольник с информацией о диапазоне координат для его геометрии
BBox2D	2D ограничивающий прямоугольник
BBox3D	3D ограничивающий прямоугольник
GeoJsonGeometry	GeoJSON Геометрия
GeoJsonType	Типы GeoJSON
GeometryType	Тип геометрического объекта
LatLon	Пара широта/долгота
Position	Массив чисел, представляющий точку
Position2D	2D положение
Position3D	3D положение

Функции

createAzureMapsKeyCredentialPolicy(KeyCredential)	Создание политики конвейера HTTP для проверки подлинности запроса с помощью AzureKeyCredential Azure Maps
createMapsClientIdPolicy(string)	Создание политики конвейера HTTP для добавления заголовка x-ms-client-id для TokenCredential проверки подлинности на основе Azure Maps
createSendPollRequest<TOptions, TClient>({ client: TClient, options: TOptions, spec: OperationSpec })	Вспомогательная функция для создания метода, который может быть передан в sendPollRequest в createHttpPoller.
getRawResponse<TOptions, TResponse>((options: TOptions) => Promise<TResponse>, TOptions)	Извлекаем несколько полей ответа в rawResponse

Сведения о функции

createAzureMapsKeyCredentialPolicy(KeyCredential)

Создание политики конвейера HTTP для проверки подлинности запроса с помощью AzureKeyCredential Azure Maps

function createAzureMapsKeyCredentialPolicy(azureKeyCredential: KeyCredential): PipelinePolicy

Параметры

azureKeyCredential

KeyCredential

Возвращаемое значение

PipelinePolicy

createMapsClientIdPolicy(string)

Создание политики конвейера HTTP для добавления заголовка x-ms-client-id для TokenCredential проверки подлинности на основе Azure Maps

function createMapsClientIdPolicy(mapsClientId: string): PipelinePolicy

Параметры

mapsClientId

string

Возвращаемое значение

PipelinePolicy

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

Вспомогательная функция для создания метода, который может быть передан в sendPollRequest в createHttpPoller.

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

Параметры

settings

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

Настройки запроса опроса, включая клиента, опции и спецификацию

Возвращаемое значение

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

Обратный вызов, который принимает путь в качестве входных данных и возвращает обещание ответа Lro.

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

Извлекаем несколько полей ответа в rawResponse

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

Параметры

getResponse

(options: TOptions) => Promise<TResponse>

Асинхронная функция, которая фактически вызывает API бэкенда.

options

TOptions

Варианты обратного вызова getResponse

Возвращаемое значение

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

Обещание для вызова API.