ImageMapGuide~ImageMapGuide

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

Источник изображений с серверов MapGuide

new ImageMapGuide(options) source/ImageMapGuide.js, строка 39

Имя	Тип	Описание
`url`	string \| undefined	URL mapagent.
`crossOrigin`	null \| string \| undefined	Атрибут `crossOrigin` для загруженных изображений. Обратите внимание: если вы хотите получать данные пикселей с помощью средства визуализации Canvas, необходимо указать значение `crossOrigin`. Подробнее см. в разделе https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image.
`referrerPolicy`	ReferrerPolicy \| undefined	Свойство `referrerPolicy` для загруженных изображений.
`displayDpi`	number (по умолчанию 96)	Разрешение экрана.
`metersPerUnit`	number (по умолчанию 1)	Значение метров на единицу измерения.
`hidpi`	boolean (по умолчанию true)	Использовать значение `ol/Map#pixelRatio` при запросе изображения с удалённого сервера.
`useOverlay`	boolean \| undefined	Если `true`, будет использоваться `GETDYNAMICMAPOVERLAYIMAGE`.
`projection`	ProjectionLike \| undefined	Проекция. По умолчанию используется проекция представления.
`ratio`	number (по умолчанию 1)	Коэффициент. `1` означает, что размер запрашиваемых изображений равен размеру области просмотра карты; `2` означает, что ширина и высота изображений вдвое превышают размер области просмотра карты и т. д. Значение должно быть не меньше `1`.
`resolutions`	Array.<number> \| undefined	Разрешения. Если указаны, запросы будут выполняться только для этих разрешений.
`imageLoadFunction`	LoadFunction \| undefined	Необязательная функция для загрузки изображения по URL.
`interpolate`	boolean (по умолчанию true)	Использовать интерполированные значения при передискретизации. По умолчанию применяется линейная интерполяция. Установите значение false, чтобы использовать метод ближайшего соседа.
`params`	Object \| undefined	Дополнительные параметры.

Генерируемые события:

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

Отправляет событие и вызывает все обработчики, подписанные на события этого типа. Параметр события может быть строкой или объектом со свойством 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/ImageMapGuide.js, строка 180

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

Возвращает:

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

getKeys(){Array.<string>} унаследовано Object.js, строка 149

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

Возвращает:

Список имён свойств.

getParams(){Object} source/ImageMapGuide.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.

Возвращает:

Состояние.

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/ImageMapGuide.js, строка 211

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

Имя	Тип	Описание
`imageLoadFunction`	LoadFunction	Функция загрузки изображений.

setParams(params) source/ImageMapGuide.js, строка 189

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

Имя	Тип	Описание
`params`	Object	Параметры.

setProperties(values, silent) унаследовано Object.js, строка 238

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

Имя	Тип	Описание
`values`	Partial.<NoInfer.<Properties>>	Значения.
`silent`	boolean \| undefined	Обновить без вызова события.

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/ImageMapGuide.js, строка 201

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

Имя	Тип	Описание
`params`	Object	Параметры.