Подключение JavaScript API Яндекс.Карт

API позволяет отображать карты, локализованные на различных языках с учётом специфики отдельных стран. Для того чтобы управлять локализацией, необходимо в HTTP-запросе передать локаль.

Локаль задается параметром lang:

lang=language_region

language — двузначный код языка. Указывается в формате ISO 639-1.

region — двузначный код страны. Указывается в формате ISO 3166-1.

На данный момент поддерживаются следующие локали:

• lang=ru_RU;
• lang=en_US;
• lang=ru_UA;
• lang=uk_UA;
• lang=tr_TR

Параметр является обязательным.

<script src="https://api-maps.yandex.ru/2.1/?lang=ru_RU" type="text/javascript"></script>
        

API-ключ. Используется только в платных версиях API.

Порядок задания географических координат в функциях API, принимающих на вход пары значений: широта(ось Y) - долгота(ось X).

Возможные значения:

• latlong — [широта, долгота]
• longlat — [долгота, широта]

Значение по умолчанию: latlong.

<script src="https://api-maps.yandex.ru/2.1/?lang=ru_RU&coordorder=latlong" type="text/javascript"></script>
        

Список загружаемых модулей.

Имена модулей перечисляются через запятую. Например, load=Map,Placemark,map.addon.balloon.

По умолчанию загружаются все компоненты API (load=package.full), однако в целях минимизации объема трафика, передаваемого клиентскому приложению, вы можете указать список конкретных сущностей API, с которыми работает ваше приложение.

package.full оптимизирован таким образом, чтобы подгружать функциональность в момент ее фактического использования, поэтому в большинстве случаев нет необходимости настраивать параметр load.

Компоненты также можно загружать "по требованию", используя функцию require.

Значение по умолчанию: package.full.

Режим загрузки API.

Возможные значения:

• release - код API может быть загружен в упакованном виде для минимизации трафика и скорости исполнения в браузере.
• debug - код API может быть загружен в виде исходного кода удобна для отладки JavaScript-компонентов, код всех загруженных компонентов доступен для просмотра. Кроме того, в этом режиме в консоль выводятся сообщения об ошибках и исключениях. При загрузке в упакованном виде (release) эти сообщения не выводятся.

Значение по умолчанию: release.

<script src="https://api-maps.yandex.ru/2.1/?lang=ru_RU&mode=debug" type="text/javascript"></script>
        

Пространство имен, в котором локализованы программные компоненты API. По умолчанию все объекты принадлежат пространству имен ymaps (например, ymaps.Map). Если при загрузке API указать ns=myNameSpace, то объекты будут доступны уже как myNameSpace.Map.

Использование пространства имен позволяет избежать пересечения названий функций и прочих программных компонентов, используемых в API и пользовательском/стороннем коде.

Вы можете задать пустое значение ns. В этом случае API не будет создавать объектов в глобальной области видимости, и доступ к функциональности API получит только функция, указанная в параметре onload.

Значение по умолчанию: ymaps.

<!--загружаем API-->
<script src="https://api-maps.yandex.ru/2.1/?lang=ru_RU" type="text/javascript"></script>
...
<script type="text/javascript">
var myMap;
// при успешной загрузке API выполняется соответствующая функция
ymaps.ready(function(){
    // создание экземпляра карты и его привязка к контейнеру с id="map"
    myMap = new ymaps.Map("map", {
        center: [55.75396, 37.620393], // центр карты
        zoom: 8, // коэффициент масштабирования
    });
}); // end ymaps.ready
</script>
        

<!--загружаем API-->
<script src="https://api-maps.yandex.ru/2.1/?lang=ru_RU&ns=myNameSpace" type="text/javascript"></script>
...
<script type="text/javascript">
var myMap;
// при успешной загрузке API выполняется соответствующая функция
myNameSpace.ready(function(){
    // создание экземпляра карты и его привязка к контейнеру с id="map"
    myMap = new myNameSpace.Map("map", {
        center: [55.75396, 37.620393], // центр карты
        zoom: 8, // коэффициент масштабирования
    });
}); // end myNameSpace.ready
</script>
        

Имя функции, которую необходимо вызвать после того, как компоненты API будут загружены и готовы к использованию (callback). В эту функцию в качестве аргумента будет передан объект-неймспейс с функциональностью API.

Допускается использование вложенных пространств имён:

• onload=myfunction
• onload=myapp.dosmth

Пример использования приведен в таблице ниже.

<!--загружаем API-->
<script src="https://api-maps.yandex.ru/2.1/?lang=ru_RU&onload=initMap" type="text/javascript"></script>
...
<script type="text/javascript">
var myMap;
// выполняем функцию инициализации карты указанную при загрузки API onload=initMap
function initMap(ymaps) {
    myMap = new ymaps.Map("map", {
        center: [55.75396, 37.620393], // центр карты
        zoom: 8, // коэффициент масштабирования
    });
}
</script>