BaseTile~BaseTileLayer

import BaseTileLayer from 'ol/layer/BaseTile.js';

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

new BaseTileLayer(options) layer/BaseTile.js, строка 65

Имя	Тип	Описание
`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, или `Infinity`, если использовался метод `setMap()` слоя.
`minResolution`	number \| undefined	Минимальное разрешение (включительно), при котором этот слой будет видим.
`maxResolution`	number \| undefined	Максимальное разрешение (не включительно), ниже которого этот слой будет видим.
`minZoom`	number \| undefined	Минимальный уровень масштабирования вида (не включительно), выше которого этот слой будет видим.
`maxZoom`	number \| undefined	Максимальный уровень масштабирования вида (включительно), при котором этот слой будет видим.
`preload`	number (по умолчанию 0)	Предварительная загрузка. Загружать тайлы с низким разрешением на глубину до `preload` уровней. Значение `0` означает отключение предварительной загрузки.
`source`	TileSource \| undefined	Источник для этого слоя.
`map`	Map \| undefined	Добавляет слой на карту как наложение. Карта не будет управлять этим слоем в своей коллекции слоёв, и слой будет отрисовываться поверх остальных. Это удобно для временных слоёв. Стандартный способ добавить слой на карту и передать его под управление карты — использовать `map.addLayer()`.
`background`	BackgroundColor \| undefined	Цвет фона слоя. Если не задан, фон отрисовываться не будет.
`useInterimTilesOnError`	boolean (по умолчанию true)	Устарело. Используйте промежуточные тайлы при ошибке.
`properties`	Object.<string, *> \| undefined	Произвольные наблюдаемые свойства. Доступ к ним можно получить с помощью `#get()` и `#set()`.
`cacheSize`	number (по умолчанию 512)	Размер внутреннего кэша тайлов. Он должен быть достаточно большим для отрисовки тайлов двух уровней масштабирования.

События:

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)

Подклассы

Наследует

Layer

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

Имя	Тип	Можно задать	Тип события 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.

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	Удалить без вызова события.