Spec-Zone.ru › OpenLayers

ol/source/ImageTile~ImageTileSource


import ImageTileSource from 'ol/source/ImageTile.js';

Источник тайлов с данными в типизированных массивах.

new ImageTileSource(options)

source/ImageTile.js, строка 150
Имя Тип Описание
url UrlLike | undefined

Шаблон URL изображения. Вместо одного шаблона URL можно указать массив шаблонов URL или функцию. Если указана функция, она будет вызвана с координатами тайла z, x, y и параметрами загрузчика и должна вернуть URL.

loader Loader | undefined

Загрузчик данных. Вызывается с координатами тайла z, x и y. Возвращает image для тайла или промис, возвращающий это значение. Промис не должен завершаться, пока изображение не будет загружено. Если указан параметр url, будет создан загрузчик.

attributions AttributionLike | undefined

Атрибуция.

attributionsCollapsible boolean (defaults to true)

Атрибуцию можно свернуть.

maxZoom number (defaults to 42)

Необязательный максимальный уровень масштабирования. Не используется, если указан tileGrid.

minZoom number (defaults to 0)

Необязательный минимальный уровень масштабирования. Не используется, если указан tileGrid.

tileSize number | Size (defaults to [256, 256])

Ширина и высота исходных тайлов в пикселях. Они могут отличаться от размера тайла в пикселях при отображении, если указан tileGrid.

gutter number (defaults to 0)

Размер в пикселях поля вокруг тайлов данных, которое следует игнорировать. Это позволяет игнорировать артефакты, возникающие при отрисовке краёв тайлов. Поддерживаемые данные должны быть шире и выше размера тайла на величину 2 x gutter.

maxResolution number | undefined

Необязательное разрешение сетки тайлов на нулевом уровне. Не используется, если указан tileGrid.

projection ProjectionLike (defaults to 'EPSG:3857')

Проекция тайлов.

tileGrid TileGrid | undefined

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

state State | undefined

Состояние источника.

wrapX boolean (defaults to true)

Отображать тайлы за антимеридианом.

transition number | undefined

Длительность перехода при плавном появлении новых тайлов (в миллисекундах).

interpolate boolean (defaults to true)

Использовать интерполированные значения при передискретизации.

crossOrigin CrossOriginAttribute (defaults to 'anonymous')

Свойство crossOrigin, передаваемое загрузчикам данных изображений.

referrerPolicy ReferrerPolicy | undefined

Свойство referrerPolicy для загружаемых изображений.

zDirection number | NearestDirectionFunction (defaults to 0)

Указывает, использовать ли тайлы с более высоким или более низким уровнем масштабирования при промежуточных целочисленных уровнях масштабирования. См. getZForResolution.

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

Подклассы

  • TileDebug

Наследует

  • DataTileSource

Методы

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

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

Возвращает:
Сетка тайлов.

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

Обновить без отправки события.

setTileGridForProjection(projection, tilegrid) унаследовано

source/DataTile.js, строка 484

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

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

Имя Тип Описание
projection ProjectionLike

Проекция.

tilegrid TileGrid

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

setUrl(url)

source/ImageTile.js, строка 205
Имя Тип Описание
url UrlLike

Новый URL.

un(type, listener) унаследовано

Observable.js, строка 173

Отменяет подписку на событие заданного типа.

Имя Тип Описание
type string | Array.<string>

Тип события или массив типов событий.

listener function

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

unset(key, silent) унаследовано

Object.js, строка 262

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

Имя Тип Описание
key string

Имя ключа.

silent boolean | 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API