Spec-Zone.ru › OpenLayers

ol/source/GeoTIFF~GeoTIFFSource


import GeoTIFFSource from 'ol/source/GeoTIFF.js';

Источник для работы с данными GeoTIFF. Примечание для пользователей полной сборки: для работы источника GeoTIFF также необходимо загрузить библиотеку geotiff.js.

new GeoTIFFSource(options)

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

Атрибуция.

sources Array<SourceInfo>

Список сведений об источниках GeoTIFF. Несколько источников можно объединить, если их наборы разрешений совпадают после применения масштаба. Список источников задаёт соответствие между входными каналами, считываемыми из каждого GeoTIFF, и выходными каналами, предоставляемыми тайлами данных. Чтобы управлять тем, какие каналы считываются из каждого GeoTIFF, используйте свойство bands. Например, если указать два источника: один с 3 каналами и настроенным свойством nodata, а другой — с 1 каналом, результирующие тайлы данных будут содержать 5 каналов: 3 из первого источника, 1 альфа-канал из первого источника и 1 канал из второго источника.

sourceOptions GeoTIFFSourceOptions | undefined

Дополнительные параметры, передаваемые методам fromUrl или fromUrls библиотеки geotiff.js.

convertToRGB true | false | 'auto' (по умолчанию false)

По умолчанию каналы источников считываются без изменений. При чтении GeoTIFF для отображения в виде изображений RGB установка значения true преобразует другие цветовые пространства (YCbCr, CMYK) в RGB. Установка значения 'auto' приведёт к автоматическому преобразованию изображений CMYK, YCbCr, CIELab и ICCLab в RGB.

normalize boolean (по умолчанию true)

По умолчанию данные источника нормализуются до значений от 0 до 1 с использованием коэффициентов масштабирования, рассчитанных на основе статистики растра или свойств min и max каждого источника. Если вместо этого вы хотите работать с исходными значениями в выражении стиля, задайте значение false. Установка для этого параметра значения false приведёт к игнорированию любых свойств min и max у источников.

projection ProjectionLike | undefined

Проекция источника. Если она не указана, сведения о проекции будут прочитаны из метаданных GeoTIFF.

loadMissingProjection boolean (по умолчанию false)

Следует ли пытаться загрузить отсутствующие определения проекций. Используется предварительно настроенная функция поиска проекций, которую можно изменить с помощью setProjectionCodeLookup.

transition number (по умолчанию 250)

Длительность перехода прозрачности при отрисовке. Чтобы отключить переход прозрачности, передайте transition: 0.

wrapX boolean (по умолчанию false)

Отрисовывать тайлы за пределами области сетки тайлов.

interpolate boolean (по умолчанию true)

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

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

Наследует

  • DataTileSource

Методы

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
Возвращает:
Можно ли сворачивать атрибуцию.

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

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

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

getView(){Promise<ViewOptions>}

source/GeoTIFF.js, строка 1188

Возвращает промис со свойствами представления, определёнными на основе источника. Используйте результат этой функции как параметр view конструктора карты.

const source = new GeoTIFF(options);

const map = new Map({
  target: 'map',
  layers: [
    new TileLayer({
      source: source,
    }),
  ],
  view: source.getView(),
});
Возвращает:
Промис со свойствами, относящимися к представлению.

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

Сетка тайлов для проекции.

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_GeoTIFF-GeoTIFFSource.html

Spec-Zone.ru

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