WebGLTile~WebGLTileLayer

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

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

new WebGLTileLayer(options) layer/WebGLTile.js, строка 304

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

События:

change (BaseEvent) — общее событие изменения. Вызывается при увеличении счётчика ревизий.
change:extent (ObjectEvent)
change:maxResolution (ObjectEvent)
change:maxZoom (ObjectEvent)
change:minResolution (ObjectEvent)
change:minZoom (ObjectEvent)
change:opacity (ObjectEvent)
change:preload (ObjectEvent)
change:source (ObjectEvent)
change:useInterimTilesOnError (ObjectEvent)
change:visible (ObjectEvent)
change:zIndex (ObjectEvent)
error (BaseEvent) — общее событие ошибки. Вызывается при возникновении ошибки.
postrender (RenderEvent) — вызывается после отрисовки слоя.
prerender (RenderEvent) — вызывается перед отрисовкой слоя.
propertychange (ObjectEvent) — вызывается при изменении свойства.
sourceready (BaseEvent)

Наследует

BaseTileLayer

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

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

Методы

changed() унаследовано Observable.js, строка 68

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

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

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

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

Возвращает:

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

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

Освобождает используемые ресурсы WebGL.

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

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

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

Возвращает:

Значение.

getAttributions(view){Array.<string>} унаследовано layer/Layer.js, строка 349

Возвращает атрибуцию источника этого слоя для указанного представления.

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

Возвращает:

Атрибуция этого слоя для указанного представления.

getData(pixel){Uint8ClampedArray | Uint8Array | Float32Array | DataView | null} унаследовано 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`	Pixel	Пиксель.

Возвращает:

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

getExtent(){Extent | undefined} унаследовано layer/Base.js, строка 210

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

Возвращает:

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

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

Возвращает список имён свойств объекта.

Возвращает:

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

getMaxResolution(){number} унаследовано layer/Base.js, строка 223

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

Возвращает:

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

getMaxZoom(){number} унаследовано layer/Base.js, строка 256

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

Возвращает:

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

getMinResolution(){number} унаследовано layer/Base.js, строка 234

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

Возвращает:

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

getMinZoom(){number} унаследовано layer/Base.js, строка 245

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

Возвращает:

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

getOpacity(){number} унаследовано layer/Base.js, строка 266

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

Возвращает:

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

getPreload(){number} унаследовано layer/BaseTile.js, строка 124

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

Возвращает:

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

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

Возвращает объект со всеми именами и значениями свойств.

Возвращает:

Объект.

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

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

Возвращает:

Ревизия.

getSource(){SourceType | null} унаследовано layer/Layer.js, строка 214

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

Возвращает:

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

getUseInterimTilesOnError(){boolean} унаследовано layer/BaseTile.js, строка 144

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

Возвращает:

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

getVisible(){boolean} унаследовано layer/Base.js, строка 285

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

Возвращает:

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

getZIndex(){number | undefined} унаследовано layer/Base.js, строка 296

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

Возвращает:

Z-индекс слоя.

isVisible(view){boolean} унаследовано layer/Layer.js, строка 305

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

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

Возвращает:

Видимость слоя в представлении карты.

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	Функция-обработчик.

Возвращает:

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

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

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

setExtent(extent) унаследовано layer/Base.js, строка 316

Задаёт область, в пределах которой слой виден. Если undefined, слой будет виден во всех областях.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Имя	Тип	Описание
`preload`	number	Уровень, до которого предварительно загружаются тайлы.

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

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

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

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

Задаёт источник слоя.

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

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

Устарело. Задаёт, следует ли использовать промежуточные тайлы при ошибке.

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

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

Задаёт видимость слоя (true или false).

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

setZIndex(zindex) унаследовано layer/Base.js, строка 392

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

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

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

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

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

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

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

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

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

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

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