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, строка 73

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

Вызывает:

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

Подклассы

Расширяет

TileImage

Методы

changed() inherited Observable.js, line 68

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

clear() inherited source/Tile.js, line 257

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

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(){Attribution} inherited source/Source.js, line 129

Получить функцию атрибуции для источника.

Возвращаемое значение:

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

getAttributionsCollapsible(){boolean} inherited source/Source.js, line 137

Возвращаемое значение:

Атрибуты сворачиваются.

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

Получить список имён свойств объекта.

Возвращаемое значение:

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

getProjection(){Projection | null} inherited source/Source.js, line 146

Получить проекцию источника.

Возвращаемое значение:

Проекция.

getProperties(){Object.<string, *>} inherited Object.js, line 157

Получить объект всех имён свойств и значений.

Возвращаемое значение:

Объект.

getRevision(){number} inherited Observable.js, line 79

Получить номер версии для этого объекта. Каждый раз при изменении объекта его номер версии будет инкрементирован.

Возвращаемое значение:

Номер ревизии.

getState(){State} inherited source/Source.js, line 170

Получить состояние источника, см. State для возможных состояний.

Возвращаемое значение:

Состояние.

getTileGrid(){TileGrid | null} inherited source/Tile.js, line 189

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

Возвращаемое значение:

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

getTileLoadFunction(){LoadFunction} inherited source/UrlTile.js, line 100

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

Возвращаемое значение:

TileLoadFunction

getTileUrlFunction(){UrlFunction} inherited source/UrlTile.js, line 110

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

Возвращаемое значение:

TileUrlFunction

getUrls(){!Array.<string> | null} inherited source/UrlTile.js, line 124

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

Возвращаемое значение:

URL-адреса.

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

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

Name	Type	Description
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция прослушивания.

Returns:

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

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

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

Name	Type	Description
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция прослушивания.

Returns:

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

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

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

setAttributions(attributions) inherited source/Source.js, line 203

Устанавливает атрибуты источника.

Name	Type	Description
`attributions`	AttributionLike \| undefined	Атрибуты. Могут быть переданы как `string`, `Array<string>`, `Attribution`, или `undefined`.

setProperties(values, silent) inherited Object.js, line 235

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

Name	Type	Description
`values`	Object.<string, *>	Значения.
`silent`	boolean \| undefined	Обновить без вызова события.

setRenderReprojectionEdges(render) inherited source/TileImage.js, line 280

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

Name	Type	Description
`render`	boolean	Отображать границы.

setTileGridForProjection(projection, tilegrid) inherited source/TileImage.js, line 300

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

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

Name	Type	Description
`projection`	ProjectionLike	Проекция.
`tilegrid`	TileGrid	Сетка тайлов для использования для проекции.

setTileLoadFunction(tileLoadFunction) inherited source/UrlTile.js, line 161

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

Name	Type	Description
`tileLoadFunction`	LoadFunction	Функция загрузки тайлов.

setTileUrlFunction(tileUrlFunction, key) inherited source/UrlTile.js, line 173

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

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

setUrl(url) inherited source/UrlTile.js, line 187

Установить URL для запросов.

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

setUrls(urls) inherited source/UrlTile.js, line 199

Устарело. Используйте вместо этого источник ImageTile. Установить URL для запросов.

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

un(type, listener) inherited Observable.js, line 173

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

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

unset(key, silent) inherited Object.js, line 259

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

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