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

# ILayer

Extends [IChildOnMap](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChildOnMap.md), [ICustomizable](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md), [IEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventEmitter.md).

Interface for a map layer.

[Constructor](#constructor-summary) | [Fields](#properties-summary) | [Events](#events-summary) | [Methods](#methods-summary)

## Constructor {#constructor-summary}

```javascript
ILayer()
```

## Fields {#properties-summary}

#|
|| **Name** | **Type** | **Description** ||
|| [events](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventManager.md) | Event manager.

Inherited from [IEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventEmitter.md#events). ||
|| [options](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IOptionManager.md) | Options manager.

Inherited from [ICustomizable](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md#options). ||
|#

## Events {#events-summary}

#|
|| **Name** | **Description** ||
|| [brightnesschange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayer.md#event-brightnesschange) | Layer brightness change event. ||
|| [copyrightschange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayer.md#event-copyrightschange) | Event for changes to available copyright information. ||
|| [optionschange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md#event-optionschange) | Change to the object options.

Inherited from [ICustomizable](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md#event-optionschange). ||
|| [parentchange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChild.md#event-parentchange) | The parent object reference changed.

Data fields:

- oldParent - Old parent.
- newParent - New parent.

Inherited from [IChild](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChild.md#event-parentchange). ||
|| [tileloadchange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayer.md#event-tileloadchange) | Tile upload status change event. Data fields: 
- readyTileNumber - Number of ready tiles. A tile is considered ready when it is downloaded and rendered. Type: Number.
- totalTileNumber - Total number of visible tiles. Type: Number. ||
|| [zoomrangechange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayer.md#event-zoomrangechange) | Event for changes to available information about the zoom level range. ||
|#

## Methods {#methods-summary}

#|
|| **Name** | **Returns** | **Description** ||
|| [getBrightness](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayer.md#getBrightness)() | Number | Optional method. ||
|| [getCopyrights](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayer.md#getCopyrights)([coords](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayer.md#getCopyrights-param-coords), [zoom](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayer.md#getCopyrights-param-zoom)) | [vow.Promise](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md) | Optional method. Requests information about copyrights at the specified point with the specified zoom. ||
|| [getParent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChildOnMap.md#getParent)() | [IParentOnMap](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IParentOnMap.md)\|null | Returns link to the parent object, or null if the parent element was not set.

Inherited from [IChildOnMap](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChildOnMap.md#getParent). ||
|| [getZoomRange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayer.md#getZoomRange)([point](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayer.md#getZoomRange-param-point)) | [vow.Promise](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md) | Optional method. Checks the available range of zoom levels at the specified point. If there is data, the returned promise object will be resolved and will pass as a result an array of two numbers - the minimum and maximum zoom level available at the point. If there is no data, the promise is rejected with an error. ||
|| [setParent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChildOnMap.md#setParent)([parent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChildOnMap.md#setParent-param-parent)) | [IChildOnMap](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChildOnMap.md) | Sets the parent object. If the null value is passed, the manager element will only be deleted from the current parent object.

Inherited from [IChildOnMap](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChildOnMap.md#setParent). ||
|#

## Events details {#event_detail}

### brightnesschange {#brightnesschange}

Layer brightness change event.

### copyrightschange {#copyrightschange}

Event for changes to available copyright information.

### tileloadchange {#tileloadchange}

Tile upload status change event. Data fields: 
- readyTileNumber - Number of ready tiles. A tile is considered ready when it is downloaded and rendered. Type: Number.
- totalTileNumber - Total number of visible tiles. Type: Number.

### zoomrangechange {#zoomrangechange}

Event for changes to available information about the zoom level range.

## Methods details {#method_detail}

### getBrightness {#getBrightness}

```javascript
{Number} getBrightness()
```

Optional method.

**Returns** the layer brightness value from 0 to 1 (0 is zero brightness, and 1 is maximum brightness). The total brightness of the layers added to the map determines which color is selected for the logo and copyrights on the map.

### getCopyrights {#getCopyrights}

```javascript
{vow.Promise} getCopyrights(coords, zoom)
```

Optional method. Requests information about copyrights at the specified point with the specified zoom.

**Returns** Promise that will be resolved and will pass as a result an array of strings or DOM elements with information about copyrights.

**Parameters:**

#|
|| **Parameter** | **Default value** | **Description**  ||
|| [`coords`](#getCopyrights-param-coords)[*](*star) | — | Type: Number[]

The point on the map that copyright information is being requested for. ||
|| [`zoom`](#getCopyrights-param-zoom)[*](*star) | — | Type: Number

The zoom level that copyright information is being requested for. ||
|#

\* Mandatory parameter/option.

### getZoomRange {#getZoomRange}

```javascript
{vow.Promise} getZoomRange(point)
```

Optional method. Checks the available range of zoom levels at the specified point. If there is data, the returned promise object will be resolved and will pass as a result an array of two numbers - the minimum and maximum zoom level available at the point. If there is no data, the promise is rejected with an error.

**Returns** Promise object.

**Parameters:**

#|
|| **Parameter** | **Default value** | **Description**  ||
|| [`point`](#getZoomRange-param-point)[*](*star) | — | Type: Number[]

Point ||
|#

\* Mandatory parameter/option.

[*star]: Mandatory parameter/option.