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

map.behavior.Manager

Расширяет ICustomizable, IEventEmitter, IParentOnMap.

Менеджер поведений карты. Позволяет включать и отключать поведения. У каждой карты уже есть собственный менеджер поведений, доступный как map.behaviors. Не инстанцируйте экземпляры этого класса без необходимости

См.: Map.behaviors

Конструктор | Поля | События | Методы

Конструктор

map.behavior.Manager(map[, behaviors[, options]])

Параметры:

ПараметрЗначение по умолчаниюОписание
map *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: Map

Карта.

behaviors

Тип: String | String[]

Список поведений карты, включенных сразу при создании карты. По умолчанию - "drag", "dblClickZoom", "rightMouseButtonMagnifier" для настольных браузеров, "drag", "dblClickZoom" и "multiTouch" - для мобильных.

Возможные значения ключей:

  • "default" - короткий синоним для включения/отключения поведений карты по умолчанию;
  • "drag" - перемещение карты при нажатой левой кнопке мыши либо одиночным касанием behavior.Drag;
  • "scrollZoom" - изменение масштаба колесом мыши behavior.ScrollZoom;
  • "dblClickZoom" - масштабирование карты двойным щелчком кнопки мыши behavior.DblClickZoom;
  • "multiTouch" - масштабирование карты двойным касанием (например, пальцами на сенсорном экране) behavior.MultiTouch;
  • "rightMouseButtonMagnifier" - увеличение области, выделенной правой кнопкой мыши (только для настольных браузеров), behavior.RightMouseButtonMagnifier;
  • "leftMouseButtonMagnifier" - увеличение области, выделенной левой кнопкой мыши либо одиночным касанием, behavior.LeftMouseButtonMagnifier;
  • "ruler" - измерение расстояния behavior.Ruler;
  • "routeEditor" - редактор маршрутов behavior.RouteEditor;

Добавлять и удалять классы поведений можно через хранилище поведений behavior.storage.

options

Тип: Object

Опции поведений. Можно задавать следующие опции:

* Обязательный параметр/опция.

Поля

ИмяТипОписание
eventsIEventManager

Менеджер событий.

Унаследовано от IEventEmitter.

optionsIOptionManager

Менеджер опций.

Унаследовано от ICustomizable.

События

ИмяОписание
mapchange

Сменилась карта. Поля данных:

  • oldMap - старая карта;
  • newMap - новая карта.

Унаследовано от IParentOnMap.

optionschange

Изменение в опциях объекта.

Унаследовано от ICustomizable.

Методы

ИмяВозвращаетОписание
disable(behaviors)map.behavior.Manager

Отключает поведения на карте.

enable(behaviors)map.behavior.Manager

Включает поведения на карте.

get(behaviorName)IBehavior

Возвращает экземпляр поведения по ключу.

getMap()Map

Возвращает ссылку на карту.

Унаследован от IParentOnMap.

isEnabled(behaviorName)Boolean

Проверяет, включено ли в настоящий момент поведение.

Описание методов

disable

Отключает поведения на карте.

Возвращает ссылку на себя.

Параметры:

ПараметрЗначение по умолчаниюОписание
behaviors*
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: String | String[]

Список отключаемых поведений.

* Обязательный параметр/опция.

Пример:

myMap.behaviors.disable('drag');

enable

Включает поведения на карте.

Возвращает ссылку на себя.

Параметры:

ПараметрЗначение по умолчаниюОписание
behaviors*
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: String | String[]

Список подключаемых поведений.

* Обязательный параметр/опция.

Пример:

myMap.behaviors.enable(['ruler', 'multiTouch']);

get

Возвращает экземпляр поведения по ключу.

Параметры:

ПараметрЗначение по умолчаниюОписание
behaviorName*
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: String

Имя поведения.

* Обязательный параметр/опция.

Пример:

myMap.behaviors.get('drag');

isEnabled

{Boolean} isEnabled(behaviorName)

Проверяет, включено ли в настоящий момент поведение.

Возвращает true, если поведение включено, в противном случае - false.

Параметры:

ПараметрЗначение по умолчаниюОписание
behaviorName*
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: String

Идентификатор поведения.

* Обязательный параметр/опция.

Пример:

// Если поведение "drag" отключено, то подключаем его
if (!(myMap.behaviors.isEnabled('drag'))) {
    myMap.behaviors.enable('drag');
}