IMultiRouteParams
Интерфейс объекта, описывающего формат задания параметров модели мультимаршрута.
Конструктор
IMultiRouteParams()
Поля
Имя |
Тип |
Описание |
Boolean |
Позволяет прокладывать мультимаршрут с учетом информации о текущих пробках на дорогах. Значение по умолчанию: false. |
|
Number[][]|null |
Позволяет задать область на карте, где предположительно находятся искомые объекты. Используется, если точки маршрута заданы почтовым адресом, а не координатами. Значение по умолчанию null. |
|
String|Number |
Величина временного интервала между запросами к сервису маршрутизации. Может быть задана в миллисекундах, либо оптимальное значение будет рассчитываться автоматически. Значение по умолчанию "auto". |
|
Integer |
Максимально допустимое число маршрутов, возвращаемых мультимаршрутизатором. Значение по умолчанию 3. |
|
Boolean |
Использовать ли обратное геокодирование для точек маршрута, заданных координатами. |
|
String |
Тип маршрутизации. Может принимать одно из двух строковых значений:
|
|
String |
Определяет способ трактовки описаний опорных точек, заданных в виде массивов координат или геометрий. Может принимать одно из двух значений: "longlat", либо "latlong". По умолчанию используется текущее значение параметра coordorder, который задается при подключении API. |
|
Boolean |
Искать объекты только внутри области, заданной параметром boundedBy. Используется, если точки маршрута заданы почтовым адресом, а не координатами. Значение по умолчанию: false. |
|
Integer[] |
Индексы транзитных точек во множестве опорных точек мультимаршрута. По умолчанию массив пуст. |
Описание полей
avoidTrafficJams
{Boolean} avoidTrafficJams
Позволяет прокладывать мультимаршрут с учетом информации о текущих пробках на дорогах. Значение по умолчанию: false.
boundedBy
{Number[][]|null} boundedBy
Позволяет задать область на карте, где предположительно находятся искомые объекты. Используется, если точки маршрута заданы почтовым адресом, а не координатами. Значение по умолчанию null.
requestSendInterval
{String|Number} requestSendInterval
Величина временного интервала между запросами к сервису маршрутизации. Может быть задана в миллисекундах, либо оптимальное значение будет рассчитываться автоматически. Значение по умолчанию "auto".
results
{Integer} results
Максимально допустимое число маршрутов, возвращаемых мультимаршрутизатором. Значение по умолчанию 3.
reverseGeocoding
{Boolean} reverseGeocoding
Использовать ли обратное геокодирование для точек маршрута, заданных координатами.
routingMode
{String} routingMode
Тип маршрутизации. Может принимать одно из двух строковых значений:
- "auto" — автомобильная маршрутизация;
- "masstransit" - маршрутизация с использованием общественного транспорта.
- "pedestrian" — пешеходная маршрутизация.
- "bicycle" - велосипедный маршрут.
Значение по умолчанию "auto".
searchCoordOrder
{String} searchCoordOrder
Определяет способ трактовки описаний опорных точек, заданных в виде массивов координат или геометрий. Может принимать одно из двух значений: "longlat", либо "latlong". По умолчанию используется текущее значение параметра coordorder, который задается при подключении API.
strictBounds
{Boolean} strictBounds
Искать объекты только внутри области, заданной параметром boundedBy. Используется, если точки маршрута заданы почтовым адресом, а не координатами. Значение по умолчанию: false.
viaIndexes
{Integer[]} viaIndexes
Индексы транзитных точек во множестве опорных точек мультимаршрута. По умолчанию массив пуст.