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

multiRouter.EditorAddon

Примечание. Конструктор класса multiRouter.EditorAddon скрыт, так как данный класс не предназначен для самостоятельной инициализации.

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

Аддон редактора мультимаршрута.

Поля | События | Методы

Создает аддон редактора мультимаршрута.

Поля

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

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

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

options IOptionManager

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

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

state data.Manager

Менеджер состояния редактора мультимаршрута.

События

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

Событие, предшествующее событию midpointadd. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • coords: Number[] - координаты добавления промежуточной точки;
  • pointType: String – идентификатор типа добавляемой промежуточной точки;
  • insertIndex: Integer – индекс вставки промежуточной точки во множестве опорных точек мультимаршрута.
Имена методов, доступных через метод Event.callMethod:
  • setPointType - метод, позволяющий задать тип добавляемой точки. В качестве аргумента принимает строковый идентификатор типа (смотрите описание опции midPointsType).
  • setInsertIndex - метод, позволяющий скорректировать индекс вставки промежуточной точки, который будет фактически применен. В качестве аргумента принимает новый индекс.
Если у данного события вызвать метод Event.preventDefault, то последующее добавление промежуточной точки маршрута, как и событие "midpointadd", будет отменено.

beforemidpointdrag

Событие, предшествующее событию midpointdrag. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • pixelOffset: Number[] - пиксельный сдвиг по осям на данном шаге;
Имена методов, доступных через метод Event.callMethod:
  • setPixelOffset - метод, позволяющий скорректировать значение пиксельного сдвига, который будет фактически применен. В качестве аргумента принимает новый пиксельный сдвиг в виде массива из двух чисел.
Если у данного события вызвать метод Event.preventDefault, то последующее событие "midpointdrag" будет отменено.

beforemidpointpinshow

Событие, предшествующее событию midpointpinshow. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • pin: Placemark - ссылка на объект маркера;
  • globalPixels: Number[] - глобальные пиксельные координаты маркера;
  • segment: multiRouter.driving.Segment – ссылка на сегмент маршрута, над которым появился маркер.
Если у данного события вызвать метод Event.preventDefault, то последующее событие "midpointpinshow" будет отменено, а маркер будет скрыт.

beforeviapointdrag

Событие, предшествующее событию viapointdrag. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • pixelOffset: Number[] - пиксельный сдвиг по осям на данном шаге;
  • viaPoint: multiRouter.ViaPoint – ссылка на объект перетаскиваемой транзитной точки.
Имена методов, доступных через метод Event.callMethod:
  • setPixelOffset - метод, позволяющий скорректировать значение пиксельного сдвига, который будет фактически применен. В качестве аргумента принимает новый пиксельный сдвиг в виде массива из двух чисел.
Если у данного события вызвать метод Event.preventDefault, то последующее событие "viapointdrag" будет отменено.

beforeviapointdragstart

Событие, предшествующее событию viapointdragstart. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • domEvent: DomEvent – исходное DOM-событие, если оно имеется;
  • viaPoint: multiRouter.ViaPoint – ссылка на объект перетаскиваемой транзитной точки.
Если у данного события вызвать метод Event.preventDefault, то последующее перетаскивание, как и событие "viapointdragstart", будет отменено.

beforeviapointremove

Событие, предшествующее событию viapointremove. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • viaPoint: multiRouter.ViaPoint - ссылка на объект удаляемой транзитной точки.
Если у данного события вызвать метод Event.preventDefault, то удаление транзитной точки, как и последующее событие "viapointremove", будет отменено.

beforewaypointadd

Событие, предшествующее событию waypointadd. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • coords: Number[] - координаты добавленной путевой точки.
Имена методов, доступных через метод Event.callMethod:
  • setCoords - метод, позволяющий скорректировать координаты добавляемой путевой точки. В качестве аргумента принимает новые координаты в виде массива из двух чисел.
Если у данного события вызвать метод Event.preventDefault, то добавление путевой точки, как и последующее событие "waypointadd", будет отменено.

beforewaypointdrag

Событие, предшествующее событию waypointdrag. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • pixelOffset: Number[] - пиксельный сдвиг по осям на данном шаге;
  • wayPoint: multiRouter.WayPoint – ссылка на объект перетаскиваемой путевой точки.
Имена методов, доступных через метод Event.callMethod:
  • setPixelOffset - метод, позволяющий скорректировать значение пиксельного сдвига, который будет фактически применен. В качестве аргумента принимает новый пиксельный сдвиг в виде массива из двух чисел.
Если у данного события вызвать метод Event.preventDefault, то последующее событие "waypointdrag" будет отменено.

beforewaypointdragstart

Событие, предшествующее событию waypointdragstart. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • domEvent: DomEvent – исходное DOM-событие, если оно имеется;
  • wayPoint: multiRouter.WayPoint – ссылка на объект перетаскиваемой путевой точки.
Если у данного события вызвать метод Event.preventDefault, то последующее перетаскивание, как и событие "waypointdragstart", будет отменено.

beforewaypointremove

Событие, предшествующее событию waypointremove. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • wayPoint: multiRouter.WayPoint - ссылка на объект удаляемой путевой точки.
Если у данного события вызвать метод Event.preventDefault, то удаление путевой точки, как и последующее событие "waypointremove", будет отменено.

midpointadd

Добавление промежуточной точки маршрута. Тип точки определяется значением опции midPointsType. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • coords: Number[] - координаты добавления промежуточной точки;
  • pointType: String – идентификатор типа добавляемой промежуточной точки;
  • insertIndex: Integer – индекс вставки промежуточной точки во множестве опорных точек мультимаршрута.

midpointdrag

Перетаскивание добавленной промежуточной точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • pixelOffset: Number[] - пиксельный сдвиг по осям на данном шаге;

midpointdragend

Завершение перетаскивания добавленной промежуточной точки. Экземпляр класса Event.

midpointpinshow

Появление перетаскиваемого маркера при наведении на активный маршрут. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • pin: Placemark - ссылка на объект маркера;
  • globalPixels: Number[] - глобальные пиксельные координаты маркера;
  • segment: multiRouter.driving.Segment – ссылка на сегмент маршрута, над которым появился маркер.

optionschange

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

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

start

Включение редактора. Экземпляр класса Event.

stop

Выключение редактора. Экземпляр класса Event.

viapointdrag

Перетаскивание транзитной точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • pixelOffset: Number[] - пиксельный сдвиг по осям на данном шаге;
  • viaPoint: multiRouter.ViaPoint – ссылка на объект перетаскиваемой транзитной точки.

viapointdragend

Завершение перетаскивания транзитной точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • viaPoint: multiRouter.ViaPoint – ссылка на объект перетаскиваемой транзитной точки.

viapointdragstart

Начало перетаскивания транзитной точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • domEvent: DomEvent – исходное DOM-событие, если оно имеется;
  • viaPoint: multiRouter.ViaPoint – ссылка на объект перетаскиваемой транзитной точки.

viapointremove

Удаление транзитной точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • viaPoint: multiRouter.ViaPoint - ссылка на объект удаленной транзитной точки.

waypointadd

Добавление путевой точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • coords: Number[] - координаты добавленной путевой точки.

waypointdrag

Перетаскивание путевой точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • pixelOffset: Number[] - пиксельный сдвиг по осям на данном шаге;
  • wayPoint: multiRouter.WayPoint – ссылка на объект перетаскиваемой путевой точки.

waypointdragend

Завершение перетаскивания путевой точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • wayPoint: multiRouter.WayPoint – ссылка на объект перетаскиваемой путевой точки.

waypointdragstart

Начало перетаскивания путевой точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • domEvent: DomEvent – исходное DOM-событие, если оно имеется;
  • wayPoint: multiRouter.WayPoint – ссылка на объект перетаскиваемой путевой точки.

waypointremove

Удаление путевой точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • wayPoint: multiRouter.WayPoint - ссылка на объект удаленной путевой точки.

Методы

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

Boolean

Возвращает признак того, что редактор в данный момент включен.

start(state)

Включает редактор.

stop()

Отключает редактор.

Описание полей

state

{data.Manager} state

Менеджер состояния редактора мультимаршрута.

Описание событий

beforemidpointadd

Событие, предшествующее событию midpointadd. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • coords: Number[] - координаты добавления промежуточной точки;
  • pointType: String – идентификатор типа добавляемой промежуточной точки;
  • insertIndex: Integer – индекс вставки промежуточной точки во множестве опорных точек мультимаршрута.
Имена методов, доступных через метод Event.callMethod:
  • setPointType - метод, позволяющий задать тип добавляемой точки. В качестве аргумента принимает строковый идентификатор типа (смотрите описание опции midPointsType).
  • setInsertIndex - метод, позволяющий скорректировать индекс вставки промежуточной точки, который будет фактически применен. В качестве аргумента принимает новый индекс.
Если у данного события вызвать метод Event.preventDefault, то последующее добавление промежуточной точки маршрута, как и событие "midpointadd", будет отменено.

beforemidpointdrag

Событие, предшествующее событию midpointdrag. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • pixelOffset: Number[] - пиксельный сдвиг по осям на данном шаге;
Имена методов, доступных через метод Event.callMethod:
  • setPixelOffset - метод, позволяющий скорректировать значение пиксельного сдвига, который будет фактически применен. В качестве аргумента принимает новый пиксельный сдвиг в виде массива из двух чисел.
Если у данного события вызвать метод Event.preventDefault, то последующее событие "midpointdrag" будет отменено.

beforemidpointpinshow

Событие, предшествующее событию midpointpinshow. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • pin: Placemark - ссылка на объект маркера;
  • globalPixels: Number[] - глобальные пиксельные координаты маркера;
  • segment: multiRouter.driving.Segment – ссылка на сегмент маршрута, над которым появился маркер.
Если у данного события вызвать метод Event.preventDefault, то последующее событие "midpointpinshow" будет отменено, а маркер будет скрыт.

beforeviapointdrag

Событие, предшествующее событию viapointdrag. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • pixelOffset: Number[] - пиксельный сдвиг по осям на данном шаге;
  • viaPoint: multiRouter.ViaPoint – ссылка на объект перетаскиваемой транзитной точки.
Имена методов, доступных через метод Event.callMethod:
  • setPixelOffset - метод, позволяющий скорректировать значение пиксельного сдвига, который будет фактически применен. В качестве аргумента принимает новый пиксельный сдвиг в виде массива из двух чисел.
Если у данного события вызвать метод Event.preventDefault, то последующее событие "viapointdrag" будет отменено.

beforeviapointdragstart

Событие, предшествующее событию viapointdragstart. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • domEvent: DomEvent – исходное DOM-событие, если оно имеется;
  • viaPoint: multiRouter.ViaPoint – ссылка на объект перетаскиваемой транзитной точки.
Если у данного события вызвать метод Event.preventDefault, то последующее перетаскивание, как и событие "viapointdragstart", будет отменено.

beforeviapointremove

Событие, предшествующее событию viapointremove. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • viaPoint: multiRouter.ViaPoint - ссылка на объект удаляемой транзитной точки.
Если у данного события вызвать метод Event.preventDefault, то удаление транзитной точки, как и последующее событие "viapointremove", будет отменено.

beforewaypointadd

Событие, предшествующее событию waypointadd. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • coords: Number[] - координаты добавленной путевой точки.
Имена методов, доступных через метод Event.callMethod:
  • setCoords - метод, позволяющий скорректировать координаты добавляемой путевой точки. В качестве аргумента принимает новые координаты в виде массива из двух чисел.
Если у данного события вызвать метод Event.preventDefault, то добавление путевой точки, как и последующее событие "waypointadd", будет отменено.

beforewaypointdrag

Событие, предшествующее событию waypointdrag. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • pixelOffset: Number[] - пиксельный сдвиг по осям на данном шаге;
  • wayPoint: multiRouter.WayPoint – ссылка на объект перетаскиваемой путевой точки.
Имена методов, доступных через метод Event.callMethod:
  • setPixelOffset - метод, позволяющий скорректировать значение пиксельного сдвига, который будет фактически применен. В качестве аргумента принимает новый пиксельный сдвиг в виде массива из двух чисел.
Если у данного события вызвать метод Event.preventDefault, то последующее событие "waypointdrag" будет отменено.

beforewaypointdragstart

Событие, предшествующее событию waypointdragstart. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • domEvent: DomEvent – исходное DOM-событие, если оно имеется;
  • wayPoint: multiRouter.WayPoint – ссылка на объект перетаскиваемой путевой точки.
Если у данного события вызвать метод Event.preventDefault, то последующее перетаскивание, как и событие "waypointdragstart", будет отменено.

beforewaypointremove

Событие, предшествующее событию waypointremove. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • wayPoint: multiRouter.WayPoint - ссылка на объект удаляемой путевой точки.
Если у данного события вызвать метод Event.preventDefault, то удаление путевой точки, как и последующее событие "waypointremove", будет отменено.

midpointadd

Добавление промежуточной точки маршрута. Тип точки определяется значением опции midPointsType. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • coords: Number[] - координаты добавления промежуточной точки;
  • pointType: String – идентификатор типа добавляемой промежуточной точки;
  • insertIndex: Integer – индекс вставки промежуточной точки во множестве опорных точек мультимаршрута.

midpointdrag

Перетаскивание добавленной промежуточной точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • pixelOffset: Number[] - пиксельный сдвиг по осям на данном шаге;

midpointdragend

Завершение перетаскивания добавленной промежуточной точки. Экземпляр класса Event.

midpointpinshow

Появление перетаскиваемого маркера при наведении на активный маршрут. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • pin: Placemark - ссылка на объект маркера;
  • globalPixels: Number[] - глобальные пиксельные координаты маркера;
  • segment: multiRouter.driving.Segment – ссылка на сегмент маршрута, над которым появился маркер.

start

Включение редактора. Экземпляр класса Event.

stop

Выключение редактора. Экземпляр класса Event.

viapointdrag

Перетаскивание транзитной точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • pixelOffset: Number[] - пиксельный сдвиг по осям на данном шаге;
  • viaPoint: multiRouter.ViaPoint – ссылка на объект перетаскиваемой транзитной точки.

viapointdragend

Завершение перетаскивания транзитной точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • viaPoint: multiRouter.ViaPoint – ссылка на объект перетаскиваемой транзитной точки.

viapointdragstart

Начало перетаскивания транзитной точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • domEvent: DomEvent – исходное DOM-событие, если оно имеется;
  • viaPoint: multiRouter.ViaPoint – ссылка на объект перетаскиваемой транзитной точки.

viapointremove

Удаление транзитной точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • viaPoint: multiRouter.ViaPoint - ссылка на объект удаленной транзитной точки.

waypointadd

Добавление путевой точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • coords: Number[] - координаты добавленной путевой точки.

waypointdrag

Перетаскивание путевой точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • pixelOffset: Number[] - пиксельный сдвиг по осям на данном шаге;
  • wayPoint: multiRouter.WayPoint – ссылка на объект перетаскиваемой путевой точки.

waypointdragend

Завершение перетаскивания путевой точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • wayPoint: multiRouter.WayPoint – ссылка на объект перетаскиваемой путевой точки.

waypointdragstart

Начало перетаскивания путевой точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • domEvent: DomEvent – исходное DOM-событие, если оно имеется;
  • wayPoint: multiRouter.WayPoint – ссылка на объект перетаскиваемой путевой точки.

waypointremove

Удаление путевой точки. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • wayPoint: multiRouter.WayPoint - ссылка на объект удаленной путевой точки.

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

isActive

{Boolean} isActive()

Возвращает признак того, что редактор в данный момент включен.

start

{} start(state)

Включает редактор.

Параметры:

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

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

]no-highlight]

Тип: Object

Начальное состояние редактора.

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

stop

{} stop()

Отключает редактор.