Documentation
Reference
2.1.50 (current version)
collection
interactivityModel
Interfaces
2.1.51 (release candidate)
collection
interactivityModel
Interfaces

regions.load

Provides access to the geometry of various regions and countries.

Constructor

Constructor

regions.load(region[, options])

Returns Promise object.

Parameters:

ParameterDefault valueDescription
region *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: String

The ISO_3166-1 country code (RU, UA, BY, KZ) for loading the regional area, or '001' for loading the geometry of country borders.

options

Type: Object

Display options.

options.disputedBorders

Type: String

Two-letter code of the country to use as the official reference for determining the administrative subordination of disputed territories. Accepted values: 'RU', 'UA', 'BY', 'KZ'. By default, it coincides with the country code that is specified when loading the API. Unsupported country codes are reset to RU. For the region '001' (borders of countries), the code 'UN' is supported — world borders according to the United Nations.

options.lang

Type: String

Language (ru, uk, en, be).

options.quality 1

Type: Number

Quality level. Available values:

  • 0 - minimal quality
  • 1 - standard quality
  • 2 - improved quality
  • 3 - high quality
The quality level affects how accurately curves are represented, as well as the volume of the data file.

* Mandatory parameter/option.

Example:

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