ol/source/WMTS

Классы

WMTS

Функции

optionsFromCapabilities(wmtsCap, config){Options | null} source/WMTS.js, строка 363

import {optionsFromCapabilities} from 'ol/source/WMTS';

Генерация параметров источника из объекта возможностей.

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

Имя	Тип	Описание
`wmtsCap`	Объект	Объект, представляющий документ возможностей.
`config`	Объект	Настройки слоя. Значения по умолчанию для слоя применяются, если не указаны явно. Необходимые свойства конфигурации: layer - {строка} Идентификатор слоя. Дополнительные свойства конфигурации: matrixSet - {строка} Идентификатор набора матриц. Требуется, если в возможностях слоя указано более одного набора матриц. projection - {строка} Желаемая система координат, если не указан matrixSet. Пример: "EPSG:3857". Если желаемая проекция недоступна, генерируется ошибка. requestEncoding - {строка} Формат кодирования URL для слоя. По умолчанию используется первый формат URL плитки, найденный в ответе GetCapabilities. style - {строка} Имя стиля format - {строка} Формат изображения для слоя. По умолчанию используется первый формат, возвращённый в ответе GetCapabilities. crossOrigin - {строка\|null\|undefined} Кросс-ориджин. По умолчанию `undefined`.

wmtsCap

Объект

Объект, представляющий документ возможностей.

config

Объект

Настройки слоя.

Значения по умолчанию для слоя применяются, если не указаны явно.

Необходимые свойства конфигурации:

layer - {строка} Идентификатор слоя.

Дополнительные свойства конфигурации:

matrixSet - {строка} Идентификатор набора матриц. Требуется, если в возможностях слоя указано более одного набора матриц.
projection - {строка} Желаемая система координат, если не указан matrixSet. Пример: "EPSG:3857". Если желаемая проекция недоступна, генерируется ошибка.
requestEncoding - {строка} Формат кодирования URL для слоя. По умолчанию используется первый формат URL плитки, найденный в ответе GetCapabilities.
style - {строка} Имя стиля
format - {строка} Формат изображения для слоя. По умолчанию используется первый формат, возвращённый в ответе GetCapabilities.
crossOrigin - {строка|null|undefined} Кросс-ориджин. По умолчанию undefined.

Возвращает:

Объект параметров источника WMTS или null, если слой не найден.

Определения типов

Options{Объект}

Свойства:

Имя	Тип	Описание
`attributions`	AttributionLike \| undefined	Подписи.
`attributionsCollapsible`	логическое значение (по умолчанию true)	Подписи можно сворачивать.
`cacheSize`	число \| undefined	Устарело. Используйте вместо этого параметр cacheSize для слоя.
`crossOrigin`	null \| строка \| undefined	Атрибут `crossOrigin` для загруженных изображений. Обратите внимание, что вам необходимо указать значение `crossOrigin`, если вы хотите получить доступ к данным пикселей с помощью рендерера Canvas. Подробнее см. https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.
`interpolate`	логическое значение (по умолчанию true)	Использовать интерполированные значения при ресемплировании. По умолчанию используется линейная интерполяция при ресемплировании. Установите в значение false, чтобы использовать ближайший сосед.
`tileGrid`	WMTSTileGrid	Система плиток.
`projection`	ProjectionLike \| undefined	Проекция. По умолчанию используется проекция представления.
`reprojectionErrorThreshold`	число (по умолчанию 0.5)	Максимальная допустимая ошибка репроекции (в пикселях). Более высокие значения могут повысить производительность репроекции, но снизить точность.
`requestEncoding`	RequestEncoding (по умолчанию 'KVP')	Кодирование запроса.
`layer`	строка	Имя слоя, объявленного в возможностях WMTS.
`style`	строка	Имя стиля, объявленного в возможностях WMTS.
`tileClass`	Класс<ImageTile> \| undefined	Класс, используемый для создания плиток изображения. По умолчанию `ImageTile`.
`tilePixelRatio`	число (по умолчанию 1)	Коэффициент пикселей, используемый службой плиток. Например, если служба плиток рекламирует плитки размером 256x256 пикселей, но фактически отправляет изображения размером 512x512 пикселей (для устройств с сетчаткой/hidpi), то `tilePixelRatio` должно быть установлено в `2`.
`format`	строка (по умолчанию 'image/jpeg')	Формат изображения. Используется только тогда, когда `requestEncoding` равен `'KVP'`.
`version`	строка (по умолчанию '1.0.0')	Версия WMTS.
`matrixSet`	строка	Набор матриц.
`dimensions`	Объект \| undefined	Дополнительные «измерения» для запросов плиток. Это объект со свойствами, имеющими имена, аналогичные объявленным измерениям WMTS.
`url`	строка \| undefined	URL службы. Для RESTful кодирования запросов это шаблон URL. Для кодирования KVP — обычный URL. Вместо определения каждого из них отдельно в опции `urls` можно использовать шаблон `{?-?}`, например `subdomain{a-f}.domain.com`.
`tileLoadFunction`	LoadFunction \| undefined	Необязательная функция для загрузки плитки по заданному URL. По умолчанию function(imageTile, src) { imageTile.getImage().src = src; };
`urls`	Массив.<строка> \| undefined	Массив URL-адресов. Запросы будут распределяться по URL-адресам в этом массиве.
`wrapX`	логическое значение (по умолчанию false)	Оборачивать мир по горизонтали.
`transition`	число \| undefined	Продолжительность перехода прозрачности для рендеринга. Для отключения перехода прозрачности передайте `transition: 0`.
`zDirection`	число \| NearestDirectionFunction (по умолчанию 0)	Выберите, использовать ли плитки с более высоким или более низким уровнем масштабирования между целыми уровнями масштабирования. См. `getZForResolution`.

RequestEncoding{'KVP'} {'REST'}

Кодирование запроса. Одно из 'KVP', 'REST'.