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

# overlay.Polyline

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

Оверлей линии. По умолчанию оверлеи не добавлены в package.full (стандартного набора модулей). Для создания собственного экземпляра оверлея необходимо использовать [overlay.storage](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/overlay.storage.md).

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

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

```javascript
overlay.Polyline(geometry[, data[, options]])
```

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`geometry`](#param-geometry)[*](*star) | — | Тип: [IPixelLineStringGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPixelLineStringGeometry.md)

Пиксельная геометрия фигуры. ||
|| [`data`](#param-data) | — | Тип: Object

Данные. ||
|| [`options`](#param-options) | — | Тип: Object

Опции. ||
|| [`options.interactive`](#param-options.interactive) | true | Тип: Boolean

Опция, позволяющая отключить реакцию объекта на dom-события. ||
|| [`options.opacity`](#param-options.opacity) | — | Тип: Number

Общая прозрачность. ||
|| [`options.separateContainer`](#param-options.separateContainer) | — | Тип: Boolean

Производит отрисовку в отдельном слое. ||
|| [`options.strokeColor`](#param-options.strokeColor) | — | Тип: String

Цвет линии [graphics.style.color](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/graphics.style.color.md). ||
|| [`options.strokeOpacity`](#param-options.strokeOpacity) | — | Тип: Number

Прозрачность контура. ||
|| [`options.strokeStyle`](#param-options.strokeStyle) | — | Тип: Number[]\|String

Стиль контура [graphics.style.stroke](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/graphics.style.stroke.md). ||
|| [`options.strokeWidth`](#param-options.strokeWidth) | — | Тип: Number

Ширина линии. ||
|#

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

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

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

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

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

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

#|
|| **Имя** | **Описание** ||
|| [click](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-click) | Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-click). ||
|| [contextmenu](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu) | Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu). ||
|| [datachange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#event-datachange) | Изменение данных. Поля данных:
- oldData - старые данные;
- newData - новые данные.

Унаследовано от [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#event-datachange). ||
|| [dblclick](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick) | Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick). ||
|| [emptinesschange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#event-emptinesschange) | Изменение признака пустоты оверлея. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md).

Унаследовано от [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#event-emptinesschange). ||
|| [geometrychange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#event-geometrychange) | Изменение геометрии. Поля данных:
- oldGeometry - старая пиксельная геометрия;
- newGeometry - новая пиксельная геометрия.

Унаследовано от [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#event-geometrychange). ||
|| [mapchange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#event-mapchange) | Сменилась карта. Поля данных:
- oldMap - старая карта;
- newMap - новая карта.

Унаследовано от [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#event-mapchange). ||
|| [mousedown](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown) | Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown). ||
|| [mouseenter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter) | Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter). ||
|| [mouseleave](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave) | Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave). ||
|| [mousemove](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove) | Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove). ||
|| [mouseup](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup) | Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup). ||
|| [multitouchend](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend) | Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent.

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend). ||
|| [multitouchmove](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove) | Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
- clientX - координата касания X относительно видимой области браузера;
- clientY - координата касания Y относительно видимой области браузера;
- pageX - координата касания X касания относительно начала документа;
- pageY - координата касания Y касания относительно начала документа.

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove). ||
|| [multitouchstart](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart) | Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
- clientX - координата касания X относительно видимой области браузера;
- clientY - координата касания Y относительно видимой области браузера;
- pageX - координата касания X касания относительно начала документа;
- pageY - координата касания Y касания относительно начала документа.

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart). ||
|| [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). ||
|| [shapechange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#event-shapechange) | Изменение фигуры области охватывающей оверлей. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md).

Унаследовано от [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#event-shapechange). ||
|| [wheel](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-wheel) | Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

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

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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [getData](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#getData)() | Object | Возвращает объект данных оверлея.

Унаследован от [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#getData). ||
|| [getGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#getGeometry)() | [IPixelGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPixelGeometry.md) | Возвращает текущую пиксельную геометрию.

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

Унаследован от [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#getMap). ||
|| [getShape](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#getShape)() | [IShape](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md)\|null | Возвращает фигуру, описывающую форму области, охватывающей оверлей в глобальных пиксельных координатах, либо null, если нет возможности рассчитать фигуру.

Унаследован от [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#getShape). ||
|| [isEmpty](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#isEmpty)() | Boolean | Возвращает true, если макет пуст, т.е. не имеет содержимого. Данный признак используется для сокрытия пустых объектов, таких как хинт, балун и другие.

Унаследован от [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#isEmpty). ||
|| [setData](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#setData)([data](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#setData-param-data)) | | Задает данные оверлея.

Унаследован от [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#setData). ||
|| [setGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#setGeometry)([geometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#setGeometry-param-geometry)) | | Задает пиксельную геометрию оверлея.

Унаследован от [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#setGeometry). ||
|| [setMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#setMap)([map](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#setMap-param-map)) | | Задает карту, на которой должен отобразиться оверлей.

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

<!-- XLIFF_FARM_Njk4ZGMw_CACHING -->

[*star]: Обязательный параметр.