UTFGrid~UTFGrid

import UTFGrid from 'ol/source/UTFGrid.js';

Источник слоя для взаимодействия с данными UTFGrid, загружаемыми из формата TileJSON.

new UTFGrid(options) source/UTFGrid.js, line 273

Имя	Тип	Описание
`preemptive`	boolean (по умолчанию true)	Если `true` источник UTFGrid загружает тайлы на основе их "видимости". Это повышает скорость ответа, но увеличивает трафик. Обратите внимание, что если установлено значение `false` (отложенная загрузка), необходимо передать `true` в качестве `request` методу `forDataAtCoordinateAndResolution`, иначе данные никогда не будут загружены.
`jsonp`	boolean (по умолчанию false)	Использовать JSONP с обратным вызовом для загрузки TileJSON. Полезно, когда сервер не поддерживает CORS.
`tileJSON`	Config \| undefined	Настройка TileJSON для этого источника. Если не указано, необходимо настроить `url`.
`url`	string \| undefined	Конечная точка TileJSON, предоставляющая конфигурацию для этого источника. Запрос будет выполнен через JSONP. Если не указано, необходимо настроить `tileJSON`.
`wrapX`	boolean (по умолчанию true)	Оборачивать мир по горизонтали.
`zDirection`	number \| NearestDirectionFunction (по умолчанию 0)	Выберите, использовать ли тайлы с более высоким или более низким уровнем детализации при значении уровня детализации между целыми числами. См. `getZForResolution`.

События:

change (BaseEvent) — Общее событие изменения. Срабатывает, когда увеличивается счетчик ревизии.
error (BaseEvent) — Общее событие ошибки. Срабатывает при возникновении ошибки.
propertychange (ObjectEvent) — Срабатывает при изменении свойства.

Расширяет

TileSource

Методы

changed() inherited Observable.js, line 68

Увеличивает счётчик ревизии и отправляет событие 'change'.

clear() inherited source/Tile.js, line 257

Удаляет все кэшированные перепроецированные тайлы из источника. Следующий цикл рендеринга создаст новые тайлы.

dispatchEvent(event){boolean | undefined} inherited events/Target.js, line 85

Отправляет событие и вызывает всех слушателей, слушающих события этого типа. Параметр события может быть строкой или объектом со свойством type.

Имя	Тип	Описание
`event`	BaseEvent \| string	Объект события.

Возвращаемое значение:

false, если кто-то вызвал preventDefault в объекте события или если любой из слушателей вернул false.

forDataAtCoordinateAndResolution(coordinate, resolution, callback, request) source/UTFGrid.js, line 382

Вызывает коллбек (синхронно по умолчанию) со доступными данными для заданной координаты и разрешения (или null, если данные еще не загружены или произошла ошибка).

Имя	Тип	Описание
`coordinate`	Coordinate	Координата.
`resolution`	number	Разрешение.
`callback`	function	Коллбек.
`request`	boolean \| undefined	Если `true`, коллбек всегда асинхронный. Данные тайла запрашиваются, если они еще не загружены.

get(key){*} inherited Object.js, line 135

Получение значения.

Имя	Тип	Описание
`key`	string	Имя ключа.

Возвращаемое значение:

Значение.

getAttributions(){Attribution} inherited source/Source.js, line 129

Получение функции атрибуции для источника.

Возвращаемое значение:

Функция атрибуции.

getAttributionsCollapsible(){boolean} inherited source/Source.js, line 137

Возвращаемое значение:

Атрибуты сворачиваются.

getKeys(){Array.<string>} inherited Object.js, line 148

Получение списка имён свойств объекта.

Возвращаемое значение:

Список имён свойств.

getProjection(){Projection | null} inherited source/Source.js, line 146

Получение проекции источника.

Возвращаемое значение:

Проекция.

getProperties(){Object.<string, *>} inherited Object.js, line 157

Получение объекта всех имён свойств и их значений.

Возвращаемое значение:

Объект.

getRevision(){number} inherited Observable.js, line 79

Получение номера версии для данного объекта. Каждый раз, когда объект изменяется, его номер версии увеличивается.

Возвращаемое значение:

Номер ревизии.

getState(){State} inherited source/Source.js, line 170

Получение состояния источника, см. State для возможных состояний.

Возвращаемое значение:

Состояние.

getTemplate(){string | undefined} source/UTFGrid.js, line 367

Возвращает шаблон из TileJSON.

Возвращаемое значение:

Шаблон из TileJSON.

getTileGrid(){TileGrid | null} inherited source/Tile.js, line 189

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

Возвращаемое значение:

Сетка тайлов.

on(тип, слушатель){EventsKey | Array<EventsKey>} унаследованный Observable.js, строка 152

Прослушивание события определенного типа.

Имя	Тип	Описание
`type`	строка \| Массив.<строка>	Тип события или массив типов событий.
`listener`	функция	Функция-слушатель.

Возвращаемое значение:

Уникальный ключ для слушателя. Если вызвана с массивом типов событий в качестве первого аргумента, возвращаемое значение будет массивом ключей.

once(тип, слушатель){EventsKey | Array<EventsKey>} унаследованный Observable.js, строка 164

Прослушивание события определенного типа один раз.

Имя	Тип	Описание
`type`	строка \| Массив.<строка>	Тип события или массив типов событий.
`listener`	функция	Функция-слушатель.

Возвращаемое значение:

set(ключ, значение, беззвучно) унаследованный Object.js, строка 215

Устанавливает значение.

Имя	Тип	Описание
`key`	строка	Имя ключа.
`value`	*	Значение.
`silent`	логическое \| undefined	Обновить без срабатывания события.

setAttributions(атрибуты) унаследованный source/Source.js, строка 203

Устанавливает атрибуты источника.

Имя	Тип	Описание
`attributions`	AttributionLike \| undefined	Атрибуты. Можно передавать как `string`, `Array<string>`, `Attribution`, или `undefined`.

setProperties(значения, беззвучно) унаследованный Object.js, строка 235

Устанавливает коллекцию пар "ключ-значение". Обратите внимание, что это изменяет все существующие свойства и добавляет новые (это не удаляет существующие свойства).

Имя	Тип	Описание
`values`	Объект.<строка, *>	Значения.
`silent`	логическое \| undefined	Обновить без срабатывания события.

un(тип, слушатель) унаследованный Observable.js, строка 173

Отписаться от события определенного типа.

Имя	Тип	Описание
`type`	строка \| Массив.<строка>	Тип события или массив типов событий.
`listener`	функция	Функция-слушатель.

unset(ключ, беззвучно) унаследованный Object.js, строка 259

Удаляет свойство.

Имя	Тип	Описание
`key`	строка	Имя ключа.
`silent`	логическое \| undefined	Удалить без срабатывания события.