Поделиться через

RouteURL class

  • Ссылка
Пакет:
azure-maps-rest

RouteURL представляет URL-адрес Azure Maps операций маршрутизации.

Extends
MapsURL

Конструкторы

RouteURL(Pipeline, string)

Создает экземпляр RouteURL.

Унаследованные свойства

mapsUrl

Базовое значение строки URL-адреса.

Методы

calculateRouteDirections(Aborter, GeoJSON.Position[], CalculateRouteDirectionsOptions)

Возвращает маршрут между источником и назначением, проходящий через маршрутные точки, если они указаны. Маршрут будет учитывать такие факторы, как текущий трафик и типичная скорость дороги в запрошенный день недели и время суток. Возвращаемые сведения включают расстояние, предполагаемое время в пути и представление геометрии маршрута. В зависимости от выбранных параметров также доступны дополнительные сведения о маршрутизации, такие как оптимизированный порядок точек или по очереди.

Служба маршрутизации предоставляет набор параметров для подробного описания модели потребления для конкретного транспортного средства. Подробное описание используемых понятий и параметров проверка модель потребления.

Если options.postBody задано значение , использует API направлений после маршрута: https://docs.microsoft.com/rest/api/maps/route/postroutedirections

В противном случае используетСЯ API получения маршрутов: https://docs.microsoft.com/rest/api/maps/route/getroutedirections
calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)

Примечание. Этот API в настоящее время находится на этапе предварительной версии и может быть подвержен критическим изменениям. Вычисляет матрицу сводок маршрутов для набора маршрутов, определенных в исходном и целевом расположениях. Для каждого заданного источника эта служба вычисляет стоимость маршрутизации из этого источника в каждое заданное место назначения. Набор источников и набор назначений можно рассматривать как заголовки столбцов и строк таблицы, и каждая ячейка таблицы содержит затраты на маршрутизацию от источника к месту назначения для этой ячейки. Для каждого маршрута вычисляются время в пути и расстояния. Вы можете использовать вычисляемые затраты, чтобы определить маршруты для вычисления с помощью API направлений маршрутизации. Если параметр waitForResults в запросе имеет значение false (значение по умолчанию), этот API возвращает код ответа 202 вместе с URL-адресом перенаправления в поле Расположение заголовка ответа. Этот URL-адрес следует периодически проверять, пока не будут доступны данные ответа или сведения об ошибке. Максимальный размер матрицы для этого API составляет 700 (количество источников, умноженное на число назначений). Учитывая это ограничение, примерами возможных матричных измерений являются: 50x10, 10x10, 28x25. 10x70 (он не должен быть квадратным).

Вычисление матрицы маршрутов считается длительной операцией. Длительные операции подразумевают, что после принятия первоначального запроса (HTTP 202) окончательный результат будет опроситься до тех пор, пока не будет доступен. Каждый запрос на опрос перезапускает время ожидания прерывания, если оно было указано.

Использует API матрицы после маршрутизации: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview
calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)

Вычислите набор расположений, которые можно достичь из исходной точки на основе указанного бюджета топлива, энергии или времени. Граница многоугольника (или Изохрон) возвращается в ориентации против часовой стрелки, а также точный центр многоугольников, который был результатом исходной точки. Возвращаемый многоугольник можно использовать для дальнейшей обработки, например Поиск Inside Geometry для поиска объектов pois в предоставленном изохроне.

Использует API получения диапазона маршрутов: https://docs.microsoft.com/rest/api/maps/route/getrouterange

Наследуемые методы

newPipeline(Credential, INewPipelineOptions)

Статический метод, используемый для создания нового объекта конвейера с предоставленными учетными данными.

Сведения о конструкторе

RouteURL(Pipeline, string)

Создает экземпляр RouteURL.

new RouteURL(pipeline: Pipeline, mapsUrl?: string)

Параметры

pipeline
Pipeline

Вызовите MapsURL.newPipeline() для создания конвейера по умолчанию или предоставления настраиваемого конвейера.

mapsUrl

string

Строка URL-адреса, указывающая на Azure Maps службу, по умолчанию — "https://atlas.microsoft.com". Если протокол не указан, например "atlas.microsoft.com", будет https принято.

Сведения об унаследованном свойстве

mapsUrl

Базовое значение строки URL-адреса.

mapsUrl: string

Значение свойства

string

Наследуется отMapsURL.mapsUrl

Сведения о методе

calculateRouteDirections(Aborter, GeoJSON.Position[], CalculateRouteDirectionsOptions)

Возвращает маршрут между источником и назначением, проходящий через маршрутные точки, если они указаны. Маршрут будет учитывать такие факторы, как текущий трафик и типичная скорость дороги в запрошенный день недели и время суток. Возвращаемые сведения включают расстояние, предполагаемое время в пути и представление геометрии маршрута. В зависимости от выбранных параметров также доступны дополнительные сведения о маршрутизации, такие как оптимизированный порядок точек или по очереди.

Служба маршрутизации предоставляет набор параметров для подробного описания модели потребления для конкретного транспортного средства. Подробное описание используемых понятий и параметров проверка модель потребления.

Если options.postBody задано значение , использует API направлений после маршрута: https://docs.microsoft.com/rest/api/maps/route/postroutedirections

В противном случае используетСЯ API получения маршрутов: https://docs.microsoft.com/rest/api/maps/route/getroutedirections

function calculateRouteDirections(aborter: Aborter, coordinates: GeoJSON.Position[], options?: CalculateRouteDirectionsOptions): Promise<CalculateRouteDirectionsResponse>

Параметры

aborter
Aborter

Создайте новый экземпляр Aborter с помощью Aborter.none или Aborter.timeout(), перейдите к документам Aborter, чтобы получить дополнительные примеры об отмене запроса.

coordinates

GeoJSON.Position[]

Массив координат, по которым вычисляется маршрут. Каждая координата является массивом [longitude, latitude]. Требуется не менее двух координат. Первый — это источник, а последний — место назначения маршрута. Необязательные координаты между ними действуют как точки Пути в маршруте. Можно передать до 150 wayPoints.

options
CalculateRouteDirectionsOptions

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

Promise<CalculateRouteDirectionsResponse>

calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)

Примечание. Этот API в настоящее время находится на этапе предварительной версии и может быть подвержен критическим изменениям. Вычисляет матрицу сводок маршрутов для набора маршрутов, определенных в исходном и целевом расположениях. Для каждого заданного источника эта служба вычисляет стоимость маршрутизации из этого источника в каждое заданное место назначения. Набор источников и набор назначений можно рассматривать как заголовки столбцов и строк таблицы, и каждая ячейка таблицы содержит затраты на маршрутизацию от источника к месту назначения для этой ячейки. Для каждого маршрута вычисляются время в пути и расстояния. Вы можете использовать вычисляемые затраты, чтобы определить маршруты для вычисления с помощью API направлений маршрутизации. Если параметр waitForResults в запросе имеет значение false (значение по умолчанию), этот API возвращает код ответа 202 вместе с URL-адресом перенаправления в поле Расположение заголовка ответа. Этот URL-адрес следует периодически проверять, пока не будут доступны данные ответа или сведения об ошибке. Максимальный размер матрицы для этого API составляет 700 (количество источников, умноженное на число назначений). Учитывая это ограничение, примерами возможных матричных измерений являются: 50x10, 10x10, 28x25. 10x70 (он не должен быть квадратным).

Вычисление матрицы маршрутов считается длительной операцией. Длительные операции подразумевают, что после принятия первоначального запроса (HTTP 202) окончательный результат будет опроситься до тех пор, пока не будет доступен. Каждый запрос на опрос перезапускает время ожидания прерывания, если оно было указано.

Использует API матрицы после маршрутизации: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview

function calculateRouteMatrix(aborter: Aborter, body: CalculateRouteMatrixRequestBody, options?: CalculateRouteMatrixOptions): Promise<CalculateRouteMatrixResponse>

Параметры

aborter
Aborter

Создайте новый экземпляр Aborter с помощью Aborter.none или Aborter.timeout(), перейдите к документам Aborter, чтобы получить дополнительные примеры об отмене запроса.

body
CalculateRouteMatrixRequestBody

Матрица координат источника и назначения для вычисления расстояния маршрута, времени в пути и другой сводки для каждой ячейки матрицы на основе входных параметров. Минимальное и максимальное поддерживаемое число ячеек — 1 и 700 соответственно. Например, это может быть 35 источников и 20 назначений или 25 источников и 25 назначений.

options
CalculateRouteMatrixOptions

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

Promise<CalculateRouteMatrixResponse>

calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)

Вычислите набор расположений, которые можно достичь из исходной точки на основе указанного бюджета топлива, энергии или времени. Граница многоугольника (или Изохрон) возвращается в ориентации против часовой стрелки, а также точный центр многоугольников, который был результатом исходной точки. Возвращаемый многоугольник можно использовать для дальнейшей обработки, например Поиск Inside Geometry для поиска объектов pois в предоставленном изохроне.

Использует API получения диапазона маршрутов: https://docs.microsoft.com/rest/api/maps/route/getrouterange

function calculateRouteRange(aborter: Aborter, center: GeoJSON.Position, options?: CalculateRouteRangeOptions): Promise<CalculateRouteRangeResponse>

Параметры

aborter
Aborter

Создайте новый экземпляр Aborter с помощью Aborter.none или Aborter.timeout(), перейдите к документам Aborter, чтобы получить дополнительные примеры об отмене запроса.

center
GeoJSON.Position

Координата, с которой должно начинаться вычисление диапазона.

options
CalculateRouteRangeOptions

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

Promise<CalculateRouteRangeResponse>

Сведения о наследуемом методе

newPipeline(Credential, INewPipelineOptions)

Статический метод, используемый для создания нового объекта конвейера с предоставленными учетными данными.

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipeline

Параметры

credential
Credential

Например, SubscriptionKeyCredential, TokenCredential и MapControlCredential.

pipelineOptions
INewPipelineOptions

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

Pipeline

Новый объект Pipeline.

Наследуется отMapsURL.newPipeline