XYZ~XYZ

import XYZ from 'ol/source/XYZ.js';

Источник слоя для данных тайлов с URL-адресами в заданном формате XYZ, определяемыми шаблоном URL. По умолчанию используется широко распространённая сетка Google, в которой x 0 и y 0 находятся в верхнем левом углу. Сетки вроде TMS, в которых x 0 и y 0 находятся в нижнем левом углу, можно использовать с помощью заполнителя {-y} в шаблоне URL, если для источника не задана пользовательская сетка тайлов. В этом случае можно использовать tileUrlFunction, например:

 tileUrlFunction: function(coordinate) {
   return 'http://mapserver.com/' + coordinate[0] + '/' +
     coordinate[1] + '/' + (-coordinate[2] - 1) + '.png';
 }

new XYZ(options) source/XYZ.js, строка 74

Имя	Тип	Описание
`attributions`	AttributionLike \| undefined	Атрибуция.
`attributionsCollapsible`	boolean (defaults to true)	Атрибуцию можно сворачивать.
`cacheSize`	number \| undefined	Устарело. Вместо этого используйте параметр cacheSize слоя.
`crossOrigin`	null \| string \| undefined	Атрибут `crossOrigin` для загруженных изображений. Обратите внимание: чтобы получать доступ к данным пикселей с помощью средства визуализации Canvas, необходимо указать значение `crossOrigin`. Подробнее см. https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.
`referrerPolicy`	ReferrerPolicy \| undefined	Свойство `referrerPolicy` для загруженных изображений.
`interpolate`	boolean (defaults to true)	Использовать интерполированные значения при изменении разрешения. По умолчанию при изменении разрешения используется линейная интерполяция. Установите значение false, чтобы вместо неё использовать интерполяцию методом ближайшего соседа.
`projection`	ProjectionLike (defaults to 'EPSG:3857')	Проекция.
`reprojectionErrorThreshold`	number (defaults to 0.5)	Максимально допустимая ошибка перепроецирования (в пикселях). Более высокие значения могут повысить производительность перепроецирования, но снизить точность.
`maxZoom`	number (defaults to 42)	Необязательный максимальный уровень масштаба. Не используется, если задан `tileGrid`.
`minZoom`	number (defaults to 0)	Необязательный минимальный уровень масштаба. Не используется, если задан `tileGrid`.
`maxResolution`	number \| undefined	Необязательное разрешение сетки тайлов на нулевом уровне. Не используется, если задан `tileGrid`.
`tileGrid`	TileGrid \| undefined	Сетка тайлов.
`tileLoadFunction`	LoadFunction \| undefined	Устарело. Вместо этого используйте источник ImageTile с загрузчиком. Необязательная функция для загрузки тайла по URL. По умолчанию используется function(imageTile, src) { imageTile.getImage().src = src; };
`tilePixelRatio`	number (defaults to 1)	Коэффициент пикселей, используемый службой тайлов. Например, если служба тайлов указывает размер тайлов 256 × 256 пикселей, но фактически отправляет изображения размером 512 × 512 пикселей (для устройств Retina/HiDPI), то для `tilePixelRatio` следует задать значение `2`.
`tileSize`	number \| Size (defaults to [256, 256])	Размер тайлов, используемый службой тайлов. Не используется, если задан `tileGrid`.
`gutter`	number (defaults to 0)	Размер в пикселях поля вокруг изображений тайлов, которое следует игнорировать. Это позволяет игнорировать артефакты визуализации на границах тайлов. Поддерживаемые изображения должны быть шире и выше размера тайла на значение `2 x gutter`.
`tileUrlFunction`	UrlFunction \| undefined	Устарело. Вместо этого используйте источник ImageTile и передайте функцию в параметр url.
`url`	string \| undefined	Шаблон URL. Должен содержать заполнители `{x}`, `{y}` или `{-y}`, а также `{z}`. Вместо отдельного указания каждого URL в параметре `urls` можно использовать шаблон `{?-?}`, например `subdomain{a-f}.domain.com`.
`urls`	Array.<string> \| undefined	Устарело. Вместо этого используйте источник ImageTile и передайте массив URL в параметр url.
`wrapX`	boolean (defaults to true)	Определяет, следует ли замыкать мир по горизонтали.
`transition`	number (defaults to 250)	Длительность перехода прозрачности при визуализации. Чтобы отключить переход прозрачности, передайте `transition: 0`.
`zDirection`	number \| NearestDirectionFunction (defaults to 0)	Определяет, использовать ли тайлы с более высоким или более низким уровнем масштаба при промежуточных значениях между целыми уровнями масштаба. См. `getZForResolution`.

События:

change (BaseEvent) — Общее событие изменения. Вызывается при увеличении счётчика версий.
error (BaseEvent) — Общее событие ошибки. Вызывается при возникновении ошибки.
propertychange (ObjectEvent) — Вызывается при изменении свойства.
tileloadend (TileSourceEvent) — Вызывается после завершения загрузки тайла: когда данные тайла загружены или когда загрузка отменена, поскольку тайл больше не требуется.
tileloaderror (TileSourceEvent) — Вызывается, если при загрузке тайла возникает ошибка. Обратите внимание: это событие не следует использовать для повторной загрузки тайлов. Подробнее см. в разделе load.
tileloadstart (TileSourceEvent) — Вызывается при начале загрузки тайла.

Подклассы

Наследует

TileImage

Методы

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

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

clear() унаследовано source/Tile.js, строка 258

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

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

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

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

Возвращает:

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

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

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

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

Возвращает:

Значение.

getAttributions(){Attribution} унаследовано source/Source.js, строка 129

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

Возвращает:

Функция атрибуции.

getAttributionsCollapsible(){boolean} унаследовано source/Source.js, строка 137

Возвращает:

Атрибуции можно сворачивать.

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

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

Возвращает:

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

getProjection(){Projection | null} унаследовано source/Source.js, строка 146

Возвращает проекцию источника.

Возвращает:

Проекция.

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

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

Возвращает:

Объект.

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

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

Возвращает:

Ревизия.

getState(){State} унаследовано source/Source.js, строка 201

Возвращает состояние источника. Возможные состояния см. в разделе State.

Возвращает:

Состояние.

getTileGrid(){TileGrid | null} унаследовано source/Tile.js, строка 190

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

Возвращает:

Сетка тайлов.

getTileLoadFunction(){LoadFunction} унаследовано source/UrlTile.js, строка 100

Устарело. Вместо этого используйте источник ImageTile. Возвращает функцию загрузки тайлов источника.

Возвращает:

TileLoadFunction

getTileUrlFunction(){UrlFunction} унаследовано source/UrlTile.js, строка 110

Устарело. Вместо этого используйте источник ImageTile. Возвращает функцию URL тайла источника.

Возвращает:

TileUrlFunction

getUrls(){!Array.<string> | null} унаследовано source/UrlTile.js, строка 124

Устарело. Вместо этого используйте источник ImageTile. Возвращает URL-адреса, используемые для этого источника. Если вместо url или urls используется tileUrlFunction, будет возвращено значение null.

Возвращает:

URL-адреса.

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

Возвращает:

refresh() унаследовано source/Source.js, строка 223

Обновляет источник. Источник будет очищен, а данные повторно загружены с сервера.

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

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

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

setAttributions(attributions) унаследовано source/Source.js, строка 234

Задаёт атрибуции источника.

Имя	Тип	Описание
`attributions`	AttributionLike \| undefined	Атрибуции. Можно передать как `string`, `Array<string>`, `Attribution` или `undefined`.

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

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

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

setRenderReprojectionEdges(render) унаследовано source/TileImage.js, строка 301

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

Имя	Тип	Описание
`render`	boolean	Отображать границы.

setTileGridForProjection(projection, tilegrid) унаследовано source/TileImage.js, строка 321

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

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

Имя	Тип	Описание
`projection`	ProjectionLike	Проекция.
`tilegrid`	TileGrid	Сетка тайлов для проекции.

setTileLoadFunction(tileLoadFunction) унаследовано source/UrlTile.js, строка 161

Устарело. Вместо этого используйте источник ImageTile. Задаёт функцию загрузки тайлов источника.

Имя	Тип	Описание
`tileLoadFunction`	LoadFunction	Функция загрузки тайлов.

setTileUrlFunction(tileUrlFunction, key) унаследовано source/UrlTile.js, строка 173

Устарело. Вместо этого используйте источник ImageTile. Задаёт функцию URL тайла источника.

Имя	Тип	Описание
`tileUrlFunction`	UrlFunction	Функция URL тайла.
`key`	string \| undefined	Необязательный новый ключ тайла для источника.

setUrl(url) унаследовано source/UrlTile.js, строка 187

Задаёт URL, используемый для запросов.

Имя	Тип	Описание
`url`	string	URL.

setUrls(urls) унаследовано source/UrlTile.js, строка 199

Устарело. Вместо этого используйте источник ImageTile. Задаёт URL-адреса, используемые для запросов.

Имя	Тип	Описание
`urls`	Array.<string>	URL-адреса.

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

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

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

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

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

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