borders.load

Статическая функция.

Предоставляет доступ к геометрии различных регионов и стран мира. Если на сайте используется политика CSP, то для работы с Регионами в директиве 'connect-src' необходимо указать домены: https://api-maps.yandex.ru https://suggest-maps.yandex.ru https://*.maps.yandex.net https://yandex.ru

Возвращает объект-promise.

{ vow.Promise } borders.load(region[, options])

Параметры:

Параметр Значение по умолчанию Описание
region * —

Тип: String

ISO_3166-1 код страны (RU, UA, BY, KZ) для загрузки административно-территориального деления, либо '001' для загрузки геометрии границ стран мира, либо AQ для загрузки геометрии границ Антарктиды.
options —

Тип: Object

Опции отображения.
options.disputedBorders —

Тип: String

Двухбуквенный код государства, официальная позиция которого будет использоваться для определения административного подчинения спорных территорий. Допустимые значения: 'RU', 'UA', 'UN'. По умолчанию совпадает с кодом страны, который указан при загрузке API. Неподдерживаемые коды стран приводятся к RU. Для региона '001' (границы стран мира) поддерживается код 'UN' — мировые границы согласно позиции ООН.
options.lang —

Тип: String

Язык (ru, uk, en, be, kk, tr).
options.quality 1

Тип: Number

Уровень качества. Доступные значения:
  • 0 - минимальное качество;
  • 1 - стандартное качество;
  • 2 - повышенное качество;
  • 3 - высокое качество.
Уровень качества влияет на точность представления кривых и объем файла данных.
Параметр Значение по умолчанию Описание
region * —

Тип: String

ISO_3166-1 код страны (RU, UA, BY, KZ) для загрузки административно-территориального деления, либо '001' для загрузки геометрии границ стран мира, либо AQ для загрузки геометрии границ Антарктиды.
options —

Тип: Object

Опции отображения.
options.disputedBorders —

Тип: String

Двухбуквенный код государства, официальная позиция которого будет использоваться для определения административного подчинения спорных территорий. Допустимые значения: 'RU', 'UA', 'UN'. По умолчанию совпадает с кодом страны, который указан при загрузке API. Неподдерживаемые коды стран приводятся к RU. Для региона '001' (границы стран мира) поддерживается код 'UN' — мировые границы согласно позиции ООН.
options.lang —

Тип: String

Язык (ru, uk, en, be, kk, tr).
options.quality 1

Тип: Number

Уровень качества. Доступные значения:
  • 0 - минимальное качество;
  • 1 - стандартное качество;
  • 2 - повышенное качество;
  • 3 - высокое качество.
Уровень качества влияет на точность представления кривых и объем файла данных.

* Обязательный параметр/опция.

Примеры:

1.

// Отобразим на карте регионы с помощью ObjectManager.
ymaps.borders.load('RU', {
        lang: 'en'
    })
    .then(function (geojson) {
        var features = geojson.features.
        map(function (feature) {
            feature.id = feature.properties.iso3166;
            return feature;
        });
        var objectManager = new ymaps.ObjectManager();
        objectManager.add(features);
        myMap.geoObjects.add(objectManager);
    });

2.

// Добавим на карту регионы через GeoObject.
ymaps.borders.load('RU', {
        lang: 'en'
    })
    .then(function (geojson) {
        for (var i = 0; i < geojson.features.length; i++) {
            var geoObject = new ymaps.GeoObject(geojson.features[i]);
            myMap.geoObjects.add(geoObject);
        }
    });