control.RulerControl

Расширяет control.Button .

Элемент управления "Линейка". Ключ элемента управления в хранилище control.storage — "rulerControl".

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

Конструктор

control.RulerControl([parameters])

Параметры:

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

Тип: Object

Параметры элемента управления.

parameters.data

Тип: Object

Объект, описывающий данные элемента управления.

parameters.options

Тип: Object

Опции элемента управления.

parameters.options.adjustMapMargin false

Тип: Boolean

Регистрирует ли элемент управления свои размеры в менеджере отступов карты map.margin.Manager .

parameters.options.position

Тип: Object

Объект, описывающий позицию элемента управления. При указании опции position значение опции float автоматически трактуется как "none".

parameters.options.position.bottom 30

Тип: Number|String

Положение относительно нижнего края карты.

parameters.options.position.left 'auto'

Тип: Number|String

Положение относительно левого края карты.

parameters.options.position.right 10

Тип: Number|String

Положение относительно правого края карты.

parameters.options.position.top 'auto'

Тип: Number|String

Положение относительно верхнего края карты.

parameters.options.scaleLine true

Тип: Boolean

Флаг, указывающий, отображать или не отображать масштабную линейку справа от кнопки линейки.

parameters.options.visible true

Тип: Boolean

Признак того, что элемент управления отображается.

parameters.state

Тип: Object

Объект, описывающий состояние элемента управления.

Поля

Имя Тип Описание
data data.Manager
Данные кнопки. Имена полей, доступных через метод data.Manager.get:
  • image - иконка кнопки, если есть;
  • content - cодержимое кнопки в виде HTML;
  • title - текст всплывающей подсказки, которая появляется при наведении на кнопку курсора мыши.

Унаследовано от control.Button .

events IEventManager

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

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

options IOptionManager

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

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

press

Событие, сигнализирующее о том, что кнопка была нажата. В отличии от click генерируется только если состояние isEnabled == true. Экземпляр класса Event.

Унаследовано от control.Button .

state data.Manager
Состояние кнопки. Имена полей, доступных через метод data.Manager.get:
  • selected - признак, нажата ли кнопка;
  • enabled - признак, активна ли кнопка;
  • size - размер, который в данный момент выставлен кнопке;

Унаследовано от control.Button .

События

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

Нажатие на кнопку. Экземпляр класса Event .

Унаследовано от control.Button .

deselect

Элемент управления не выбран.

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

disable

Элемент управления стал недоступным.

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

enable

Элемент управления стал доступным.

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

optionschange

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

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

parentchange

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

Поля данных:

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

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

select

Элемент управления выбран.

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

Методы

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

Отменяет выбор элемента управления (выключает).

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

disable ()

Делает элемент управления недоступным (запрещены пользовательские действия).

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

enable ()

Делает элемент управления доступным (разрешены пользовательские действия).

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

getMap ()

Map

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

Унаследован от control.Button .

getParent ()

IControlParent |null

Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен.

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

isEnabled ()

Boolean

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

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

isSelected ()

Boolean

Возвращает true - элемент управления выбран, false - не выбран.

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

select ()

Выбирает (включает) элемент управления.

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

setParent (parent)

IChildOnMap

Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта.

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