---
metadata:
  - name: generator
    content: Diplodoc Platform v5.37.1
alternate:
  - https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v1-1/doc/ru/llms.txt

# YMaps.IOverlay

Интерфейс объекта-оверлея.

**См.:** [Объекты-оверлеи на карте](https://yandex.ru/dev/jsapi-v1-1/doc/ru/dg/tasks/map-overlays.md)
## Конструктор

Имя | Описание
----- | -----
[YMaps.IOverlay](ioverlay.md#constructor)() | Интерфейс объекта-оверлея.

## Методы

Имя | Описание
----- | -----
[onAddToMap](ioverlay.md#onAddToMap)(map, parentContainer) | Вызывается при добавлении объекта-оверлея на карту.
[onMapUpdate](ioverlay.md#onMapUpdate)() | Вызывается при обновлении карты.
[onRemoveFromMap](ioverlay.md#onRemoveFromMap)() | Вызывается при удаление оверлея с карты.


## Подробное описание конструктора {#constructor}

```javascript
YMaps.IOverlay()
```

Интерфейс объекта-оверлея.

**См.:** [Объекты-оверлеи на карте](https://yandex.ru/dev/jsapi-v1-1/doc/ru/dg/tasks/map-overlays.md)
## Подробное описание методов {#method_detail}

### onAddToMap {#onAddToMap}

```javascript
onAddToMap(map, parentContainer)
```

Вызывается при добавлении объекта-оверлея на карту. Вызывается объектом карты и не предназначен для прямого вызова.

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

Имя | Тип | Описание
----- | ----- | -----
`map` | [YMaps.Map](map.md) | Указатель на карту.
`parentContainer` | HTMLElement | Указатель на родительский HTML-элемент

### onMapUpdate {#onMapUpdate}

```javascript
onMapUpdate()
```

Вызывается при обновлении карты. Вызывается объектом карты и не предназначен для прямого вызова.
### onRemoveFromMap {#onRemoveFromMap}

```javascript
onRemoveFromMap()
```

Вызывается при удаление оверлея с карты. Вызывается объектом карты и не предназначен для прямого вызова.