ol/source/ImageTile~ImageTileSource
import ImageTileSource from 'ol/source/ImageTile.js';
Источник тайлов с данными в типизированных массивах.
-
new ImageTileSource(options)
-
Имя Тип Описание urlUrlLike | undefined Шаблон URL изображения. Вместо одного шаблона URL можно указать массив шаблонов URL или функцию. Если указана функция, она будет вызвана с координатами тайла z, x, y и параметрами загрузчика и должна вернуть URL.
loaderLoader | undefined Загрузчик данных. Вызывается с координатами тайла z, x и y. Возвращает
imageдля тайла или промис, возвращающий это значение. Промис не должен завершаться, пока изображение не будет загружено. Если указан параметрurl, будет создан загрузчик.attributionsAttributionLike | undefined Атрибуция.
attributionsCollapsibleboolean (defaults to true) Атрибуцию можно свернуть.
maxZoomnumber (defaults to 42) Необязательный максимальный уровень масштабирования. Не используется, если указан
tileGrid.minZoomnumber (defaults to 0) Необязательный минимальный уровень масштабирования. Не используется, если указан
tileGrid.tileSizenumber | Size (defaults to [256, 256]) Ширина и высота исходных тайлов в пикселях. Они могут отличаться от размера тайла в пикселях при отображении, если указан
tileGrid.gutternumber (defaults to 0) Размер в пикселях поля вокруг тайлов данных, которое следует игнорировать. Это позволяет игнорировать артефакты, возникающие при отрисовке краёв тайлов. Поддерживаемые данные должны быть шире и выше размера тайла на величину
2 x gutter.maxResolutionnumber | undefined Необязательное разрешение сетки тайлов на нулевом уровне. Не используется, если указан
tileGrid.projectionProjectionLike (defaults to 'EPSG:3857') Проекция тайлов.
tileGridTileGrid | undefined Сетка тайлов.
stateState | undefined Состояние источника.
wrapXboolean (defaults to true) Отображать тайлы за антимеридианом.
transitionnumber | undefined Длительность перехода при плавном появлении новых тайлов (в миллисекундах).
interpolateboolean (defaults to true) Использовать интерполированные значения при передискретизации.
crossOriginCrossOriginAttribute (defaults to 'anonymous') Свойство crossOrigin, передаваемое загрузчикам данных изображений.
referrerPolicyReferrerPolicy | undefined Свойство
referrerPolicyдля загружаемых изображений.zDirectionnumber | NearestDirectionFunction (defaults to 0) Указывает, использовать ли тайлы с более высоким или более низким уровнем масштабирования при промежуточных целочисленных уровнях масштабирования. См.
getZForResolution.Генерируемые события:
-
change(BaseEvent) — Общее событие изменения. Генерируется при увеличении счётчика ревизий. -
error(BaseEvent) — Общее событие ошибки. Генерируется при возникновении ошибки. -
propertychange(ObjectEvent) — Генерируется при изменении свойства. -
tileloadend(TileSourceEvent) — Генерируется после завершения загрузки тайла: когда его данные загружены или когда загрузка отменена, поскольку тайл больше не нужен. -
tileloaderror(TileSourceEvent) — Генерируется, если при загрузке тайла произошла ошибка. Обратите внимание, что это событие не предназначено для повторной загрузки тайлов. Подробнее см. в разделеload. -
tileloadstart(TileSourceEvent) — Генерируется при начале загрузки тайла.
-
Подклассы
Наследует
Методы
-
changed() унаследовано
-
Увеличивает счётчик ревизий и отправляет событие 'change'.
-
clear() унаследовано
-
Удаляет из источника все кэшированные перепроецированные тайлы. При следующем цикле отрисовки будут созданы новые тайлы.
-
dispatchEvent(event){boolean | undefined} унаследовано
-
Отправляет событие и вызывает все обработчики, подписанные на события этого типа. Параметр event может быть строкой или объектом со свойством
type.Имя Тип Описание eventBaseEvent | string Объект события.
Возвращает:
false, если кто-либо вызвал preventDefault для объекта события или если какой-либо из обработчиков вернул false.
-
get(key){*} унаследовано
-
Получает значение.
Имя Тип Описание keystring Имя ключа.
Возвращает:
Значение.
-
getAttributions(){Attribution} унаследовано
-
Возвращает функцию атрибуции источника.
Возвращает:
Функция атрибуции.
-
getAttributionsCollapsible(){boolean} унаследовано
-
Возвращает:
Можно ли свернуть атрибуцию.
-
getKeys(){Array.<string>} унаследовано
-
Возвращает список имён свойств объекта.
Возвращает:
Список имён свойств.
-
getProjection(){Projection | null} унаследовано
-
Возвращает проекцию источника.
Возвращает:
Проекция.
-
getProperties(){NoInfer.<Properties>} унаследовано
-
Возвращает объект со всеми именами свойств и их значениями.
Возвращает:
Объект.
-
getRevision(){number} унаследовано
-
Возвращает номер версии этого объекта. При каждом изменении объекта номер его версии увеличивается.
Возвращает:
Номер ревизии.
-
getState(){State} унаследовано
-
Возвращает состояние источника. Возможные состояния см. в разделе
State.Возвращает:
Состояние.
-
getTileGrid(){TileGrid | null} унаследовано
-
Возвращает сетку тайлов источника тайлов.
Возвращает:
Сетка тайлов.
-
on(type, listener){EventsKey | Array<EventsKey>} унаследовано
-
Подписывается на события заданного типа.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-обработчик.
Возвращает:
Уникальный ключ обработчика. Если первым аргументом передан массив типов событий, будет возвращён массив ключей.
-
once(type, listener){EventsKey | Array<EventsKey>} унаследовано
-
Однократно подписывается на событие заданного типа.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-обработчик.
Возвращает:
Уникальный ключ обработчика. Если первым аргументом передан массив типов событий, будет возвращён массив ключей.
-
refresh() унаследовано
-
Обновляет источник. Источник будет очищен, а данные повторно загружены с сервера.
-
set(key, value, silent) унаследовано
-
Задаёт значение.
Имя Тип Описание keystring Имя ключа.
value* Значение.
silentboolean | undefined Обновить без отправки события.
-
setAttributions(attributions) унаследовано
-
Задаёт атрибуцию источника.
Имя Тип Описание attributionsAttributionLike | undefined Атрибуция. Может быть передана как
string,Array<string>,Attributionилиundefined. -
setProperties(values, silent) унаследовано
-
Задаёт набор пар «ключ — значение». Обратите внимание: существующие свойства будут изменены, а новые — добавлены (существующие свойства не удаляются).
Имя Тип Описание valuesPartial.<NoInfer.<Properties>> Значения.
silentboolean | undefined Обновить без отправки события.
-
setTileGridForProjection(projection, tilegrid) унаследовано
-
Задаёт сетку тайлов, используемую при перепроецировании тайлов в указанную проекцию вместо сетки тайлов по умолчанию для этой проекции.
Это может быть полезно, если сетку тайлов по умолчанию нельзя создать (например, у проекции не задан экстент) или по соображениям оптимизации (пользовательский размер тайла, разрешения и т. д.).
Имя Тип Описание projectionProjectionLike Проекция.
tilegridTileGrid Сетка тайлов, используемая для проекции.
-
setUrl(url)
-
Имя Тип Описание urlUrlLike Новый URL.
-
un(type, listener) унаследовано
-
Отменяет подписку на событие заданного типа.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-обработчик.
-
unset(key, silent) унаследовано
-
Удаляет свойство.
Имя Тип Описание keystring Имя ключа.
silentboolean | undefined Удалить без отправки события.
© 2005-present, OpenLayers Contributors All rights reserved.Licensed under the BSD 2-Clause License.
https://openlayers.org/en/latest/apidoc/module-ol_source_ImageTile-ImageTileSource.html