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

# layer.tileContainer.CanvasContainer

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

Контейнер тайлов на canvas.

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

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

```javascript
layer.tileContainer.CanvasContainer(layer[, options])
```

Создаёт контейнер тайлов на canvas. Доступен по ключу "default#canvas" в хранилище классов тайловых контейнеров.

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

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

Слой. ||
|| [`options`](#param-options) | — | Тип: Object

Опции контейнера. ||
|| [`options.notFoundTile`](#param-options.notFoundTile) | null | Тип: String\|null

Опция, указывающая по какому url нужно загрузить картинку, если картинка для тайла не загрузилась. Если значение null, то будет показан стандартный тайл с текстовым сообщением. Для прозрачных тайлов опция notFoundTile не применяется, и вместо незагруженных тайлов ничего показываться не будет. ||
|| [`options.tileClass`](#param-options.tileClass) | 'default#canvas' | Тип: [ICanvasTile](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICanvasTile.md)

Класс тайлов, используемых контейнером. Должен реализовывать интерфейс [ICanvasTile](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICanvasTile.md). ||
|| [`options.tileTransparent`](#param-options.tileTransparent) | false | Тип: Boolean

Флаг, показывающий, являются ли тайлы контейнера прозрачными. ||
|#

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

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

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

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

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

#|
|| **Имя** | **Описание** ||
|| [parentchange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange) | Сменился родительский объект.

Поля данных:

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

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


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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [getMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/layer.tileContainer.CanvasContainer.md#getMap)() | [Map](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map.md) | Возвращает ссылку на карту. ||
|| [getParent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#getParent)() | [IParentOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md)|null | Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен.

Унаследован от [IChildOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#getParent). ||
|| [getTile](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/layer.tileContainer.CanvasContainer.md#getTile)([tileNumber](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/layer.tileContainer.CanvasContainer.md#getTile-param-tileNumber), [tileZoom](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/layer.tileContainer.CanvasContainer.md#getTile-param-tileZoom), [priority](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/layer.tileContainer.CanvasContainer.md#getTile-param-priority)) | [ICanvasTile](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICanvasTile.md) | Фабричная функция создания тайлов. ||
|| [setParent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#setParent)([parent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#setParent-param-parent)) | [IChildOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md) | Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта.

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

## Описание методов {#method_detail}

### getMap {#getMap}

```javascript
{Map} getMap()
```

**Возвращает** ссылку на карту.

### getTile {#getTile}

```javascript
{ICanvasTile} getTile(tileNumber, tileZoom, priority)
```

Фабричная функция создания тайлов.

**Возвращает** экземпляр тайла.

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`tileNumber`](#getTile-param-tileNumber)[*](*star) | — | Тип: Number[]

Номер тайла. ||
|| [`tileZoom`](#getTile-param-tileZoom)[*](*star) | — | Тип: Number

Масштаб тайла. ||
|| [`priority`](#getTile-param-priority)[*](*star) | — | Тип: Number

Приоритет загрузки. ||
|#

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


<!-- XLIFF_FARM_ZTY0ZWNh_CACHING -->

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