YMaps.Regions
Пространство имен для модуля "Регионы".
Для получения доступа к функциональности, описанной в данном пространстве имен, необходимо загрузить модуль "Регионы".
Более подробную информацию о загрузке и работе с данным модулем можно получить в разделе Модуль "Регионы".
Методы
Имя | Статический | Описание |
---|---|---|
load(countryCode, callback) | ![]() |
Загружает данные о регионах для заданной страны. |
Подробное описание методов
load
load(countryCode, callback)
Загружает данные о регионах для заданной страны.
В случае успешного выполнения статус запроса имеет значение YMaps.State.SUCCESS, а в случае ошибки - YMaps.State.FAILURE.
Соответственно, в случае успеха, в качестве данных передается объект YMaps.Regions.RegionCollection, а в случае ошибки - объект содержащий её описание.
См.: ISO 3166-1 таблица декодирования
Пример:
// Загружает данные для Белоруссии и добавляет их на карту.
YMaps.Regions.load("BY", function (state, data) {
if (state == YMaps.State.SUCCESS) {
map.addOverlay(data);
}
});
Параметры:
Имя |
Тип |
Описание |
|
String |
Код страны в соответствии со стандартом ISO 3166.
|
|
Function |
Функция-обработчик ответа.
|