map.behavior.Manager

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

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

См.: Map.behaviors

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

Конструктор

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

Параметры:

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

Тип: 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

Опции поведений. Можно задавать следующие опции:
Параметр Значение по умолчанию Описание
map * —

Тип: 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

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

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

Поля

Имя Тип Описание
events IEventManager

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

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

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

Унаследовано от ICustomizable.
Имя Тип Описание
events IEventManager

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

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

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

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

События

Имя Описание
mapchange
Сменилась карта. Поля данных:
  • oldMap - старая карта;
  • newMap - новая карта.

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

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

Унаследовано от ICustomizable.
Имя Описание
mapchange
Сменилась карта. Поля данных:
  • oldMap - старая карта;
  • newMap - новая карта.

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

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

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

Методы

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

map.behavior.Manager

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

map.behavior.Manager

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

IBehavior

Returns экземпляр поведения по ключу.
getMap()

Map

Returns ссылку на карту.

Унаследован от IParentOnMap.
isEnabled(behaviorName)

Boolean

Проверяет, включено ли в настоящий момент поведение.
Имя Возвращает Описание
disable(behaviors)

map.behavior.Manager

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

map.behavior.Manager

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

IBehavior

Returns экземпляр поведения по ключу.
getMap()

Map

Returns ссылку на карту.

Унаследован от IParentOnMap.
isEnabled(behaviorName)

Boolean

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

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

disable

{map.behavior.Manager} disable(behaviors)

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

Returns ссылку на себя.

Параметры:

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

Тип: String|String[]

Список отключаемых поведений.
Параметр Значение по умолчанию Описание
behaviors * —

Тип: String|String[]

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

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

Пример: 

myMap.behaviors.disable('drag');

enable

{map.behavior.Manager} enable(behaviors)

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

Returns ссылку на себя.

Параметры:

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

Тип: String|String[]

Список подключаемых поведений.
Параметр Значение по умолчанию Описание
behaviors * —

Тип: String|String[]

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

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

Пример: 

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

get

{IBehavior} get(behaviorName)

Returns экземпляр поведения по ключу.

Параметры:

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

Тип: String

Имя поведения.
Параметр Значение по умолчанию Описание
behaviorName * —

Тип: String

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

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

Пример: 

myMap.behaviors.get('drag');

isEnabled

{Boolean} isEnabled(behaviorName)

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

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

Параметры:

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

Тип: String

Идентификатор поведения.
Параметр Значение по умолчанию Описание
behaviorName * —

Тип: String

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

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

Пример: 

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