control.ScaleLine

Расширяет IControl.

Элемент управления "Масштабная линейка".

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

Конструктор

control.ScaleLine([options])

Параметры:

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

Тип: Object

Опции масштабной линейки.

options.layout

Тип: Function|String

Макет элемента управления. (Тип: конструктор объекта с интерфейсом ILayout или ключ макета).

options.position { right: 7, bottom: 50 }

Тип: Object

Положение элемента управления над картой. Задается в виде объекта со следующими полями:
  • top - отступ от верхнего края контейнера карты в пикселах;
  • right - отступ от правого края контейнера карты в пикселах;
  • bottom - отступ от нижнего края контейнера карты в пикселах;
  • left - отступ от левого края контейнера карты в пикселах.
Если при этом заданы одновременно и top, и bottom, то значение bottom игнорируется. Аналогично, если заданы одновременно и left, и right, то значение right игнорируется. Если элемент управления добавляется в группу элементов (например, в тулбар или раскрывающийся список), то значение position не применяется.
options.visible true

Тип: Boolean

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

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

Тип: Object

Опции масштабной линейки.

options.layout

Тип: Function|String

Макет элемента управления. (Тип: конструктор объекта с интерфейсом ILayout или ключ макета).

options.position { right: 7, bottom: 50 }

Тип: Object

Положение элемента управления над картой. Задается в виде объекта со следующими полями:
  • top - отступ от верхнего края контейнера карты в пикселах;
  • right - отступ от правого края контейнера карты в пикселах;
  • bottom - отступ от нижнего края контейнера карты в пикселах;
  • left - отступ от левого края контейнера карты в пикселах.
Если при этом заданы одновременно и top, и bottom, то значение bottom игнорируется. Аналогично, если заданы одновременно и left, и right, то значение right игнорируется. Если элемент управления добавляется в группу элементов (например, в тулбар или раскрывающийся список), то значение position не применяется.
options.visible true

Тип: Boolean

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

Пример:

map.controls.add('scaleLine');

Поля

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

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

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

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

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

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

События

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

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

parentchange

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

Поля данных:

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

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

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

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

parentchange

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

Поля данных:

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

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

Методы

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

IControlParent

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

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

setParent(parent)

IChildOnMap

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

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

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

IControlParent

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

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

setParent(parent)

IChildOnMap

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

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