--- metadata: - name: generator content: Diplodoc Platform v5.37.1 alternate: - https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/tiledatasource.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v1-1/doc/ru/llms.txt # YMaps.TileDataSource Класс для создания источника данных для тайлов определенного типа. {% note info %} Если требуется особое поведение какого-либо метода класса, то этот метод следует переопределить. {% endnote %} Для задания URL тайла используется шаблон, в котором можно использовать следующие специальные конструкции: - `%d` - заменяется на число от 1 до 4, в зависимости от номера тайла. Используется для распределения нагрузки между несколькими доменами. - `%c` - заменяется на `x=<номер тайла по горизонтали>&y=<номер тайла по вертикали>&z=<коэффициент масштабирования>`. - `%g` - приписывает к URL строковый параметр переменной длины; эту конструкцию следует использовать в том случае, если URL'ы соседних тайлов имеют одинаковую длину и могут получаться друг из друга перестановкой одного символа; несовершенство кэширующего механизма Firefox в таком случае может приводить к ошибкам, когда один тайл может быть показан вместо другого или вообще отсутствовать. ## Конструктор Имя | Описание ----- | ----- [YMaps.TileDataSource](tiledatasource.md#constructor)(tileUrlTemplate, isTransparent, smoothZoomEnabled) | Создает источник данных для тайлов определенного типа. ## Поля Имя | Статическое | Описание ----- | ----- | ----- [ERROR_TILE_URL](tiledatasource.md#.ERROR_TILE_URL) | ![](../_images/check.png) | URL изображения-заглушки для непрозрачных тайлов. Используется в качестве errorTileUrl. [TRANSPARENT_TILE_URL](tiledatasource.md#.TRANSPARENT_TILE_URL) | ![](../_images/check.png) | URL полностью прозрачного тайла. Используется в качестве errorTileUrl. В отличие от непрозрачных тайлов, где при ошибке показывается изображение-заглушка, для прозрачных тайлов, в случае ошибки, показывается полностью прозрачное изображение. ## Методы #| || **Имя** | **Возвращает** | **Описание** || ||[getErrorTileUrl](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/tiledatasource.md#getErrorTileUrl)() | String | Возвращает URL картинки для несуществующих или незагрузившихся тайлов.|| ||[getTile](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/tiledatasource.md#getTile)() | [YMaps.ITile](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/itile.md) | Создает и возвращает экземпляр тайла.|| ||[getTileSize](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/tiledatasource.md#getTileSize)() | Integer | Возвращает размер стороны тайла. По умолчанию возвращает 256. {% note alert %} Размер стороны тайла должен быть степенью 2. {% endnote %}|| ||[getTileUrl](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/tiledatasource.md#getTileUrl)(tile, zoom) | String | Возвращает URL изображения тайла по заданному номеру тайла и коэффициенту масштабирования.|| ||[getTileUrlTemplate](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/tiledatasource.md#getTileUrlTemplate)() | String | Возвращает текущий шаблон URL тайла.|| ||[isTransparent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/tiledatasource.md#isTransparent)() | Boolean | Возвращает состояние прозрачности тайлов: true - загружаемые изображения тайлов прозрачны, false - нет (по умолчанию).|| ||[setTileUrlTemplate](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/tiledatasource.md#setTileUrlTemplate)(template) | | Устанавливает новый шаблон URL тайла.|| ||[smoothZoomEnabled](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/tiledatasource.md#smoothZoomEnabled)() | Boolean | Возвращает состояние возможности плавного масштабирования для тайлов: true - тайлы поддерживают плавное масштабирование (по умолчанию), false - нет.|| |# ## Подробное описание конструктора {#constructor} ```javascript YMaps.TileDataSource(tileUrlTemplate, isTransparent, smoothZoomEnabled) ``` Создает источник данных для тайлов определенного типа. **Параметры:** Имя | Тип | Необязательный | По умолчанию | Описание ----- | ----- | ----- | ----- | ----- `tileUrlTemplate` | String | | | Шаблон, по которому строится URL тайла. `isTransparent` | Boolean | ![](../_images/check.png) | false | true - загружаемые тайлы прозрачны, false - непрозрачны. `smoothZoomEnabled` | Boolean | ![](../_images/check.png) | true | true - загружаемые тайлы поддерживают плавное масштабирование, false - нет. ## Подробное описание полей {#field_detail} ### ERROR_TILE_URL {#ERROR_TILE_URL} ```javascript ERROR_TILE_URL ``` URL изображения-заглушки для непрозрачных тайлов. Используется в качестве errorTileUrl. Если для какого-либо участка местности отсутствует непрозрачный тайл, по умолчанию показывается изображение-заглушка "Для данного участка местности нет данных". ### TRANSPARENT_TILE_URL {#TRANSPARENT_TILE_URL} ```javascript TRANSPARENT_TILE_URL ``` URL полностью прозрачного тайла. Используется в качестве errorTileUrl. В отличие от непрозрачных тайлов, где при ошибке показывается изображение-заглушка, для прозрачных тайлов, в случае ошибки, показывается полностью прозрачное изображение. ## Подробное описание методов {#method_detail} ### getErrorTileUrl {#getErrorTileUrl} ```javascript {String} getErrorTileUrl() ``` Возвращает URL картинки для несуществующих или незагрузившихся тайлов. **Возвращает:** Тип | Описание ----- | ----- String | URL картинки для несуществующих или незагрузившихся тайлов. ### getTile {#getTile} ```javascript {YMaps.ITile} getTile() ``` Создает и возвращает экземпляр тайла. **Возвращает:** Тип | Описание ----- | ----- [YMaps.ITile](itile.md) | Экземпляр тайла. ### getTileSize {#getTileSize} ```javascript {Integer} getTileSize() ``` Возвращает размер стороны тайла. По умолчанию возвращает 256. {% note alert %} Размер стороны тайла должен быть степенью 2. {% endnote %} **Возвращает:** Тип | Описание ----- | ----- Integer | Размер стороны тайла. ### getTileUrl {#getTileUrl} ```javascript {String} getTileUrl(tile, zoom) ``` Возвращает URL изображения тайла по заданному номеру тайла и коэффициенту масштабирования. URL тайла формируется, используя шаблон, установленный в конструкторе или через метод setTileUrlTemplate. **Параметры:** Имя | Тип | Описание ----- | ----- | ----- `tile` | [YMaps.Point](point.md) | Номер тайла. `zoom` | String | Текущий коэффициент масштабирования. **Возвращает:** Тип | Описание ----- | ----- String | URL изображения тайла. ### getTileUrlTemplate {#getTileUrlTemplate} ```javascript {String} getTileUrlTemplate() ``` Возвращает текущий шаблон URL тайла. **Возвращает:** Тип | Описание ----- | ----- String | Шаблон URL тайла. ### isTransparent {#isTransparent} ```javascript {Boolean} isTransparent() ``` Возвращает состояние прозрачности тайлов: true - загружаемые изображения тайлов прозрачны, false - нет (по умолчанию). **Возвращает:** Тип | Описание ----- | ----- Boolean | true - загружаемые изображения тайлов прозрачны, false - нет (по умолчанию). ### setTileUrlTemplate {#setTileUrlTemplate} ```javascript setTileUrlTemplate(template) ``` Устанавливает новый шаблон URL тайла. **Параметры:** Имя | Тип | Описание ----- | ----- | ----- `template` | String | Шаблон URL тайла. ### smoothZoomEnabled {#smoothZoomEnabled} ```javascript {Boolean} smoothZoomEnabled() ``` Возвращает состояние возможности плавного масштабирования для тайлов: true - тайлы поддерживают плавное масштабирование (по умолчанию), false - нет. Если тайлы не умеют растягиваться (false), то соответствующий слой будет скрыт на время плавного масштабирования. **Возвращает:** Тип | Описание ----- | ----- Boolean | true - тайлы поддерживают плавное масштабирование (по умолчанию), false - нет.