OSM~OSM

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

Источник слоя для сервера тайлов OpenStreetMap.

new OSM(options) source/OSM.js, строка 52

Имя	Тип	Описание
`attributions`	AttributionLike \| undefined	Подписи.
`cacheSize`	number \| undefined	Устарело. Используйте параметр cacheSize для слоя вместо этого.
`crossOrigin`	null \| string (по умолчанию 'anonymous')	Атрибут `crossOrigin` для загруженных изображений. Обратите внимание, что вы должны предоставить значение `crossOrigin`, если хотите получить доступ к данным пикселей с помощью рендерера Canvas. Подробнее см. https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.
`interpolate`	boolean (по умолчанию true)	Использовать интерполированные значения при пересэмплировании. По умолчанию используется линейная интерполяция при пересэмплировании. Установите значение false, чтобы использовать ближайшего соседа вместо этого.
`maxZoom`	number (по умолчанию 19)	Максимальный уровень масштабирования.
`reprojectionErrorThreshold`	number (по умолчанию 0.5)	Максимальная допустимая ошибка репроекции (в пикселях). Более высокие значения могут увеличить производительность репроекции, но уменьшат точность.
`tileLoadFunction`	LoadFunction \| undefined	Необязательная функция для загрузки тайла по заданному URL-адресу. По умолчанию function(imageTile, src) { imageTile.getImage().src = src; };
`transition`	number (по умолчанию 250)	Продолжительность перехода непрозрачности для рендеринга. Чтобы отключить переход непрозрачности, передайте `transition: 0`.
`url`	string (по умолчанию 'https://tile.openstreetmap.org/{z}/{x}/{y}.png')	Шаблон URL. Должен содержать `{x}`, `{y}` или `{-y}`, и `{z}` заполнитель.
`wrapX`	boolean (по умолчанию true)	Оборачивать мир по горизонтали.
`zDirection`	number \| NearestDirectionFunction (по умолчанию 0)	Выбор использования тайлов с более высоким или более низким уровнем масштабирования при значениях между целыми уровнями масштабирования. См. `getZForResolution`.

События:

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

Расширяет

Методы

changed() inherited Observable.js, line 68

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

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

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

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(){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-адреса, используемые для этого источника. Если используется tileUrlFunction вместо url или urls, возвращается null.

Возвращает:

URL-адреса.

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	Обновление без срабатывания события.

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

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

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

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

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

Имя	Тип	Описание
`values`	Object.<string, *>	Значения.
`silent`	boolean \| undefined	Обновление без срабатывания события.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Имя	Тип	Описание
`url`	строка	URL.

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

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

Имя	Тип	Описание
`urls`	Массив.<строка>	URL-адреса.

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

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

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

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

Удалить свойство.

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