---
metadata:
  - name: generator
    content: Diplodoc Platform v5.39.1
alternate:
  - https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/control.RulerControl.md
  - https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.RulerControl.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/llms.txt

# control.RulerControl

Расширяет [control.Button](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.Button.md).

Элемент управления "Линейка". Ключ элемента управления в хранилище [control.storage](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.storage.md) — "rulerControl".

[Конструктор](#constructor-summary) | [Поля ](#properties-summary) | [События ](#events-summary) | [Методы ](#methods-summary)

## Конструктор {#constructor-summary}

```javascript
control.RulerControl([parameters])
```

**Параметры:**

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`parameters`](#param-parameters) | — | Тип: Object

Параметры элемента управления. ||
|| [`parameters.data`](#param-parameters.data) | — | Тип: Object

Объект, описывающий данные элемента управления. ||
|| [`parameters.options`](#param-parameters.options) | — | Тип: Object

Опции элемента управления. ||
|| [`parameters.options.adjustMapMargin`](#param-parameters.options.adjustMapMargin) | false | Тип: Boolean

Регистрирует ли элемент управления свои размеры в менеджере отступов карты [map.margin.Manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.margin.Manager.md). ||
|| [`parameters.options.position`](#param-parameters.options.position) | — | Тип: Object

Объект, описывающий позицию элемента управления. При указании опции position значение опции float автоматически трактуется как "none". ||
|| [`parameters.options.position.bottom`](#param-parameters.options.position.bottom) | 30 | Тип: Number\|String

Положение относительно нижнего края карты. ||
|| [`parameters.options.position.left`](#param-parameters.options.position.left) | 'auto' | Тип: Number\|String

Положение относительно левого края карты. ||
|| [`parameters.options.position.right`](#param-parameters.options.position.right) | 10 | Тип: Number\|String

Положение относительно правого края карты. ||
|| [`parameters.options.position.top`](#param-parameters.options.position.top) | 'auto' | Тип: Number\|String

Положение относительно верхнего края карты. ||
|| [`parameters.options.scaleLine`](#param-parameters.options.scaleLine) | true | Тип: Boolean

Флаг, указывающий, отображать или не отображать масштабную линейку справа от кнопки линейки. ||
|| [`parameters.options.visible`](#param-parameters.options.visible) | true | Тип: Boolean

Признак того, что элемент управления отображается. ||
|| [`parameters.state`](#param-parameters.state) | — | Тип: Object

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


## Поля {#properties-summary}

#|
|| **Имя** | **Тип** | **Описание** ||
|| [data](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.Button.md#data) | [data.Manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/data.Manager.md) | Данные кнопки. Имена полей, доступных через метод data.Manager.get:
- image - иконка кнопки, если есть;
- content - cодержимое кнопки в виде HTML;
- title - текст всплывающей подсказки, которая появляется при наведении на кнопку курсора мыши.

Унаследовано от [control.Button](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.Button.md#data). ||
|| [events](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventManager.md) | Менеджер событий.

Унаследовано от [IEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events). ||
|| [options](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#options) | [IOptionManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOptionManager.md) | Менеджер опций.

Унаследовано от [IControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#options). ||
|| [press](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.Button.md#press) | | Событие, сигнализирующее о том, что кнопка была нажата. В отличии от click генерируется только если состояние isEnabled == true. Экземпляр класса Event.

Унаследовано от [control.Button](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.Button.md#press). ||
|| [state](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.Button.md#state) | [data.Manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/data.Manager.md) | Состояние кнопки. Имена полей, доступных через метод data.Manager.get:
- selected - признак, нажата ли кнопка;
- enabled - признак, активна ли кнопка.
- size - размер, который в данный момент выставлен кнопке;

Унаследовано от [control.Button](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.Button.md#state). ||
|#

## События {#events-summary}

#|
|| **Имя** | **Описание** ||
|| [click](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.Button.md#event-click) | Нажатие на кнопку. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md).

Унаследовано от [control.Button](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.Button.md#event-click). ||
|| [deselect](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#event-deselect) | Элемент управления не выбран.

Унаследовано от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#event-deselect). ||
|| [disable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#event-disable) | Элемент управления стал недоступным.

Унаследовано от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#event-disable). ||
|| [enable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#event-enable) | Элемент управления стал доступным.

Унаследовано от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#event-enable). ||
|| [optionschange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange) | Изменение в опциях объекта.

Унаследовано от [ICustomizable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange). ||
|| [parentchange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange) | Сменился родительский объект.

Поля данных:

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

Унаследовано от [IChild](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange). ||
|| [select](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#event-select) | Элемент управления выбран.

Унаследовано от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#event-select). ||
|#

## Методы {#methods-summary}

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [deselect](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#deselect)() | | Отменяет выбор элемента управления (выключает).

Унаследован от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#deselect). ||
|| [disable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#disable)() | | Делает элемент управления недоступным (запрещены пользовательские действия).

Унаследован от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#disable). ||
|| [enable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#enable)() | | Делает элемент управления доступным (разрешены пользовательские действия).

Унаследован от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#enable). ||
|| [getMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.Button.md#getMap)() | [Map](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map.md) | Возвращает ссылку на карту.

Унаследован от [control.Button](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.Button.md#getMap). ||
|| [getParent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#getParent)() | [IControlParent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControlParent.md)\|null | Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен.

Унаследован от [IControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#getParent). ||
|| [isEnabled](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#isEnabled)() | Boolean | Возвращает true - элемент управления доступен, false - недоступен.

Унаследован от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#isEnabled). ||
|| [isSelected](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#isSelected)() | Boolean | Возвращает true - элемент управления выбран, false - не выбран.

Унаследован от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#isSelected). ||
|| [select](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#select)() | | Выбирает (включает) элемент управления.

Унаследован от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#select). ||
|| [setParent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#setParent)([parent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#setParent-param-parent)) | [IChildOnMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md) | Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта.

Унаследован от [IControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#setParent). ||
|#

<!-- XLIFF_FARM_OWQ5Yjgy_CACHING -->