Документация
Справочник JavaScript API
2.1.56 (текущая версия)
collection
interactivityModel
Интерфейсы

ready

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

Выполняет переданную функцию, когда API и DOM готовы к использованию.

Возвращает Promise объект, который подтверждается пространством имен API, либо отклоняется, если при загрузке произошла ошибка.

Параметры:

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

Тип: Function|Object

Функция, которая будет вызвана при успешной загрузке и инициализации API и DOM, или объект с параметрами, если используется расширенный синтаксис.

Доступный список параметров:

  • require - массив дополнительных модулей, которые должны быть загружены вместе с API;
  • successCallback — функция, которая будет вызвана при успешной загрузке API;
  • errorCallback — функция, которая будет вызвана в случае ошибки;
  • context — контекст исполнения функций.

Все параметры являются необязательными.

В successCallback будет передано пространство имен API.

errorCallback

Тип: Function

Функция, которая будет вызвана если произошла ошибка при инициализации. В функцию будет передана ошибка.

context

Тип: Object

Контекст исполнения функции.

Примеры:

1.

<!DOCTYPE html>
<html>
<head>
    <title>Пример</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <script src="http://api-maps.yandex.ru/2.1/?lang=ru_RU" type="text/javascript"></script>
    <script type="text/javascript">
    ymaps.ready(function () {
        var map = new ymaps.Map('map', {
            center: [55.7, 37.6],
            zoom: 10
        });
        // ...
    });
    </script>
</head>
<body>
    <div id="map" style="width: 500px; height: 500px;"></div>
</body>
</html>

2.

// Пример использования расширенного синтаксиса.
ymaps.ready({
    // successCallback будет вызван, когда произойдет загрузка API и модуля "myModule1".
    require: ['myModule1'],
    successCallback: function (ym) {
        var map = new ymaps.Map('map', {
            center: [55.7, 37.6],
            zoom: 10
        });
        var obj = new ymaps.myModule1();
        // ...
    }
})