Spec-Zone.ru › OpenLayers

ol/source/ImageArcGISRest~ImageArcGISRest


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

Источник данных из сервисов ArcGIS REST, предоставляющих отдельные изображения без разбиения на тайлы. Полезно, если базовый картографический сервис содержит подписи.

Если базовый картографический сервис не использует подписи, воспользуйтесь кэшированием изображений ol и источником данных TileArcGISRest.

new ImageArcGISRest(options)

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

Атрибуция.

crossOrigin null | string | undefined

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

referrerPolicy ReferrerPolicy | undefined

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

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

Использовать значение ol/Map#pixelRatio при запросе изображения с удалённого сервера.

imageLoadFunction LoadFunction | undefined

Необязательная функция для загрузки изображения по URL.

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

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

params Object.<string, *> | undefined

Параметры ArcGIS REST. Это поле необязательно. Для неуказанных полей будут использоваться значения сервиса по умолчанию. По умолчанию format имеет значение png32. По умолчанию f имеет значение image. По умолчанию transparent имеет значение true. Значения bbox, size, bboxSR и imageSR будут заданы динамически. Задайте layers, чтобы переопределить видимость слоёв сервиса по умолчанию. Дополнительные сведения см. в справочной документации: https://developers.arcgis.com/rest/services-reference/export-map.htm.

projection ProjectionLike | undefined

Проекция. По умолчанию используется проекция вида. Код проекции должен содержать числовую конечную часть, отделённую символом :, либо весь код должен соответствовать допустимому определению ArcGIS SpatialReference.

ratio number (по умолчанию 1.5)

Коэффициент. Значение 1 означает, что запрашиваемые изображения соответствуют размеру области просмотра карты, значение 2 — что они вдвое больше области просмотра карты, и так далее.

resolutions Array.<number> | undefined

Разрешения. Если они указаны, запросы будут выполняться только для этих разрешений.

url string | undefined

URL сервиса ArcGIS REST для картографического сервиса или сервиса изображений. URL должен содержать /MapServer или /ImageServer.

Генерирует события:
  • change (BaseEvent) — общее событие изменения. Вызывается при увеличении счётчика версий.
  • error (BaseEvent) — общее событие ошибки. Вызывается при возникновении ошибки.
  • imageloadend (ImageSourceEvent) — вызывается после завершения загрузки изображения.
  • imageloaderror (ImageSourceEvent) — вызывается, если при загрузке изображения произошла ошибка.
  • imageloadstart (ImageSourceEvent) — вызывается при начале загрузки изображения.
  • propertychange (ObjectEvent) — вызывается при изменении свойства.

Расширяет

  • ImageSource

Методы

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

Observable.js, строка 68

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

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

getImageLoadFunction(){LoadFunction}

source/ImageArcGISRest.js, строка 179

Возвращает функцию загрузки изображений источника.

Возвращает:
Функция загрузки изображений.

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

Object.js, строка 149

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

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

getParams(){Object}

source/ImageArcGISRest.js, строка 136

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

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

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.

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

getUrl(){string | undefined}

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

Возвращает URL, используемый для этого источника ArcGIS.

Возвращает:
URL.

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.

setImageLoadFunction(imageLoadFunction)

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

Задаёт функцию загрузки изображений источника.

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

Функция загрузки изображений.

setParams(params)

source/ImageArcGISRest.js, строка 220

Задаёт параметры, указанные пользователем.

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

Параметры.

setProperties(values, silent) унаследован

Object.js, строка 238

Задаёт набор пар «ключ—значение». Обратите внимание: существующие свойства будут изменены, а новые — добавлены (имеющиеся свойства не удаляются).

Имя Тип Описание
values Partial.<NoInfer.<Properties>>

Значения.

silent boolean | undefined

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

setUrl(url)

source/ImageArcGISRest.js, строка 207

Задаёт URL для запросов.

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

URL.

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

Observable.js, строка 173

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

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

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

listener function

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

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

Object.js, строка 262

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

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

Имя ключа.

silent boolean | undefined

Удалить без вызова события.

updateParams(params)

source/ImageArcGISRest.js, строка 232

Обновляет параметры, указанные пользователем.

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

Параметры.

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

Spec-Zone.ru

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