Яндекс карты api 2.1. Работы по ускорению и оптимизации
29 апреля 2014 года было объявлено, что новая версия API Яндекс.Карт 2.1 выходит из статуса беты и теперь Вы можете на неё безопасно переходить.
В нескольких ближайших заметках я планирую познакомить Вас с данной версией API.
Основные отличительные особенности JavaScript API Яндекс.Карт версии 2.1:
— новый адаптивный дизайн интерфейсов карты;
— мультимаршрутизатор — возможность построения всех возможных маршрутов вместо одного;
— модульная система API. Список всех модулей API приведен в справочнике.
— новый способ отображения объектов на карте, который позволяет создавать больше меток, чем в версии 2.0.
Подробную документацию по новой версии API Яндекс.Карт 2.1 можно прочитать .
Давайте рассмотрим простейший пример создания карты с использованием API Яндекс.Карт 2.1.
Вот его код:
Простейший пример создания карты с использованием API Яндекс.Карт 2.1. var myMap; // Дождёмся загрузки API и готовности DOM. ymaps.ready(init); function init () { // Создание экземпляра карты и его привязка к контейнеру с // заданным id ("map"). myMap = new ymaps.Map("map", { // При инициализации карты обязательно нужно указать // её центр и коэффициент масштабирования. center: , // Нижний Новгород zoom: 12 }); }
В самом начале, мы подключаем API карт по адресу http://api-maps.yandex.ru/
Давайте рассмотрим параметры подробнее:
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.
Могут использоваться дополнительные параметры:
coordorder — порядок задания географических координат в функциях API, принимающих на вход пары долгота-широта (например, Placemark).
Возможные значения:
latlong - [широта, долгота] - используется по умолчанию;
longlat - [долгота, широта].
Значение по умолчанию: latlong.
load — Список загружаемых модулей.
Значение по умолчанию: package.full.
mode — Режим загрузки API.
mode=release - код API может быть загружен в упакованном виде для минимизации трафика и скорости исполнения в браузере;
mode=debug - режим загрузки в виде исходного кода.
Значение по умолчанию: release.
Подробнее о параметрах подключения можно прочитать
Для отображения карты задается контейнер ненулевого размера, в качестве контейнера может использоваться любой HTML-элемент блочного типа, в примере это div.
Параметры карты задаются в коде:
myMap = new ymaps.Map(‘map’, {
center: , // центр карты Нижний Новгород
zoom: 12 - уровень масштаба
});
Создавать карту следует после того, как веб-страница загрузится целиком. Это даст уверенность в том, что контейнер для карты создан и к нему можно обращаться по id. Чтобы инициализировать карту после загрузки страницы, можно воспользоваться функцией ready().
Функция ready вызовется тогда, когда API будет загружен и DOM сформирован
ymaps.ready(init);
function init () {
// Создание экземпляра карты и его привязка к контейнеру с
// заданным id ("map").
myMap = new ymaps.Map(‘map’, {
// При инициализации карты обязательно нужно указать
// её центр и коэффициент масштабирования.
center: , // Нижний Новгород
zoom: 12
});
По умолчанию на карте отображаются все доступные элементы управления.
Тип карты - схема.
API предоставляет пять встроенных типов карт:
Схема (yandex#map) - по умолчанию;
Спутник (yandex#satellite);
Гибрид (yandex#hybrid);
Народная карта (yandex#publicMap);
Гибрид народной карты (yandex#publicMapHybrid).
Пример с определением типа карты Спутник
Код примера:
Задем тип карты - Спутник. Пример создания карты с использованием API Яндекс.Карт 2.1. body, html { padding: 0; margin: 0; width: 100%; height: 100%; } var myMap; // Дождёмся загрузки API и готовности DOM. ymaps.ready(init); function init () { // Создание экземпляра карты и его привязка к контейнеру с // заданным id ("map"). myMap = new ymaps.Map("map", { // При инициализации карты обязательно нужно указать // её центр и коэффициент масштабирования. center: , // Нижний Новгород zoom: 12, type: "yandex#satellite" }); }
Как я уже говорил, на карту по умолчанию на карту добавляется стандартный набор элементов управления ‘mediumMapDefaultSet’.
Для того чтобы добавить на карту нужные элементы управления, в параметре controls при ее создании можно указать список соответствующих ключей.
Вот код примера элементами управления масштабом и типом карт.
Код примера:
| body, html { padding: 0; margin: 0; width: 100%; height: 100%; } |
Элементы управления картой. Пример создания карты с использованием API Яндекс.Карт 2.1. body, html { padding: 0; margin: 0; width: 100%; height: 100%; } var myMap; // Дождёмся загрузки API и готовности DOM. ymaps.ready(init); function init () { // Создание экземпляра карты и его привязка к контейнеру с // заданным id ("map"). myMap = new ymaps.Map("map", { // При инициализации карты обязательно нужно указать // её центр и коэффициент масштабирования. center: , // Нижний Новгород zoom: 12, controls: ["zoomControl", "typeSelector"] }); }
Существует возможность задания поведения карты, используя параметр behaviors.
Задавая его значения, мы можем включать или отключать различные параметры поведения карты:
масштабирование карты двойным щелчком кнопки мыши;
перетаскивание карты с помощью мыши либо одиночного касания;
масштабирование карты при выделении области левой кнопкой мыши;
масштабирование карты мультисенсорным касанием;
масштабирование карты при выделении области правой кнопкой мыши;
измерение расстояния;
масштабирование карты колесом мыши.
Пример кода с отключенной возможностью масштабирования колесиком мыши.
| body, html { padding: 0; margin: 0; width: 100%; height: 100%; } |
Управление поведением карты. Пример создания карты с использованием API Яндекс.Карт 2.1. body, html { padding: 0; margin: 0; width: 100%; height: 100%; } var myMap; // Дождёмся загрузки API и готовности DOM. ymaps.ready(init); function init () { // Создание экземпляра карты и его привязка к контейнеру с // заданным id ("map"). myMap = new ymaps.Map("map", { // При инициализации карты обязательно нужно указать // её центр и коэффициент масштабирования. center: , // Нижний Новгород zoom: 12 }); myMap.behaviors.disable("scrollZoom"); }
Возможно изменение параметров карты после ее создания.
Включаем возможность масштабирования колесиком мыши
myMap.behaviors.enable("scrollZoom");
Выключаем
myMap.behaviors.disable("scrollZoom");
Устанавливаем новый тип карты Народная
myMap.setType(‘yandex#publicMap’);
Устанавливаем новый центр карты
На этом пока все.
Продолжение следует…
A release candidate is a version of the API, which is available for public use, but is still under approval. Before installing the release candidate as a stable version, as soon as it is released, it is tested for bugs that may lead to API functionality degradation. By using release candidates in your projects, you can help us timely identify potential errors. You can also pretest your app"s operation with a new version of the API.
Release candidates should be used in the app development and testing environment. This will help you avoid errors in the production environment. You can enable a release candidate as follows:
If some time after publishing a release candidate no errors that lead to functionality degradation are found, the release candidate is installed as a stable version of the API and can be accessed via the link api-maps.yandex.ru/2.1.
Enabling the current versionWhen using your application, we recommend specifying the major version (i.e., do not specify the third number of the version). This guarantees that the current version, that is, the latest stable version of the corresponding major version, will be automatically enabled. For example, if you specify version 2.1, the latest available stable version 2.1.x will be enabled (for example, 2.1.47):
Enabling a set version
Although full compatibility is guaranteed between minor versions, in rare cases you may find that your client application does not work as intended when you enable the latest API version. To avoid these situations, in particularly crucial cases you may need to enable a specific API version. For that, specify its number in its entirety:
Note. If you use a set version, try regularly switching it to a newer version (for example, once every few months). The matter is that over time we can disable the minor version you are using in your project, and then the current version of the API will be enabled automatically. However, the version update might cause your app to stop working correctly. For this reason, we recommend that you keep track of API updates and switch to newer versions as soon as possible.
Summary tableThe table below provides recommendations for enabling different versions of the API, depending on the type and complexity of your project.
| Medium and large projects with a basic map | Latest version of to test the functionality. |
|
| Medium and large projects with complex map features | Set version to test the functionality. |
|
| Projects using the commercial version of the API | Set version (see the note below) |
Note. If you use a set version, try regularly switching it to a newer version. The matter is that over time we can disable the minor version you are using in your app, and then the current version of the API will be enabled automatically. However, the version update might cause your app to stop working correctly. For this reason, we recommend that you keep track of API updates and switch to newer versions as soon as possible.
В данной статье я хочу начать цикл статей по работе с API Яндекс.Карт. Документация Яндекс.Карт достаточно полна, но степень разрозненности информации в ней высокая, при первом заходе в документацию без пол-литры не разобраться, и для решения какой-то проблемы можно потратить много времени на поиск по документации и в поисковике. Этот цикл статей будет рассказывать о практических решениях наиболее частых случаев использования API Яндекс.Карт последней, на момент написания статьи, версии 2.1.
При вёрстке сайта в контактной информации часто бывает необходимость вставки карты, на которой будет отмечено местоположение организации, для которой разрабатывается сайт. В самых простых случаях это может быть просто скриншот c онлайн-карт (или не онлайн):
Для вставки интерактивной карты может использоваться конструктор карт
https://tech.yandex.ru/maps/tools/constructor/ :
В случае, если нам нужно более продвинутое использование карт (свои метки, программное перемещение карт и т.п.), то для этого надо использовать API Яндекс.Карт: https://tech.yandex.ru/maps/jsapi/ . В качестве примера использования карт в статье будет рассмотрено создание карты с простым добавлением пользовательских метки и балуна.
Для начала подключим компоненты API:
Если разрабатывается какое-то большое приложение с использованием карт, то лучше подключать компоненты API определённой версии, чтобы при обновлении API на стороне Яндекса у нас ничего не сломалось на продакшине:
Карту необходимо будет расположить в каком-нибудь блоке, например в div#map . Далее карту необходимо создать в данном блоке (после срабатывания события готовности карты и DOM):
| ymaps.ready (init) ; function init() { var myMap; myMap = new ymaps.Map ("map" , { center: [ 55.76 , 37.64 ] , zoom: 7 } ) ; } |
Здесь мы указываем:
По умолчанию Яндекс.Карты создают много лишних элементов, которые в большинстве случаев не нужны на сайтах. В основном к элементам управления и к поведению карты достаточно применить 2 условия:
Для выполнения этих требований дополняем код:
| ymaps.ready (init) ; function init() { var myMap; myMap = new ymaps.Map ("map" , { center: [ 55.76 , 37.64 ] , zoom: 13 , controls: } ) ; myMap.behaviors .disable ("scrollZoom" ) ; myMap.controls .add ("zoomControl" , { position: { top: 15 , left: 15 } } ) ; } |
Здесь мы отключили «scrollZoom» и добавили «zoomControl» с позиционированием от левого верхнего угла.
Теперь нужно добавить на карту метку, для статьи скачаём её картинку с http://medialoot.com/item/free-vector-map-location-pins/ и расположим в коде следующим образом:
| ymaps.ready (init) ; function init() { var myMap; myMap = new ymaps.Map ("map" , { center: [ 55.7652 , 37.63836 ] , zoom: 17 , controls: } ) ; myMap.behaviors .disable ("scrollZoom" ) ; myMap.controls .add ("zoomControl" , { position: { top: 15 , left: 15 } } ) ; var myPlacemark = new ymaps.Placemark ([ 55.7649 , 37.63836 ] , { } , { iconLayout: "default#image" , iconImageHref: , iconImageSize: [ 40 , 51 ] , iconImageOffset: [ - 20 , - 47 ] } ) ; myMap.geoObjects .add (myPlacemark) ; } |
Здесь мы объявляем переменную myPlacemark , в которой запишем маркер, в первом параметре ymaps.Placemark указываем координаты метки, а в третьем параметре:
И через myMap.geoObjects.add() добавляем метку на карту.
А теперь сделаем баллун, который у нас будет показываться при клике на метку карты, макет баллуна и его содержимое возьмём с http://designdeck.co.uk/a/1241
ymaps.ready
(init)
;
function
init()
{
var
myMap;
myMap =
new
ymaps.Map
("map"
,
{
center:
[
55.7652
,
37.63836
]
,
zoom:
17
,
controls:
}
)
;
myMap.behaviors
.disable
("scrollZoom"
)
;
myMap.controls
.add
("zoomControl"
,
{
position:
{
top:
15
,
left:
15
}
}
)
;
var
html =
""
;
html +=
" "
;
html +=
""
;
html +=
"The Victoria Tower Gardens " ; html += "" ; html += "City of London " ; html += "" ; html += "United Kingdom " ; html += "020 7641 5264 " ; html += "" ; html += "" ; var myPlacemark = new ymaps.Placemark ([ 55.7649 , 37.63836 ] , { balloonContent: html } , { iconLayout: "default#image" , iconImageHref: "http://сайт/files/APIYaMaps1/min_marker.png" , iconImageSize: [ 40 , 51 ] , iconImageOffset: [ - 20 , - 47 ] , balloonLayout: "default#imageWithContent" , balloonContentSize: [ 289 , 151 ] , balloonImageHref: "http://сайт/files/APIYaMaps1/min_popup.png" , balloonImageOffset: [ - 144 , - 147 ] , balloonImageSize: [ 289 , 151 ] , balloonShadow: false } ) ; myMap.geoObjects .add (myPlacemark) ; } |
Здесь мы: