Spec-Zone.ru › OpenLayers

ol/source/WMTS~WMTS 


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

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

new WMTS(options)

source/WMTS.js, строка 71
Имя Тип Описание
attributions AttributionLike | undefined

Атрибуция.
attributionsCollapsible boolean (defaults to true)

Атрибуция может быть свёрнута.
cacheSize number | undefined

Устарело. Вместо этого используйте параметр cacheSize слоя.
crossOrigin null | string | undefined

Атрибут crossOrigin для загруженных изображений. Обратите внимание: чтобы получить доступ к данным пикселей с помощью средства визуализации Canvas, необходимо указать значение crossOrigin. Подробнее см. https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.
referrerPolicy ReferrerPolicy | undefined

Свойство referrerPolicy для загруженных изображений.
interpolate boolean (defaults to true)

Использовать интерполированные значения при передискретизации. По умолчанию при передискретизации используется линейная интерполяция. Установите значение false, чтобы использовать интерполяцию методом ближайшего соседа.
tileGrid WMTSTileGrid

Сетка тайлов.
projection ProjectionLike | undefined

Проекция. По умолчанию используется проекция представления.
reprojectionErrorThreshold number (defaults to 0.5)

Максимально допустимая ошибка перепроецирования (в пикселях). Более высокие значения могут повысить производительность перепроецирования, но снизить точность.
requestEncoding RequestEncoding (defaults to 'KVP')

Кодирование запроса.
layer string

Имя слоя, указанное в описании возможностей WMTS.
style string

Имя стиля, указанное в описании возможностей WMTS.
tileClass Class<ImageTile> | undefined

Класс для создания тайлов изображений. По умолчанию используется ImageTile.
tilePixelRatio number (defaults to 1)

Коэффициент пикселей, используемый тайловым сервисом. Например, если тайловый сервис заявляет о тайлах размером 256 × 256 пикселей, но фактически передаёт изображения размером 512 × 512 пикселей (для устройств Retina/HiDPI), то для tilePixelRatio следует задать значение 2.
format string (defaults to 'image/jpeg')

Формат изображения. Используется только если requestEncoding имеет значение 'KVP'.
version string (defaults to '1.0.0')

Версия WMTS.
matrixSet string

Набор матриц.
dimensions Object | undefined

Дополнительные «измерения» для запросов тайлов. Это объект со свойствами, имена которых совпадают с именами измерений, указанными в описании возможностей WMTS.
url string | undefined

URL сервиса. При кодировании RESTful-запросов это шаблон URL. При кодировании KVP — обычный URL. Вместо определения каждого URL отдельно в параметре urls можно использовать шаблон {?-?}, например subdomain{a-f}.domain.com.
tileLoadFunction LoadFunction | undefined

Необязательная функция загрузки тайла по URL. По умолчанию используется

function(imageTile, src) {
  imageTile.getImage().src = src;
};
urls Array.<string> | undefined

Массив URL. Запросы будут распределяться между URL из этого массива.
wrapX boolean (defaults to false)

Следует ли оборачивать мир по горизонтали.
transition number | undefined

Длительность перехода прозрачности при отрисовке. Чтобы отключить переход прозрачности, передайте transition: 0.
zDirection number | NearestDirectionFunction (defaults to 0)

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

Наследует

  • TileImage

Методы

changed() унаследовано

Observable.js, строка 68

Увеличивает счётчик ревизий и генерирует событие «change».

clear() унаследовано

source/Tile.js, строка 258

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

dispatchEvent(event){boolean | undefined} унаследовано

events/Target.js, строка 85

Отправляет событие и вызывает все обработчики, ожидающие события этого типа. Параметр события может быть строкой или объектом со свойством 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
Возвращает:
Атрибуции можно сворачивать.

getDimensions(){Object}

source/WMTS.js, строка 188

Получает измерения, то есть значения, переданные конструктору через параметр "dimensions" и, возможно, обновлённые с помощью метода updateDimensions.

Возвращает:
Измерения.

getFormat(){string}

source/WMTS.js, строка 197

Возвращает формат изображения источника WMTS.

Возвращает:
Формат.

getKeys(){Array.<string>} унаследовано

Object.js, строка 149

Получает список имён свойств объекта.

Возвращает:
Список имён свойств.

getLayer(){string}

source/WMTS.js, строка 206

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

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

getMatrixSet(){string}

source/WMTS.js, строка 215

Возвращает набор матриц источника WMTS.

Возвращает:
Набор матриц.

getProjection(){Projection | null} унаследовано

source/Source.js, строка 146

Получает проекцию источника.

Возвращает:
Проекция.

getProperties(){NoInfer.<Properties>} унаследовано

Object.js, строка 158

Получает объект со всеми именами свойств и их значениями.

Возвращает:
Объект.

getRequestEncoding(){RequestEncoding}

source/WMTS.js, строка 224

Возвращает способ кодирования запроса: "KVP" или "REST".

Возвращает:
Способ кодирования запроса.

getRevision(){number} унаследовано

Observable.js, строка 79

Получает номер версии этого объекта. При каждом изменении объекта номер его версии увеличивается.

Возвращает:
Номер ревизии.

getState(){State} унаследовано

source/Source.js, строка 201

Получает состояние источника. Возможные состояния см. в State.

Возвращает:
Состояние.

getStyle(){string}

source/WMTS.js, строка 233

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

Возвращает:
Стиль.

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-адреса.

getVersion(){string}

source/WMTS.js, строка 242

Возвращает версию источника WMTS.

Возвращает:
Версия.

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.

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

Observable.js, строка 173

Прекращает ожидание события указанного типа.

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

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

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

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

Object.js, строка 262

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

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

Имя ключа.
silent boolean | undefined

Удалить без генерации события.

updateDimensions(dimensions)

source/WMTS.js, line 263

Обновить измерения.

Имя Тип Описание
dimensions Object

Измерения.

© 2005-present, OpenLayers Contributors All rights reserved.Licensed under the BSD 2-Clause License.
https://openlayers.org/en/latest/apidoc/module-ol_source_WMTS-WMTS.html

Spec-Zone.ru

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