Tile~TileLayer

import TileLayer from 'ol/layer/Tile.js';

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

new TileLayer(options) layer/Tile.js, строка 19

Имя	Тип	Описание
`className`	string (по умолчанию 'ol-layer')	Имя класса CSS, которое нужно установить для элемента слоя.
`opacity`	number (по умолчанию 1)	Непрозрачность (от 0 до 1).
`visible`	boolean (по умолчанию true)	Видимость.
`extent`	Extent \| undefined	Граница области, в которой будет отображаться слой. Слой не будет отображаться за пределами этой области.
`zIndex`	number \| undefined	Индекс Z для отображения слоя. Во время отображения слои будут упорядочены сначала по индексу Z, а затем по положению. При `undefined`, для слоёв, которые добавляются в коллекцию `layers` карты, предполагается значение индекса Z равное 0, или значение, полученное при использовании метода `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)

Расширяет

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() inherited Observable.js, line 68

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

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

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

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

Возвращает:

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

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

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

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

Возвращает:

Значение.

getAttributions(view){Array.<string>} inherited layer/Layer.js, line 345

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

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

Возвращает:

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

getData(pixel){Uint8ClampedArray | Uint8Array | Float32Array | DataView | null} inherited layer/BaseTile.js, line 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} inherited layer/Base.js, line 207

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

Возвращает:

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

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

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

Возвращает:

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

getMaxResolution(){number} inherited layer/Base.js, line 220

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

Возвращает:

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

getMaxZoom(){number} inherited layer/Base.js, line 253

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

Возвращает:

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

getMinResolution(){number} inherited layer/Base.js, line 231

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

Возвращает:

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

getMinZoom(){number} inherited layer/Base.js, line 242

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

Возвращает:

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

getOpacity(){number} inherited layer/Base.js, line 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`	строка \| Массив.<строка>	Тип события или массив типов событий.
`listener`	функция	Функция-обработчик.

Возвращает:

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

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

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

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

Возвращает:

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

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

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

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

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

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

setMap(map) inherited layer/Layer.js, line 440

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

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

Имя	Тип	Описание
`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`	логическое	Видимость слоя.

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

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

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

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

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

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

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

Сбросить свойство.

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