Spec-Zone.ru › OpenLayers

ol/source/WMTS~WMTS


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

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

new WMTS(options)

source/WMTS.js, line 70
Имя Тип Описание
attributions AttributionLike | undefined

Реквизиты.
attributionsCollapsible boolean (defaults to true)

Реквизиты можно сворачивать.
cacheSize number | undefined

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

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

Соотношение пикселей, используемое службой плиток. Например, если служба плиток рекламирует плитки размером 256x256 пикселей, но на самом деле отправляет изображения размером 512x512 пикселей (для устройств с высоким разрешением/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. Вместо того, чтобы определять каждый из них отдельно в параметре 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() inherited

Observable.js, line 68

Увеличивает счётчик ревизий и отправляет событие 'change'.

clear() inherited

source/Tile.js, line 257

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

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

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

getDimensions(){Object}

source/WMTS.js, line 186

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

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

getFormat(){string}

source/WMTS.js, line 195

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

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

getKeys(){Array.<string>} inherited

Object.js, line 148

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

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

getLayer(){string}

source/WMTS.js, line 204

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

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

getMatrixSet(){string}

source/WMTS.js, line 213

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

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

getProjection(){Projection | null} inherited

source/Source.js, line 146

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

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

getProperties(){Object.<string, *>} inherited

Object.js, line 157

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

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

getRequestEncoding(){RequestEncoding}

source/WMTS.js, line 222

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

Возвращает:
Кодировка запроса.

getRevision(){number} inherited

Observable.js, line 79

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

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

getState(){State} inherited

source/Source.js, line 170

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

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

getStyle(){string}

source/WMTS.js, line 231

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

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

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

getVersion(){string}

source/WMTS.js, line 240

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

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

on(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 152

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

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

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

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

once(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 164

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

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

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

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

set(key, value, silent) inherited

Object.js, line 215

Устанавливает значение.

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

Имя ключа.
value *

Значение.
silent boolean | undefined

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

setAttributions(attributions) inherited

source/Source.js, line 203

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

Имя Тип Описание
attributions AttributionLike | undefined

Атрибуты. Могут быть переданы как string, Array<string>, Attribution или undefined.

setProperties(values, silent) inherited

Object.js, line 235

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

Имя Тип Описание
values Object.<string, *>

Значения.
silent boolean | undefined

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

setRenderReprojectionEdges(render) inherited

source/TileImage.js, line 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, строка 187

Устанавливает URL для использования в запросах.

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

URL.

un(type, listener) inherited

Observable.js, строка 173

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

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

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

Функция-слушатель.

unset(key, silent) inherited

Object.js, строка 259

Снимает установку свойства.

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

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

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

updateDimensions(dimensions)

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

Обновляет размеры.

Имя Тип Описание
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