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

map.action.Single

Расширяет IMapAction.

Простое движение карты. Движение выполняется сразу после передачи его в map.action.Manager.

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

Конструктор

map.action.Single(tick)

Создаёт простое (один шаг) движение карты.

Параметры:

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

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

]no-highlight]

Тип: Object

Параметры движения.

tick.callback

Тип: Function

Функция, которая будет вызвана после выполнения действия. Принимает в качестве параметра ошибку или null, если действие выполнилось успешно.

tick.center

Тип: Number[]

Новый центр карты в геокоординатах.

tick.checkZoomRange false

Тип: Boolean

Флаг, показывающий, нужно ли проверять новый коэффициент мастабирования карты. Если значение флага true, то перед выполнением действия будет запрошен интервал допустимых коэффициентов масштабирования в новой точке. Если указанный коэффициент выходит за интервал допустимых значений, он будет скорректирован. При этом будет изменено значение нового центра карты в глобальных пиксельных координатах.

tick.duration 0

Тип: Number

Время исполнения движения, в миллисекундах.

tick.globalPixelCenter

Тип: Number[]

Новый центр карты в глобальных пикселах. При одновременном задании параметров center и globalPixelCenter, параметр center игнорируется.

tick.timingFunction 'linear'

Тип: String

Тайминг-функция.

tick.zoom

Тип: Number

Новый коэффициент масштабирования карты.

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

Пример:

var myCallback = function(err) {
        if (err) {
            throw err;
        }
    },
    myAction = new ymaps.map.action.Single({
          center: [0, 0],
          zoom: 4,
          duration: 1000,
          timingFunction: 'ease-in',
          checkZoomRange: true,
          callback: myCallback
    });

// Действие выполнится сразу после вызова метода execute.
myMap.action.execute(myAction);

Поля

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

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

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

События

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

Событие, оповещающее карту об окончании движения.

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

tick

Событие, оповещающее карту о следующем шаге движения. Содержит поля:

  • globalPixelCenter - новый центр карты в глобальных пикселах;
  • zoom - новый коэффициент масштабирования карты;
  • duration - время, которое отводится на выполнение шага;
  • timingFunction - функция, описывающая вид движения.

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

Методы

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

Запускает движение на исполнение картой. Этот метод автоматически вызывается менеджером движений карты. С момента вызова IMapAction.begin менеджер движений слушает события IMapAction.tick и IMapAction.end и исполняет их.

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

end()

Останавливает движение.

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

isActive()

Boolean

Проверяет, исполняется ли движение картой в данный момент.

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

isActive

{Boolean} isActive()

Проверяет, исполняется ли движение картой в данный момент.

Возвращает true - движение в данный момент исполняется, false - нет.