YMaps.Hotspots.ObjectSource

Расширяет YMaps.Hotspots.IObjectSource.

Стандартная реализация интерфейса YMaps.Hotspots.IObjectSource. Работает со стандартным форматом ответа сервера.

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

ПоляПоля

МетодыМетоды

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

Из YMaps.Hotspots.IObjectSource:

requestObjects

Подробное описание конструктораПодробное описание конструктора

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

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

Параметры:

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

Подробное описание полейПодробное описание полей

isRestrictedisRestricted

Boolean isRestricted

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

Подробное описание методовПодробное описание методов

clearCacheclearCache

clearCache()

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

createObjectcreateObject

createObject(layer, shapes, data, options)

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

Параметры:

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

getKeygetKey

{String} getKey(tileNumber, zoom)

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

Параметры:

Возвращает:

getKeyTemplategetKeyTemplate

{String} getKeyTemplate()

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

Возвращает:

getOptionsgetOptions

{Object} getOptions()

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

Возвращает:

getTileUrlgetTileUrl

{String} getTileUrl(tileNumber, zoom)

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

Параметры:

Возвращает:

getTileUrlTemplategetTileUrlTemplate

{String} getTileUrlTemplate()

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

Возвращает:

parseResponseparseResponse

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

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

Параметры:

Возвращает:

setKeyTemplatesetKeyTemplate

setKeyTemplate(template)

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

Параметры:

setTileUrlTemplatesetTileUrlTemplate

setTileUrlTemplate(template)

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

Параметры: