regions.load

Внимание. Данная функция является устаревшей. Используйте borders.load.

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

Предоставляет доступ к геометрии различных регионов и стран мира.

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

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

Параметры:

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

Тип: String

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

Тип: Object

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

Тип: String

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

Тип: String

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

Тип: Number

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

Тип: String

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

Тип: Object

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

Тип: String

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

Тип: String

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

Тип: Number

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

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

Пример: 

ymaps.regions.load('RU', {
    lang: 'en'
}).then(function (result) {
    geoMap.geoObjects.add(result.geoObjects);
});