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

# YMaps.Hotspots.ObjectSource

Расширяет [YMaps.Hotspots.IObjectSource](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.iobjectsource.md).

Стандартная реализация интерфейса [YMaps.Hotspots.IObjectSource](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.iobjectsource.md). Работает со стандартным форматом ответа сервера.

## Конструктор

Имя | Описание
----- | -----
[YMaps.Hotspots.ObjectSource](hotspots.objectsource.md#constructor)(tileUrlTemplate, keyTemplate, options) | Возвращает источник данных для слоя активных областей.


## Поля

Имя | Описание
----- | -----
[isRestricted](hotspots.objectsource.md#isRestricted) | Проверяет, выходит ли тайл за пределы области, для которой есть данные.

## Методы

Имя | Возвращает | Описание
----- | ----- | -----
[clearCache](hotspots.objectsource.md#clearCache)() |  | Очищает программный кэш.
[createObject](hotspots.objectsource.md#createObject)(layer, shapes, data, options) |  | Стандартная фабричная функция создания объекта-активной области.
[getKey](hotspots.objectsource.md#getKey)(tileNumber, zoom) | String | Возвращает идентификатор тайла.
[getKeyTemplate](hotspots.objectsource.md#getKeyTemplate)() | String | Возвращает шаблон идентификатора тайла.
[getOptions](hotspots.objectsource.md#getOptions)() | Object | Возвращает опции источника данных.
[getTileUrl](hotspots.objectsource.md#getTileUrl)(tileNumber, zoom) | String | Возвращает URL данных для конкретного тайла.
[getTileUrlTemplate](hotspots.objectsource.md#getTileUrlTemplate)() | String | Возвращает шаблон URL данных для тайла.
[parseResponse](hotspots.objectsource.md#parseResponse)(layer, res) | [YMaps.Hotspots.Object](hotspots.object.md)[] | Разбирает ответ сервера. Возвращает массив объектов-активных областей, сформированных по json-описанию.
[setKeyTemplate](hotspots.objectsource.md#setKeyTemplate)(template) |  | Задает новый шаблон идентификатора тайла.
[setTileUrlTemplate](hotspots.objectsource.md#setTileUrlTemplate)(template) |  | Задает новый шаблон URL данных для тайла

## Наследуемые методы

Из [YMaps.Hotspots.IObjectSource](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.iobjectsource.md): 
: [requestObjects](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.iobjectsource.md#requestObjects)

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

```javascript
YMaps.Hotspots.ObjectSource(tileUrlTemplate, keyTemplate, options)
```

Возвращает источник данных для слоя активных областей.

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

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`tileUrlTemplate` | String |  |  | Шаблон URL данных, соответствующих тайлу. Поддерживаются те же специальные конструкции, что и [YMaps.TileDataSource](tiledatasource.md).
`keyTemplate` | String |  |  | Шаблон идентификатора тайла.
`options` | Object | ![](../_images/check.png) |  | Опции источника данных.
`options.useBrowserCache` | Boolean | ![](../_images/check.png) | true | true - использовать встроенный кэш браузера, false - не использовать (к каждому URL будет автоматически приписываться случайный GET-параметр, чтобы исключить кэширование тайлов браузером).
`options.useProgramCache` | Boolean | ![](../_images/check.png) | false | true - использовать программный кэш (запоминать в памяти результаты последних обращений к серверу), false - не использовать.
`options.programCacheEntries` | Integer | ![](../_images/check.png) | 100 | Размер программного кэша (число кэшируемых тайлов) при включенной опции useProgramCache.
`options.bounds` | [YMaps.ICoordBounds](icoordbounds.md) | ![](../_images/check.png) | null | Область на карте, для которой есть данные или null, если данные есть везде.
`options.minZoom` | Integer | ![](../_images/check.png) | 0 | Минимальный коээфициент масштабирования карты, для которого есть данные.
`options.maxZoom` | Integer | ![](../_images/check.png) | 23 | Максимальный коэффициент масштабирования карты, для которого есть данные.

## Подробное описание полей {#field_detail}

### isRestricted {#isRestricted}

```javascript
Boolean isRestricted
```

Проверяет, выходит ли тайл за пределы области, для которой есть данные.
## Подробное описание методов {#method_detail}

### clearCache {#clearCache}

```javascript
clearCache()
```

Очищает программный кэш.
### createObject {#createObject}

```javascript
createObject(layer, shapes, data, options)
```

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

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

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`layer` | [YMaps.Hotspots.Layer](hotspots.layer.md) |  |  | Слой, которому принадлежит объект.
`shapes` | [YMaps.Hotspots.IShape](hotspots.ishape.md)[] |  |  | Массив геометрических фигур, принадлежащих объекту.
`data` | Object |  |  | Данные, ассоциированные с объектом.
`options` | Object | ![](../_images/check.png) |  | Опции объекта.
`options.priority` | Number | ![](../_images/check.png) | 0 | Приоритет объекта.
`options.style` | [YMaps.Style](style.md)\|String | ![](../_images/check.png) |  | Стиль объекта, заданный объектом YMaps.Style или ключом стиля. К объектам YMaps.Hotspots.Object применяется параметры стиля содержимого балуна и стиля содержимого всплывающей подсказки, остальные поля игнорируются.

### getKey {#getKey}

```javascript
{String} getKey(tileNumber, zoom)
```

Возвращает идентификатор тайла.

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

Имя | Тип | Описание
----- | ----- | -----
`tileNumber` | [YMaps.Point](point.md) | Номер тайла (тайловые координаты).
`zoom` | Integer | Уровень масштаба.


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

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

### getKeyTemplate {#getKeyTemplate}

```javascript
{String} getKeyTemplate()
```

Возвращает шаблон идентификатора тайла.

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

Тип | Описание
----- | -----
String | Шаблон идентификатора.

### getOptions {#getOptions}

```javascript
{Object} getOptions()
```

Возвращает опции источника данных.

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

Тип | Описание
----- | -----
Object | options Опции.

### getTileUrl {#getTileUrl}

```javascript
{String} getTileUrl(tileNumber, zoom)
```

Возвращает URL данных для конкретного тайла.

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

Имя | Тип | Описание
----- | ----- | -----
`tileNumber` | [YMaps.Point](point.md) | Номер тайла (тайловые координаты).
`zoom` | Integer | Уровень масштаба.


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

Тип | Описание
----- | -----
String | URL.

### getTileUrlTemplate {#getTileUrlTemplate}

```javascript
{String} getTileUrlTemplate()
```

Возвращает шаблон URL данных для тайла.

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

Тип | Описание
----- | -----
String | Шаблон URL

### parseResponse {#parseResponse}

```javascript
{YMaps.Hotspots.Object[]} parseResponse(layer, res)
```

Разбирает ответ сервера. Возвращает массив объектов-активных областей, сформированных по json-описанию.

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

Имя | Тип | Описание
----- | ----- | -----
`layer` | [YMaps.Hotspots.Layer](hotspots.layer.md) | Слой, которому принадлежат объекты.
`res` | Object | Ответ сервера.


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

Тип | Описание
----- | -----
[YMaps.Hotspots.Object](hotspots.object.md)[] | Массив объектов.

### setKeyTemplate {#setKeyTemplate}

```javascript
setKeyTemplate(template)
```

Задает новый шаблон идентификатора тайла.

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

Имя | Тип | Описание
----- | ----- | -----
`template` | String | Шаблон идентификатора.

### setTileUrlTemplate {#setTileUrlTemplate}

```javascript
setTileUrlTemplate(template)
```

Задает новый шаблон URL данных для тайла

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

Имя | Тип | Описание
----- | ----- | -----
`template` | String | Шаблон URL