WebGLTile~WebGLTileLayer

import WebGLTileLayer from 'ol/layer/WebGLTile.js';

Для источников слоёв, которые предоставляют предварительно отрисованные, разложенные по тайлам изображения в сетках, организованных по уровням масштабирования для определённых разрешений. Обратите внимание, что любое свойство, заданное в опциях, устанавливается как свойство BaseObject объекта слоя; например, установка title: 'My Title' в опциях означает, что title является наблюдаемым и имеет доступ к аксессорам get/set.

новый WebGLTileLayer(options) layer/WebGLTile.js, строка 285

Имя	Тип	Описание
`style`	Стиль \| undefined	Стиль, применяемый к слою.
`className`	строка (по умолчанию 'ol-layer')	Имя класса CSS, которое нужно установить для элемента слоя.
`opacity`	число (по умолчанию 1)	Непрозрачность (0, 1).
`visible`	логическое (по умолчанию true)	Видимость.
`extent`	Область \| undefined	Границы области для отрисовки слоя. Слой не будет отрисовываться за пределами этой области.
`zIndex`	число \| undefined	Индекс Z для отрисовки слоя. Во время отрисовки слои упорядочиваются, сначала по индексу Z, а затем по положению. Когда `undefined`, для слоев, добавленных в коллекцию `layers` карты, предполагается значение `zIndex` 0, или `Infinity`, если использовался метод `setMap()` слоя.
`minResolution`	число \| undefined	Минимальное разрешение (включительно), при котором этот слой будет виден.
`maxResolution`	число \| undefined	Максимальное разрешение (исключительно) ниже которого этот слой будет виден.
`minZoom`	число \| undefined	Минимальный уровень масштабирования представления (исключительно), выше которого этот слой будет виден.
`maxZoom`	число \| undefined	Максимальный уровень масштабирования представления (включительно), при котором этот слой будет виден.
`preload`	число (по умолчанию 0)	Предварительная загрузка. Загрузить плитки низкого разрешения до уровня `preload`. `0` означает отсутствие предварительной загрузки.
`source`	ТипИсточника \| undefined	Источник для этого слоя.
`sources`	Массив.<ТипИсточника> \| функция \| undefined	Массив источников для этого слоя. Имеет приоритет над `source`. Может быть массивом источников или функцией, которая принимает область и разрешение (в единицах проекции представления на пиксель) и возвращает массив источников. См. `sourcesFromTileGrid` для вспомогательной функции создания источников, организованных в пирамиде, следуя тому же шаблону, что и сетка плиток. Примечание: Все источники должны иметь одинаковое количество и содержание полос.
`map`	Карта \| undefined	Устанавливает слой как наложение на карту. Карта не будет управлять этим слоем в своей коллекции слоев, и слой будет нарисован сверху. Это полезно для временных слоев. Стандартный способ добавления слоя на карту и управления им картой — использование `addLayer`.
`useInterimTilesOnError`	логическое (по умолчанию true)	Устарело. Использовать промежуточные плитки при ошибке.
`cacheSize`	число (по умолчанию 512)	Размер внутреннего кэша текстур. Он должен быть достаточно большим, чтобы отобразить две сопоставляемые по масштабу плитки.
`properties`	Объект.<строка, *> \| undefined	Произвольные наблюдаемые свойства. К ним можно получить доступ с помощью `#get()` и `#set()`.

События:

change (ОсновноеСобытие) - Общее событие изменения. Срабатывает, когда увеличивается счетчик ревизии.
change:extent (ОбъектноеСобытие)
change:maxResolution (ОбъектноеСобытие)
change:maxZoom (ОбъектноеСобытие)
change:minResolution (ОбъектноеСобытие)
change:minZoom (ОбъектноеСобытие)
change:opacity (ОбъектноеСобытие)
change:preload (ОбъектноеСобытие)
change:source (ОбъектноеСобытие)
change:useInterimTilesOnError (ОбъектноеСобытие)
change:visible (ОбъектноеСобытие)
change:zIndex (ОбъектноеСобытие)
error (ОсновноеСобытие) - Общее событие об ошибке. Срабатывает при возникновении ошибки.
postrender (СобытиеОтрисовки) - Срабатывает после отрисовки слоя.
prerender (СобытиеОтрисовки) - Срабатывает перед отрисовкой слоя.
propertychange (ОбъектноеСобытие) - Срабатывает при изменении свойства.
sourceready (ОсновноеСобытие)

Расширяет

BaseTileLayer

Наблюдаемые свойства

Имя	Тип	Изменяемое	ОбъектноеСобытие тип	Описание
`extent`	Область \| undefined	да	`change:extent`	Область слоя.
`maxResolution`	число	да	`change:maxresolution`	Максимальное разрешение слоя.
`maxZoom`	число	да	`change:maxzoom`	Максимальный уровень масштабирования слоя.
`minResolution`	число	да	`change:minresolution`	Минимальное разрешение слоя.
`minZoom`	число	да	`change:minzoom`	Минимальный уровень масштабирования слоя.
`opacity`	число	да	`change:opacity`	Непрозрачность слоя.
`preload`	число	да	`change:preload`	Уровень предварительной загрузки плиток.
`source`	ТипИсточника \| null	да	`change:source`	Источник слоя (или `null`, если он ещё не задан).
`useInterimTilesOnError`	логическое	да	`change:useinterimtilesonerror`	Использовать промежуточные плитки при ошибке.
`visible`	логическое	да	`change:visible`	Значение свойства `visible` слоя.
`zIndex`	число \| undefined	да	`change:zindex`	Индекс Z слоя.

Методы

changed() inherited Observable.js, строка 68

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

dispatchEvent(event){boolean | undefined} inherited events/Target.js, строка 85

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

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

Возвращает:

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

dispose() layer/WebGLTile.js, строка 517

Очистка ресурсов WebGL.

get(key){*} inherited Object.js, строка 135

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

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

Возвращает:

Значение.

getAttributions(view){Array.<string>} inherited layer/Layer.js, строка 345

Получение атрибутов источника этого слоя для данного представления.

Имя	Тип	Описание
`view`	Представление \| ViewStateLayerStateExtent \| undefined	Представление или `FrameState`. Требуется только в том случае, если слой не добавлен в карту.

Возвращает:

Атрибуты этого слоя в данном представлении.

getData(pixel){Uint8ClampedArray | Uint8Array | Float32Array | DataView | null} inherited layer/BaseTile.js, строка 177

Получение данных для пиксельного расположения. Тип возвращаемых данных зависит от данных источника. Для изображений тайлов возвращается массив RGBA из четырёх элементов. Для данных тайлов длина массива соответствует количеству полос в наборе данных. Для запросов за пределами области слоя возвращается null. Данные для изображений тайлов могут быть получены только в том случае, если свойство crossOrigin источника установлено.

// display layer data on every pointer move
map.on('pointermove', (event) => {
  console.log(layer.getData(event.pixel));
});

Имя	Тип	Описание
`pixel`	Пиксель	Пиксель.

Возвращает:

Данные пикселя.

getExtent(){Область | undefined} inherited layer/Base.js, строка 207

Возвращает extent слоя или undefined, если он будет виден независимо от области.

Возвращает:

Область слоя.

getKeys(){Array.<string>} inherited Object.js, строка 148

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

Возвращает:

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

getMaxResolution(){number} inherited layer/Base.js, строка 220

Возвращает максимальное разрешение слоя. Возвращает Infinity, если для слоя не задано максимальное разрешение.

Возвращает:

Максимальное разрешение слоя.

getMaxZoom(){number} inherited layer/Base.js, строка 253

Возвращает максимальный уровень масштабирования слоя. Возвращает Infinity, если для слоя не задано максимальное значение масштаба.

Возвращает:

Максимальный уровень масштабирования слоя.

getMinResolution(){number} inherited layer/Base.js, строка 231

Возвращает минимальное разрешение слоя. Возвращает 0, если для слоя не задано минимальное разрешение.

Возвращает:

Минимальное разрешение слоя.

getMinZoom(){number} inherited layer/Base.js, строка 242

Возвращает минимальный уровень масштабирования слоя. Возвращает -Infinity, если для слоя не задано минимальное значение масштаба.

Возвращает:

Минимальный уровень масштабирования слоя.

getOpacity(){number} inherited layer/Base.js, строка 263

Возвращает непрозрачность слоя (между 0 и 1).

Возвращает:

Непрозрачность слоя.

getPreload(){number} inherited layer/BaseTile.js, line 124

Возвращает уровень, до которого будут предварительно загружаться тайлы.

Возвращает:

Уровень для предварительной загрузки тайлов.

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

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

Возвращает:

Объект.

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

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

Возвращает:

Версия.

getSource(){SourceType | null} inherited layer/Layer.js, line 209

Получить источник слоя.

Возвращает:

Источник слоя (или null, если он еще не задан).

getUseInterimTilesOnError(){boolean} inherited layer/BaseTile.js, line 144

Устарело. Используются ли временные тайлы при ошибке.

Возвращает:

Использование временных тайлов при ошибке.

getVisible(){boolean} inherited layer/Base.js, line 282

Возвращает значение свойства visible этого слоя. Чтобы узнать, виден ли слой на карте, используйте isVisible() вместо этого.

Возвращает:

Значение свойства visible слоя.

getZIndex(){number | undefined} inherited layer/Base.js, line 293

Возвращает индекс Z слоя, который используется для упорядочения слоев перед отрисовкой. Возвращает undefined, если слой не управляется.

Возвращает:

Индекс Z слоя.

isVisible(view){boolean} inherited layer/Layer.js, line 301

Слой виден на представлении карты, т.е. в пределах его минимального/максимального разрешения или масштаба и области, не установлен в visible: false и не находится внутри группы слоев, установленной в visible: false.

Имя	Тип	Описание
view	Представление \| ViewStateLayerStateExtent \| undefined	Представление или `FrameState`. Требуется только в том случае, если слой не добавлен на карту.

Возвращает:

Слой виден на представлении карты.

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 152

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

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

Возвращает:

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

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 164

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

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

Возвращает:

set(key, value, silent) inherited Object.js, line 215

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

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

setExtent(extent) inherited layer/Base.js, line 313

Установите область видимости слоя. Если undefined, слой будет виден во всех областях.

Имя	Тип	Описание
`extent`	Extent \| undefined	Область видимости слоя.

setMap(map) унаследованное layer/Layer.js, строка 440

Устанавливает слой, который будет отображаться поверх других слоев на карте. Карта не будет управлять этим слоем в своей коллекции слоев. Это полезно для временных слоев. Чтобы удалить неуправляемый слой с карты, используйте #setMap(null).

Чтобы добавить слой на карту и управлять им с помощью карты, используйте addLayer вместо этого.

Имя	Тип	Описание
`map`	Map \| null	Карта.

setMaxResolution(maxResolution) унаследованное layer/Base.js, строка 323

Установите максимальное разрешение, при котором слой виден.

Имя	Тип	Описание
`maxResolution`	число	Максимальное разрешение слоя.

setMaxZoom(maxZoom) унаследованное layer/Base.js, строка 345

Установите максимальный масштаб (исключая), при котором слой виден. Обратите внимание, что уровни масштаба для видимости слоя основаны на уровне масштаба просмотра, который может отличаться от уровня масштаба источника плитки.

Имя	Тип	Описание
`maxZoom`	число	Максимальный масштаб слоя.

setMinResolution(minResolution) унаследованное layer/Base.js, строка 333

Установите минимальное разрешение, при котором слой виден.

Имя	Тип	Описание
`minResolution`	число	Минимальное разрешение слоя.

setMinZoom(minZoom) унаследованное layer/Base.js, строка 357

Установите минимальный масштаб (включительно), при котором слой виден. Обратите внимание, что уровни масштаба для видимости слоя основаны на уровне масштаба просмотра, который может отличаться от уровня масштаба источника плитки.

Имя	Тип	Описание
`minZoom`	число	Минимальный масштаб слоя.

setOpacity(opacity) унаследованное layer/Base.js, строка 367

Установите непрозрачность слоя, допустимые значения находятся в диапазоне от 0 до 1.

Имя	Тип	Описание
`opacity`	число	Непрозрачность слоя.

setPreload(preload) унаследованное layer/BaseTile.js, строка 134

Установите уровень, до которого будут кэшироваться плитки.

Имя	Тип	Описание
`preload`	число	Уровень кэширования плиток.

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

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

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

setSource(source) унаследованное layer/Layer.js, строка 488

Установите источник слоя.

Имя	Тип	Описание
`source`	SourceType \| null	Источник слоя.

setUseInterimTilesOnError(useInterimTilesOnError) унаследованное layer/BaseTile.js, строка 156

Устарело. Установите, использовать ли временные плитки при ошибке.

Имя	Тип	Описание
`useInterimTilesOnError`	логическое	Использовать временные плитки при ошибке.

setVisible(visible) унаследованное layer/Base.js, строка 378

Установите видимость слоя (true или false).

Имя	Тип	Описание
`visible`	boolean	Видимость слоя.

setZIndex(zindex) inherited layer/Base.js, строка 389

Установите индекс Z слоя, который используется для упорядочения слоёв перед отрисовкой. Значение по умолчанию — 0.

Имя	Тип	Описание
`zindex`	number	Индекс Z слоя.

un(type, listener) inherited Observable.js, строка 173

Отключить прослушивание определённого типа события.

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

unset(key, silent) inherited Object.js, строка 259

Удалить свойство.

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

updateStyleVariables(variables) layer/WebGLTile.js, строка 506

Обновить переменные, используемые стилем слоя, и вызвать повторную отрисовку.

Имя	Тип	Описание
`variables`	Object.<string, number>	Переменные для обновления.