behavior.Ruler

Расширяет IBehavior.

Поведение "Линейка". Позволяет отмечать на карте точки и отображать расстояния между ними.

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

Конструктор

behavior.Ruler()

Поля

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

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

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

geometry geometry.LineString

Геометрия поведения "Линейка".

options IOptionManager

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

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

События

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

Выключение поведения.

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

enable

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

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

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

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

optionschange

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

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

parentchange

Сменился родительский объект.

Поля данных:

  • oldParent - старый родитель;
  • newParent - новый родитель.

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

Методы

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

Удаляет все точки линейки. Если текущее количество точек больше двух, то будет выведен запрос на подтверждение действия.

disable()

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

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

enable()

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

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

getParent()

IParentOnMap

Returns ссылку на родительский объект.

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

getState()

String

Состояние линейки описывается строкой, состоящей из последовательностей, разделяемых символом "~". Каждая последовательность представляет собой подстроку вида "долгота,широта" и описывает приращение координат относительно предыдущей точки линейки.

isEnabled()

Boolean

Проверяет, включено ли поведение.

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

setParent(parent)

IChildOnMap

Устанавливает родительский объект.

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

setState(state)

Восстанавливает состояние линейки из закодированной строки. Смотрите behavior.Ruler.getState.

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

geometry

Геометрия поведения "Линейка".

Пример:

// Задаем координаты первой точки линейки.
myMap.behaviors.get('ruler').geometry.set(0, [0, 0]);

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

close

{} close()

Удаляет все точки линейки. Если текущее количество точек больше двух, то будет выведен запрос на подтверждение действия.

getState

{String} getState()

Состояние линейки описывается строкой, состоящей из последовательностей, разделяемых символом "~". Каждая последовательность представляет собой подстроку вида "долгота,широта" и описывает приращение координат относительно предыдущей точки линейки.

Returns текущее состояние линейки в закодированном виде.

setState

{} setState(state)

Восстанавливает состояние линейки из закодированной строки. Смотрите behavior.Ruler.getState.

Параметры:

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

Тип: String

Закодированное состояние линейки.

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