Yandex карти api 2.1 преход
В тази статия искам да започна поредица от статии за работа с API на Yandex.Maps. Документацията на Yandex.Maps е доста пълна, но степента на фрагментация на информацията в нея е висока; когато за първи път влезете в документацията без половин литър, не можете да я разберете и за да разрешите проблем, можете да прекарате много време за търсене в документацията и в търсачката. Тази поредица от статии ще говори за практически решения на най-често срещаните случаи на използване на API на Yandex.Maps от най-новата, към момента на писане, версия 2.1.
Когато оформяте сайт в информацията за контакт, често е необходимо да поставите карта, на която ще бъде отбелязано местоположението на организацията, за която се разработва сайтът. В най-простите случаи това може да бъде просто екранна снимка от онлайн карти (или не онлайн):
За вмъкване интерактивна картаможе да се използва конструктор на карти
https://tech.yandex.ru/maps/tools/constructor/ :
Ако имаме нужда от по-разширено използване на карти (наши собствени етикети, програмно движение на карти и т.н.), тогава за това трябва да използваме API на Yandex.Maps: https://tech.yandex.ru/maps/jsapi/ . Като пример за това как да използвате карти, тази статия ще разгледа създаването на карта с просто добавяне на потребителски етикет и балон.
Първо, нека свържем компонентите на API:
Ако някакво голямо приложение се разработва с помощта на карти, тогава е по-добре да свържете API компоненти на определена версия, така че при актуализиране на API от страната на Yandex нищо да не се счупи в производството:
Картата ще трябва да бъде поставена в някакъв блок, например в div#карта. След това картата трябва да бъде създадена в този блок (след задействане на събитието за готовност на картата и DOM):
ymaps.ready(init) ; функция init() ( var myMap; myMap = new ymaps.Map ("карта", (център: [55.76, 37.64], увеличение: 7)) ;) |
Тук посочваме:
- идентификатор на блок карта, където ще създадем карта;
- център— центъра на картата, показващ ширината и дължината;
- увеличение— мащабен фактор на картата.
По подразбиране Yandex.Maps създава много ненужни елементи, които в повечето случаи не са необходими на уебсайтовете. По принцип е достатъчно да приложите 2 условия към контролите и към поведението на картата:
- от елементите на картата присъства само плъзгачът за мащабиране;
- картата не трябва да се увеличава с превъртане на мишката.
За да изпълним тези изисквания, допълваме кода:
ymaps.ready(init) ; функция init() ( var myMap; myMap = new ymaps.Map ("карта" , ( център: [ 55.76 , 37.64 ] , мащабиране: 13, контроли: ) ) ; myMap.behaviors .disable ("scrollZoom" ) ; myMap. контроли .add ("zoomControl" , ( позиция: ( горе: 15 , ляво: 15 ) ) ) ;) |
Тук сме деактивирали scrollzoomи добави "контрол на увеличението"позициониран от горния ляв ъгъл.
Сега трябва да добавим етикет към картата, за статията ще изтеглим нейното изображение от http://medialoot.com/item/free-vector-map-location-pins/ и ще го поставим в кода, както следва:
ymaps.ready(init) ; функция init() ( var myMap; myMap = new ymaps.Map ("карта" , ( център: [ 55.7652 , 37.63836 ] , увеличение: 17, контроли: ) ) ; myMap.behaviors .disable ("scrollZoom" ) ; myMap. контроли .add ("zoomControl", (позиция: (горе: 15, ляво: 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.Маркерпосочете координатите на етикета и в третия параметър:
- посочете в iconLayoutче ще се използва персонализирано изображение на етикета;
- iconImageHref- път към изображението;
- iconImageSize- посочете размера на изображението;
- iconImageOffset- посочваме изместването от горния ляв ъгъл на картината до точката на изображението, която насочваме към обекта, от който се нуждаем. Това е необходимо, така че когато картата се мащабира, позицията на етикета да не се обърка. Защо отместването е посочено в отрицателни стойности - само Бог знае създателя на API.
И чрез myMap.geoObjects.add()добавете маркер към картата.
А сега нека направим балон, който ще се показва, когато щракнем върху етикета на картата, ще вземем оформлението на балона и съдържанието му от http://designdeck.co.uk/a/1241
ymaps.ready(init) ; функция init() ( var myMap; myMap = new ymaps.Map ("карта" , ( център: [ 55.7652 , 37.63836 ] , увеличение: 17, контроли: ) ) ; myMap.behaviors .disable ("scrollZoom" ) ; myMap. контроли .add ("zoomControl", ( позиция: (горе: 15, ляво: 15))) ; var html = " "; html += ""
; html +=" " ; var myPlacemark = new ymaps.Placemark ([ 55.7649 , 37.63836 ] , ( balloonContent: html ) , ( iconLayout: "default#image" , iconImageHref: "http://site/files/APIYaMaps1/min_marker.png", iconImageSize: [ 40 , 51 ] , iconImageOffset: [ - 20 , - 47 ] , balloonLayout: "default#imageWithContent" , balloonContentSize: [ 289 , 151 ] , balloonImageHref: "http://site/files/APIYaMaps1/min_popup.png", balloonImageOffset: [ - 144 , - 147 ] , balloonImageSize: [ 289 , 151 ] , balloonShadow: false ) ) ; myMap.geoObjects .add (myPlacemark) ; )"; html += " "; html += "Градините на Виктория Тауър " ; html += "" ; html +="Лондонско сити " ; html += "" ; html += "Великобритания "; html += "020 7641 5264 "; html += " |
Ние сме тук:
- в balloonContentпосочете съдържанието, което ще се показва при отваряне на балона;
- balloonLayout- укажете, че персонализирано изображение ще се използва като оформление на балон;
- balloonContentSizeи balloonImageSize— размери съответно на съдържание и изображения;
- балон ImageHref- път към изображението;
- balloonImageOffset- изместване спрямо горния ляв ъгъл;
- balloonShadow— деактивиране на сянката на балона (това не засяга нищо с персонализирани изображения).
Кандидатът за издание е версия на API, която е достъпна за обществено ползване, но все още е в процес на одобрение. Преди да инсталирате кандидата за издание като стабилна версия, веднага щом бъде пуснат, той се тества за грешки, които могат да доведат до влошаване на функционалността на API. Като използвате кандидати за издаване във вашите проекти, можете да ни помогнете да идентифицираме навреме потенциални грешки. Можете също така да тествате предварително работата на вашето приложение с нова версия на API.
Кандидатите за издаване трябва да се използват в средата за разработка и тестване на приложения. Това ще ви помогне да избегнете грешки в производствената среда. Можете да активирате кандидат за освобождаване, както следва:
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 version
When 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 table
The table below provides recommendations for enabling different versions of the API, depending on the type and complexity of your project.
Project type | ||
---|---|---|
Project type | Recommended version for running applications | Recommended version under development |
---|---|---|
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 Яндекс.Карт 2.1 . Главная ее особенность - полный редизайн интерфейса карты. Причем изменения затронули не только внешний вид, но и поведение элементов управления картой. Поскольку изначально было понятно, что поломки обратной совместимости не избежать, мы также внесли архитектурные изменения, которые были необходимы для улучшения работы API (о них ближе к концу поста).
Что касается дизайна, нам было важно, чтобы интерфейс одинаково хорошо выглядел на устройствах и экранах разных размеров. Одна из основных сложностей заключается в том, что мы никогда не знаем заранее, как будет выглядеть сервис или сайт со встроенными картами. Поэтому при разработке редизайна нам нужно было постараться предусмотреть максимум вариантов.
Для решения наших задач мы решили в новой версии реализовать адаптивный дизайн интерфейса. На Yet another Conference дизайнер madhare и разработчик zloylos выступили с докладом о том, зачем нам понадобилась адаптивность и как именно мы ее реализовали в API . В этом посте я опишу предысторию и концепцию наших решений, расскажу о том, что еще нового появилось в версии 2.1-beta, а также о том, что еще изменится к релизу 2.1.
Зачем мы думаем о дизайне?
После релиза версии 2.0 мы уже писали пост , в котором рассказывали о нашем подходе к разработке API. Суть концепции заключается в том, что мы делаем продукт не только для разработчиков, но и для тех, кто будет пользоваться результатами их работы. Если человеку будет удобно и приятно пользоваться нашими картами, и он будет требовать от любимых сервисов именно их - это будет настоящий успех. При этом разработчикам тоже должно быть легко и приятно удовлетворять желания пользователей, а значит мы должны по-максимуму упростить их работу с API. С такими мыслями мы начали работу над версией 2.0, а новая 2.1-бета стала логичным продолжением этой же концепции.Исследование
Наблюдая за инсталляциями нашего API и анализируя кейсы использования карт, мы выделили два основных типа разработчиков:- Решают типовые задачи, не хотят тратить много времени, предпочитают готовые интерфейсы Яндекса. Таких примерно 90%.
- Решают нестандартные задачи или предпочитают даже типовые задачи решать по-своему. Им не подходят стандартные элементы управления. Нужна серьезная кастомизация карт. Логично, что это оставшиеся 10%.
Определившись с аудиториями, мы начали изучать кейсы использования. Оказалось, что в нашем случае основное значение имеет, как ни странно, размер. У нас получилось 3+1 варианта: маленькая, средняя, большая карта и мобильные сайты.
Рисуем дизайн для карт разных размеров
Самый тяжелый случай - маленькие карты. Кажется, что из-за маленького размера стоит убирать все элементы управления картой, но и терять функциональность тоже не хочется. Поэтому специально для маленьких карт мы сделали новый набор контролов:Также был добавлен новый элемент управления - «развернуть карту на весь экран». Он экономит место на сайте за счет размещения небольшой карты, а у конечного пользователя остается возможность посмотреть большую карту. Все нужное поведение карты запрограммировано уже на стороне API. Вообще идея этой кнопки родилась, когда мы думали о решении для мобильных устройств. Карта приемлемого размера на десктопе может стать совершенно бесполезной на мобильном. Фулскрин решает эту проблему:
Помимо этого изменился дизайн балунов для небольших размеров карт. Теперь на маленьких картах и экранах мобильных устройств стандартный балун заменяется на плашку внизу экрана. Это позволяет сохранить большую информативность карты для пользователей. При желании эту опцию можно отключить.
Со средними картами все гораздо проще. Поскольку есть, где развернуться:
Как и с большими картами:
Чтобы максимально упростить работу разработчиков при выборе элементов управления картой, мы сделали три готовых набора для разных размеров карты.
map.controls.add("default");
Список доступных ключей:
smallMapDefaultSet // для маленькой
mediumMapDefaultSet // для обычной
largeMapDefaultSet // для большой
Разумеется, по-прежнему можно самостоятельно указывать нужные контролы.
myMap.controls
.add("trafficControl") // пробки.add("searchControl") // поиск.add("zoomControl") // зум-контрол.add("typeSelector") // слои.add("geolocationControl") // геолокация.add("fullscreenControl") // фуллскрин
…
Адаптивность
Недостаточно просто отрисовать дизайн интерфейса для разных размеров карт. Ведь страницу с картой могут открывать на разных экранах. Именно поэтому решено было реализовывать адаптивное поведение интерфейсов карты. Различные элементы интерфейса перестраиваются и меняют свой размер в зависимости от фактического размера контейнера карты.Адаптивное поведение мы реализовали через control.Manager . Также его можно задавать и для тех кнопок и списков, которые вы создаете сами:
Работы по ускорению и оптимизации
Геообъект - это главная сущность на карте. За такой титул ему приходится расплачиваться довольно сложной и громоздкой структурой. Первая итерация работ над геообъектами заключалась в распределении нагрузки при их создании. Мы постарались вынести все подготовительные операции из конструктора геообъекта в места, где они действительно становятся нужны. Это дало очень хорошие результаты. Также в некоторых местах мы сделали ленивую инициализацию сущностей с помощью _defineGetter_ и defineProperty (_defineGetter_, кстати, немного быстрее). Мы сократили количество подписок на события геообъектов внутри нашей системы событий. Частично помог прием подписки сразу на группу геообъектов с последующим определением в обработчике целевого объекта. Здесь нужно признаться, что ускорение можно пощупать только на dom и canvas метках, новые svg метки нам предстоит дорабатывать (why we call it beta? Because it beta then nothing… ;)Во время работы у нас было время на небольшую уборку в коде, по ее результатам приведем микровыводы:
Микровывод 1. При передаче функции-обработчика намного выгоднее передавать отдельно функцию, отдельно контекст. Если у вас чешутся руки сделать bind сразу, подумайте, можете ли вы это себе позволить.
Микровывод 2. Сокращайте количество промежуточных массивов, объектов и анонимных функций. Они не всегда хорошо чистятся garbage collector-ом.
Прочие изменения
- В версии API 2.0 для определения местоположения по IP или с помощью Geolocation API разработчикам приходится самостоятельно использовать необходимые методы и обрабатывать полученный результат. В версии 2.1 достаточно просто добавить новый стандартный элемент управления:
control.GeolocationControl(parameters) Также был улучшен механизм определения местоположения пользователя, используемый в API. Теперь автоматически выбирается наиболее точный результат из браузерной геолокации и геолокации по IP-адресу. - Стандартные метки в API были перерисованы в SVG, а это значит, что им можно задавать произвольные цвета.
- Система пакетов в версии 2.1 будет ликвидирована. Интерфейсы API изменены таким образом, чтобы максимально вынести загрузку компонент API по требованию, для чего большинство отображений были переведены в асинхронный режим. Работы еще ведутся.
- Для такого масштабного обновления нам пришлось пожертвовать обратной совместимостью с версией 2.0. Также к официальному релизу версии 2.1 может сломаться обратная совместимость для некоторых частей бета-версии:
- Существенно изменится кластеризатор.
- Будет переписан map.action.Manager.
- Promises будут реализованы по
29 апреля 2014 года было объявлено, что новая версия API Яндекс.Карт 2.1 выходит из статуса беты и теперь Вы можете на неё безопасно переходить.
В нескольких ближайших заметках я планирую познакомить Вас с данной версией API.
Основные отличительные особенности JavaScript API Яндекс.Карт версии 2.1:
— новый адаптивный дизайн интерфейсов карты;
— мультимаршрутизатор — возможность построения всех возможных маршрутов вместо одного;
— модульная система API. Список всех модулей API приведен в справочнике.
— новый способ отображения объектов на карте, который позволяет создавать больше меток, чем в версии 2.0.
Подробную документацию по новой версии API Яндекс.Карт 2.1 можно прочитать .
Давайте рассмотрим простейший пример создания карты с использованием API Яндекс.Карт 2.1.
Вот его код:
В самото начало свързваме API на картите на http://api-maps.yandex.ru/
Нека разгледаме опциите по-подробно:
lang - зададен от два параметъра language_region,
език - двуцифрен код на езика. Специфициран във формат ISO 639-1.
регион - двуцифрен код на държавата. Специфициран във формат 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.
режим - режим на зареждане на API.
mode=release - API кодът може да бъде изтеглен в пакетиран вид, за да се минимизира трафикът и скоростта на изпълнение в браузъра;
mode=debug - режим на изтегляне като изходен код.
Стойност по подразбиране: освобождаване.
Прочетете повече за опциите за свързване
За да се покаже картата, се посочва контейнер с ненулев размер, всеки HTML елемент от блоков тип може да се използва като контейнер, в примера това е div.
Параметрите на картата са зададени в кода:
myMap = new ymaps.Map('map', (
център: , // център на картата на Нижни Новгород
увеличение: 12 - ниво на увеличение
});
Картата трябва да бъде създадена, след като цялата уеб страница се зареди. Това ще гарантира, че контейнерът за картата е създаден и може да бъде достъпен чрез id. За да инициализирате картата, след като страницата е заредена, можете да използвате функцията ready().
Готовата функция ще бъде извикана, когато API бъде зареден и DOM е генериран.
ymaps.ready(init);
функция init()(
// Създайте екземпляр на картата и го свържете към контейнера с
// даден идентификатор ("карта").
myMap = new ymaps.Map('map', (
// Когато инициализирате картата, трябва да посочите
// неговия център и мащабен фактор.
център: , // Нижни Новгород
увеличение: 12
});
По подразбиране картата показва всички налични контроли.
Тип карта - схема.
API предоставя пет вградени типа карти:
Схема (yandex#map) - по подразбиране;
Сателит (yandex#satellite);
Хибрид (yandex#hybrid);
Карта на хората (yandex#publicMap);
Хибрид на националната карта (yandex#publicMapHybrid).
Пример с определяне на вида на картата Сателит
Примерен код:
Както казах преди, стандартният набор от контроли „mediumMapDefaultSet“ се добавя към картата по подразбиране.
За да добавите необходимите контроли към картата, можете да посочите списък със съответните ключове в параметъра за контроли, когато създавате картата.
Ето примерния код за контроли за мащаб и тип на картата.
Примерен код:
|
Възможно е да зададете поведението на картата с помощта на параметъра за поведение.
Като зададем стойностите му, можем да активираме или деактивираме различни опции за поведението на картата:
мащабиране на картата чрез двойно щракване на бутона на мишката;
плъзгане на картата с мишката или с едно докосване;
мащабиране на картата при избор на област с левия бутон на мишката;
мащабиране на картата с мултитъч докосване;
мащабиране на картата при избор на област Кликнете с десния бутонмишки;
измерване на разстояние;
мащабиране на картата с колелцето на мишката.
Пример за код с деактивирано мащабиране на колелото на мишката.
|
Възможно е да промените параметрите на карта, след като е създадена.
Включете мащабирането на колелото на мишката
myMap.behaviors.enable("scrollZoom");
Изключи
myMap.behaviors.disable("scrollZoom");
Инсталиране на нов тип карта Folk
myMap.setType('yandex#publicMap');
Създаване на нов център на картата
Това е всичко за сега.
Следва продължение…