---
metadata:
  - name: generator
    content: Diplodoc Platform v5.39.1
alternate:
  - https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/behavior.Ruler.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/llms.txt

# behavior.Ruler

Расширяет [IBehavior](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IBehavior.md).

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

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

```javascript
behavior.Ruler()
```

## Поля {#fields}

#|
|| **Имя** | **Тип** | **Описание** ||
|| [events](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IEventManager.md) | Менеджер событий.

Унаследовано от [IEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IEventEmitter.md#events). ||
|| [geometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/behavior.Ruler.md#geometry) | [geometry.LineString](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/geometry.LineString.md) | Геометрия поведения "Линейка". ||
|| [options](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOptionManager.md) | Менеджер событий.

Унаследовано от [ICustomizable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#options). ||
|#

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

#|
|| **Имя** | **Описание** ||
|| [disable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IBehavior.md#event-disable) | Выключение поведения.

Унаследовано от [IBehavior](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IBehavior.md#event-disable). ||
|| [enable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IBehavior.md#event-enable) | Включение поведения.

Унаследовано от [IBehavior](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IBehavior.md#event-enable). ||
|| [mapchange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#event-mapchange) | Сменилась карта. Поля данных: 
• oldMap - старая карта;

• newMap - новая карта.

Унаследовано от [IChildOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#event-mapchange). ||
|| [optionschange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#event-optionschange) | Изменение в опциях объекта.

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

Поля данных:

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

Унаследовано от [IChild](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChild.md#event-parentchange). ||
|#

## Методы {#method}

#|
|| **Заголовок1** | **Заголовок2** | **Заголовок2** ||
|| [close](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/behavior.Ruler.md#close)() |  | Удаляет все точки линейки. Если текущее количество точек больше двух, то будет выведен запрос на подтверждение действия. ||
|| [disable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IBehavior.md#disable)() |  | Выключает поведение.

Унаследован от [IBehavior](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IBehavior.md#disable). ||
|| [enable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IBehavior.md#enable)() |  | Включает поведение.

Унаследован от [IBehavior](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IBehavior.md#enable). ||
|| [getParent](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#getParent)() | [IParentOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IParentOnMap.md) | Returns ссылку на родительский объект.

Унаследован от [IChildOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#getParent). ||
|| [getState](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/behavior.Ruler.md#getState)() | String | Состояние линейки описывается строкой, состоящей из последовательностей, разделяемых символом "~". Каждая последовательность представляет собой подстроку вида "долгота,широта" и описывает приращение координат относительно предыдущей точки линейки. ||
|| [isEnabled](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IBehavior.md#isEnabled)() | Boolean | Проверяет, включено ли поведение.

Унаследован от [IBehavior](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IBehavior.md#isEnabled). ||
|| [setParent](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#setParent)([parent](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#setParent-param-parent)) | [IChildOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md) | Устанавливает родительский объект.

Унаследован от [IChildOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#setParent). ||
|| [setState](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/behavior.Ruler.md#setState)([state](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/behavior.Ruler.md#setState-param-state)) |  | Восстанавливает состояние линейки из закодированной строки. Смотрите behavior.Ruler.getState. ||
|#

## Описание полей {#description-fields}

### geometry

```javascript
{geometry.LineString} geometry
```

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

**Пример:**

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

## Описание методов {#description-methods}

### close

```javascript
{} close()
```

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

### getState

```javascript
{String} getState()
```

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

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

### setState

```javascript
{} setState(state)
```

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

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

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

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

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

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