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

# YMaps.ILayer

Интерфейс слоя карты.

**См.:** [Создание пользовательского слоя карты](https://yandex.ru/dev/jsapi-v1-1/doc/ru/dg/tasks/how-to-create-user-layer.md)
## Конструктор

Имя | Описание
----- | -----
[YMaps.ILayer](ilayer.md#constructor)() | Интерфейс слоя карты.

## Методы

Имя | Возвращает | Описание
----- | ----- | -----
[getCopyright](ilayer.md#getCopyright)(bounds, zoom) | String | Возвращает копирайт для заданной видимой области слоя при заданном коэффициенте масштабирования.
[getZoomRange](ilayer.md#getZoomRange)(bounds) | Object | Возвращает минимальный и максимальный коэффициенты масштабирования для заданной видимой области слоя карты, либо null, если в заданной области слой не виден.
[onAddToMap](ilayer.md#onAddToMap)(map, parentContainer) |  | Вызывается при добавлении слоя на карту.
[onMapUpdate](ilayer.md#onMapUpdate)() |  | Обновление слоя, вызываемое при обновлении карты.
[onMove](ilayer.md#onMove)(position, offset) |  | Обработка смещения карты. Метод автоматически вызывается при каждом сдвиге карты.
[onRemoveFromMap](ilayer.md#onRemoveFromMap)() |  | Вызывается при удалении слоя с карты.
[onSmoothZoomEnd](ilayer.md#onSmoothZoomEnd)() |  | Вызывается в конце плавного масштабирования.
[onSmoothZoomStart](ilayer.md#onSmoothZoomStart)() |  | Вызывается в начале плавного масштабирования.
[onSmoothZoomTick](ilayer.md#onSmoothZoomTick)(params) |  | Вызывается при выполнении шага плавного масштабирования.


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

```javascript
YMaps.ILayer()
```

Интерфейс слоя карты.

**См.:** [Создание пользовательского слоя карты](https://yandex.ru/dev/jsapi-v1-1/doc/ru/dg/tasks/how-to-create-user-layer.md)

## Подробное описание методов {#method_detail}

### getCopyright {#getCopyright}

```javascript
{String} getCopyright(bounds, zoom)
```

Возвращает копирайт для заданной видимой области слоя при заданном коэффициенте масштабирования.

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

Имя | Тип | Описание
----- | ----- | -----
`bounds` | [YMaps.ICoordBounds](icoordbounds.md) | Видимая область слоя.
`zoom` | Integer | Коэффициент масштабирования.


**Возвращает:**

Тип | Описание
----- | -----
String | Текст копирайта.

### getZoomRange {#getZoomRange}

```javascript
{Object} getZoomRange(bounds)
```

Возвращает минимальный и максимальный коэффициенты масштабирования для заданной видимой области слоя карты, либо null, если в заданной области слой не виден. Уровни масштабирования возвращаются в виде объекта с полями min и max.

**Пример:**

```javascript
layer.getZoomRange(map.getBounds()) -> {min: 1, max: 15}
```

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

Имя | Тип | Описание
----- | ----- | -----
`bounds` | [YMaps.ICoordBounds](icoordbounds.md) | Видимая область слоя.


**Возвращает:**

Тип | Описание
----- | -----
Object | Объект с полями min и max, указывающими минимальный и максимальный коэффициенты масштабирования для видимой области слоя.

### onAddToMap {#onAddToMap}

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

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

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

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

### onMapUpdate {#onMapUpdate}

```javascript
onMapUpdate()
```

Обновление слоя, вызываемое при обновлении карты.
### onMove {#onMove}

```javascript
onMove(position, offset)
```

Обработка смещения карты. Метод автоматически вызывается при каждом сдвиге карты.

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

Имя | Тип | Описание
----- | ----- | -----
`position` | [YMaps.Point](point.md) | Новая позиция (в пикселах).
`offset` | [YMaps.Point](point.md) | Смещение относительно предыдущей позиции (в пикселах).

### onRemoveFromMap {#onRemoveFromMap}

```javascript
onRemoveFromMap()
```

Вызывается при удалении слоя с карты.
### onSmoothZoomEnd {#onSmoothZoomEnd}

```javascript
onSmoothZoomEnd()
```

Вызывается в конце плавного масштабирования.
### onSmoothZoomStart {#onSmoothZoomStart}

```javascript
onSmoothZoomStart()
```

Вызывается в начале плавного масштабирования.
### onSmoothZoomTick {#onSmoothZoomTick}

```javascript
onSmoothZoomTick(params)
```

Вызывается при выполнении шага плавного масштабирования.

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

Имя | Тип | Описание
----- | ----- | -----
`params` | Object | Параметры шага.
`params.saveThisPosition` | [YMaps.ICoordPoint](icoordpoint.md) | Точка координатной системы, относительно которой производится масштабирование.
`params.scaleCoefficient` | Number | Коэффициент изменения размера относительно начального.