UTFGrid~UTFGrid

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

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

new UTFGrid(options) source/UTFGrid.js, строка 273

Имя	Тип	Описание
`preemptive`	boolean (по умолчанию true)	Если `true`, источник UTFGrid загружает тайлы на основе их «видимости». Это повышает скорость отклика, но увеличивает трафик. Обратите внимание: если задано значение `false` (ленивая загрузка), необходимо передать `true` как `request` в метод `forDataAtCoordinateAndResolution`, иначе данные никогда не будут загружены.
`jsonp`	boolean (по умолчанию false)	Использовать JSONP с callback для загрузки 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() унаследовано Observable.js, строка 68

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

clear() унаследовано source/Tile.js, строка 258

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

dispatchEvent(event){boolean | undefined} унаследовано events/Target.js, строка 85

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

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

Возвращает:

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

forDataAtCoordinateAndResolution(coordinate, resolution, callback, request) source/UTFGrid.js, строка 388

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

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

get(key){*} унаследовано Object.js, строка 136

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

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

Возвращает:

Значение.

getAttributions(){Attribution} унаследовано source/Source.js, строка 129

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

Возвращает:

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

getAttributionsCollapsible(){boolean} унаследовано source/Source.js, строка 137

Возвращает:

Можно ли сворачивать атрибуции.

getKeys(){Array.<string>} унаследовано Object.js, строка 149

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

Возвращает:

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

getProjection(){Projection | null} унаследовано source/Source.js, строка 146

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

Возвращает:

Проекция.

getProperties(){NoInfer.<Properties>} унаследовано Object.js, строка 158

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

Возвращает:

Объект.

getRevision(){number} унаследовано Observable.js, строка 79

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

Возвращает:

Версия.

getState(){State} унаследовано source/Source.js, строка 201

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

Возвращает:

Состояние.

getTemplate(){string | undefined} source/UTFGrid.js, строка 373

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

Возвращает:

Шаблон из TileJSON.

getTileGrid(){TileGrid | null} унаследовано source/Tile.js, строка 190

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

Возвращает:

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

on(type, listener){EventsKey | Array<EventsKey>} унаследовано Observable.js, строка 152

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

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

Возвращает:

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

once(type, listener){EventsKey | Array<EventsKey>} унаследовано Observable.js, строка 164

Ожидает событие определённого типа один раз.

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

Возвращает:

refresh() унаследовано source/Source.js, строка 223

Обновляет источник. Источник будет очищен, а данные с сервера загружены повторно.

set(key, value, silent) унаследовано Object.js, строка 218

Задаёт значение.

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

setAttributions(attributions) унаследовано source/Source.js, строка 234

Задаёт атрибуции источника.

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

setProperties(values, silent) унаследовано Object.js, строка 238

Задаёт набор пар «ключ-значение». Обратите внимание: при этом изменяются существующие свойства и добавляются новые (существующие свойства не удаляются).

Имя	Тип	Описание
`values`	Partial.<NoInfer.<Properties>>	Значения.
`silent`	boolean \| undefined	Обновить без вызова события.

un(type, listener) унаследовано Observable.js, строка 173

Прекращает ожидание события определённого типа.

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

unset(key, silent) унаследовано Object.js, строка 262

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

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