StadiaMaps~StadiaMaps

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

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

new StadiaMaps(options) source/StadiaMaps.js, строка 147

Имя	Тип	Описание
`cacheSize`	number \| undefined	Устарело. Вместо этого используйте параметр cacheSize слоя.
`interpolate`	boolean (по умолчанию true)	Использовать интерполированные значения при передискретизации. По умолчанию при передискретизации используется линейная интерполяция. Установите значение false, чтобы использовать метод ближайшего соседа.
`layer`	string	Имя слоя. Допустимые значения: `alidade_smooth`, `alidade_smooth_dark`, `outdoors`, `stamen_terrain`, `stamen_terrain_background`, `stamen_terrain_labels`, `stamen_terrain_lines`, `stamen_toner_background`, `stamen_toner`, `stamen_toner_labels`, `stamen_toner_lines`, `stamen_toner_lite`, `stamen_watercolor` и `osm_bright`.
`minZoom`	number \| undefined	Минимальный масштаб.
`maxZoom`	number \| undefined	Максимальный масштаб.
`reprojectionErrorThreshold`	number (по умолчанию 0.5)	Максимально допустимая ошибка перепроецирования (в пикселях). Более высокие значения могут повысить производительность перепроецирования, но снизить точность.
`tileLoadFunction`	LoadFunction \| undefined	Необязательная функция для загрузки тайла по URL. По умолчанию используется function(imageTile, src) { imageTile.getImage().src = src; };
`transition`	number (по умолчанию 250)	Длительность перехода прозрачности при отображении. Чтобы отключить переход прозрачности, передайте `transition: 0`.
`url`	string \| undefined	Шаблон URL. Должен содержать заполнители `{x}`, `{y}` или `{-y}`, а также `{z}`.
`wrapX`	boolean (по умолчанию true)	Следует ли повторять мир по горизонтали.
`zDirection`	number \| NearestDirectionFunction (по умолчанию 0)	Выберите, использовать ли тайлы с более высоким или более низким уровнем масштаба при промежуточных значениях масштаба. См. `getZForResolution`.
`apiKey`	string \| undefined	Ключ API Stadia Maps. Не требуется для localhost и большинства общедоступных веб-развертываний. Подробности см. на странице https://docs.stadiamaps.com/authentication/.
`retina`	boolean \| undefined	Использовать тайлы для экранов Retina (если доступны; для Stamen Watercolor недоступны).

События:

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

Наследует

Методы

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	Удалить без отправки события.