BaseTile~СлойОсноваПлитка

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

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

новый BaseTileLayer(options) layer/BaseTile.js, строка 65

Имя	Тип	Описание
`className`	строка (по умолчанию 'ol-layer')	Имя класса CSS для элемента слоя.
`opacity`	число (по умолчанию 1)	Непрозрачность (от 0 до 1).
`visible`	логическое значение (по умолчанию true)	Видимость.
`extent`	Extent \| undefined	Границы отображения слоя. Слой не будет отображаться вне этих границ.
`zIndex`	число \| undefined	Индекс Z для отображения слоя. При отображении слои будут упорядочены сначала по индексу Z, а затем по положению. При `undefined`, предполагается индекс Z равный 0 для слоев, добавленных в коллекцию `layers` карты, или `Infinity` при использовании метода `setMap()` слоя.
`minResolution`	число \| undefined	Минимальное разрешение (включительно), при котором данный слой будет виден.
`maxResolution`	число \| undefined	Максимальное разрешение (исключительно), ниже которого данный слой будет виден.
`minZoom`	число \| undefined	Минимальный уровень масштабирования (исключительно) выше которого данный слой будет виден.
`maxZoom`	число \| undefined	Максимальный уровень масштабирования (включительно) при котором данный слой будет виден.
`preload`	число (по умолчанию 0)	Предварительная загрузка. Загрузить плитки с низким разрешением до уровней `preload`. `0` означает отсутствие предварительной загрузки.
`source`	TileSource \| undefined	Источник для данного слоя.
`map`	Map \| undefined	Устанавливает слой в качестве наложения на карту. Карта не будет управлять этим слоем в своей коллекции слоев, и слой будет отображаться поверх. Это полезно для временных слоев. Стандартный способ добавления слоя на карту и управления им картой - использование `map.addLayer()`.
`background`	BackgroundColor \| undefined	Цвет фона слоя. Если не указан, фон не будет отображаться.
`useInterimTilesOnError`	логическое значение (по умолчанию true)	Устаревшее. Использовать промежуточные плитки при ошибках.
`properties`	Объект.<строка, *> \| undefined	Произвольные наблюдаемые свойства. Доступны с помощью `#get()` и `#set()`.
`cacheSize`	число (по умолчанию 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`	число	да	`change:maxresolution`	Максимальное разрешение слоя.
`maxZoom`	число	да	`change:maxzoom`	Максимальный уровень масштабирования слоя.
`minResolution`	число	да	`change:minresolution`	Минимальное разрешение слоя.
`minZoom`	число	да	`change:minzoom`	Минимальный уровень масштабирования слоя.
`opacity`	число	да	`change:opacity`	Непрозрачность слоя.
`preload`	число	да	`change:preload`	Уровень предварительной загрузки плиток.
`source`	SourceType \| null	да	`change:source`	Источник слоя (или `null`, если ещё не задан).
`useInterimTilesOnError`	логическое значение	да	`change:useinterimtilesonerror`	Использовать промежуточные плитки при ошибках.
`visible`	логическое значение	да	`change:visible`	Значение свойства `visible` слоя.
`zIndex`	число \| undefined	да	`change:zindex`	Индекс Z слоя.

Методы

changed() inherited Observable.js, line 68

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

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

Отправляет событие и вызывает всех слушателей, слушающих события этого типа. Параметр события может быть либо строкой, либо объектом с свойством 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} 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} 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} 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	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) 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 слоя, который используется для упорядочивания слоёв перед рендерингом. Значение по умолчанию 0.

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

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

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

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

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

Сброс свойства.

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