StadiaMaps~StadiaMaps

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

Источник слоя для веб-сервера черепиц Stadia Maps.

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

Имя	Тип	Описание
`cacheSize`	число \| undefined	Устарело. Используйте параметр cacheSize для слоя вместо него.
`interpolate`	логическое (по умолчанию true)	Использовать интерполированные значения при пересэмплировании. По умолчанию используется линейная интерполяция при пересэмплировании. Установите в false, чтобы использовать ближайшего соседа вместо неё.
`layer`	строка	Имя слоя. Допустимые значения: `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`	число \| undefined	Минимальный масштаб.
`maxZoom`	число \| undefined	Максимальный масштаб.
`reprojectionErrorThreshold`	число (по умолчанию 0.5)	Максимальная разрешённая ошибка репроекции (в пикселях). Более высокие значения могут увеличить производительность репроекции, но уменьшить точность.
`tileLoadFunction`	LoadFunction \| undefined	Необязательная функция для загрузки черепицы по заданному URL. По умолчанию function(imageTile, src) { imageTile.getImage().src = src; };
`transition`	число (по умолчанию 250)	Продолжительность перехода непрозрачности для рендеринга. Для отключения перехода непрозрачности передайте `transition: 0`.
`url`	строка \| undefined	Шаблон URL. Должен включать заполнитель `{x}`, `{y}` или `{-y}`, и `{z}`.
`wrapX`	логическое (по умолчанию true)	Оборачивать мир по горизонтали.
`zDirection`	число \| NearestDirectionFunction (по умолчанию 0)	Выберите, использовать ли черепицы с более высоким или более низким уровнем детализации при переходе между целочисленными уровнями масштабирования. См. `getZForResolution`.
`apiKey`	строка \| undefined	Ключ API Stadia Maps. Не требуется для localhost или большинства публичных веб-развёртываний. Подробнее см. https://docs.stadiamaps.com/authentication/.
`retina`	логическое \| undefined	Использовать черепицы с высоким разрешением (если доступны; недоступны для Stamen Watercolor).

События:

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

Возвращает:

URL-адреса.

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, строка 152

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

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

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

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

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, строка 164

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

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

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

set(key, value, silent) inherited Object.js, строка 215

Установка значения.

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

setAttributions(attributions) inherited source/Source.js, строка 203

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

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

setProperties(values, silent) inherited Object.js, строка 235

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

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

setRenderReprojectionEdges(render) inherited source/TileImage.js, строка 280

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

Имя	Тип	Описание
`render`	boolean	Отрисовка краёв.

setTileGridForProjection(projection, tilegrid) inherited source/TileImage.js, строка 300

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

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

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

setTileLoadFunction(tileLoadFunction) inherited source/UrlTile.js, строка 161

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

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

setTileUrlFunction(tileUrlFunction, key) inherited source/UrlTile.js, строка 173

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

Имя	Тип	Описание
`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	Удалить без срабатывания события.