Attribution~Attribution

import Attribution from 'ol/control/Attribution.js';

Элемент управления для отображения всех сведений об атрибуции, связанных с источниками слоёв на карте. Этот элемент управления входит в набор элементов управления, включённых в карты по умолчанию. По умолчанию он отображается в нижней правой части карты, но это можно изменить с помощью CSS-селектора для .ol-attribution.

new Attribution(options) control/Attribution.js, строка 53

Имя	Тип	Описание
`className`	string (по умолчанию 'ol-attribution')	Имя класса CSS.
`target`	HTMLElement \| string \| undefined	Укажите целевой элемент, если требуется отображать элемент управления за пределами области просмотра карты.
`collapsible`	boolean \| undefined	Укажите, можно ли сворачивать сведения об атрибуции. Если значение не задано, это поведение определяется источниками с помощью параметра `attributionsCollapsible`.
`collapsed`	boolean (по умолчанию true)	Укажите, следует ли сворачивать сведения об атрибуции при запуске.
`tipLabel`	string (по умолчанию 'Attributions')	Текстовая подпись для всплывающей подсказки кнопки.
`label`	string \| HTMLElement (по умолчанию 'i')	Текстовая подпись для кнопки свёрнутых сведений об атрибуции. Вместо текста можно также использовать элемент (например, элемент `span`).
`expandClassName`	string (по умолчанию className + '-expand')	Имя класса CSS для кнопки свёрнутых сведений об атрибуции.
`collapseLabel`	string \| HTMLElement (по умолчанию '›')	Текстовая подпись для кнопки развёрнутых сведений об атрибуции. Вместо текста можно также использовать элемент (например, элемент `span`).
`collapseClassName`	string (по умолчанию className + '-collapse')	Имя класса CSS для кнопки развёрнутых сведений об атрибуции.
`render`	function \| undefined	Функция, вызываемая при необходимости повторной отрисовки элемента управления. Она вызывается в обратном вызове `requestAnimationFrame`.
`attributions`	string \| Array.<string> \| undefined	Необязательные сведения об атрибуции, которые будут отображаться всегда, независимо от отрисованных слоёв. Внимание: сведения об атрибуции отображаются динамически с помощью `innerHTML`, что может привести к уязвимостям, связанным с межсайтовым скриптингом (XSS). Используйте эту возможность только для доверенного содержимого или перед вставкой убедитесь, что содержимое надлежащим образом очищено.

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

change (BaseEvent) — общее событие изменения. Генерируется при увеличении счётчика ревизии.
error (BaseEvent) — общее событие ошибки. Генерируется при возникновении ошибки.
propertychange (ObjectEvent) — генерируется при изменении свойства.

Расширяет

Control

Методы

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	Имя ключа.

Возвращает:

Значение.

getCollapsed(){boolean} control/Attribution.js, строка 336

Возвращает true, если сведения об атрибуции свёрнуты в данный момент, и false в противном случае.

Возвращает:

True, если виджет свёрнут.

getCollapsible(){boolean} control/Attribution.js, строка 295

Возвращает true, если сведения об атрибуции можно свернуть, и false в противном случае.

Возвращает:

True, если виджет можно свернуть.

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

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

Возвращает:

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

getMap(){Map | null} унаследовано control/Control.js, строка 104

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

Возвращает:

Карта.

getProperties(){NoInfer.<Properties>} унаследовано Object.js, строка 158

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

Возвращает:

Объект.

getRevision(){number} унаследовано Observable.js, строка 79

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

Возвращает:

Номер ревизии.

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	Функция-обработчик.

Возвращает:

set(key, value, silent) унаследовано Object.js, строка 218

Задаёт значение.

Имя	Тип	Описание
`key`	string	Имя ключа.
`value`	*	Значение.
`silent`	boolean \| undefined	Обновить без вызова события.

setCollapsed(collapsed) control/Attribution.js, строка 322

Сворачивает или разворачивает сведения об атрибуции в соответствии с переданным параметром. Ничего не делает, если сведения нельзя свернуть или если текущее состояние свёрнутости уже соответствует требуемому.

Имя	Тип	Описание
`collapsed`	boolean	True, если виджет свёрнут.

setCollapsible(collapsible) control/Attribution.js, строка 304

Задаёт, можно ли сворачивать сведения об атрибуции.

Имя	Тип	Описание
`collapsible`	boolean	True, если виджет можно свернуть.

setMap(map) унаследовано control/Control.js, строка 116

Удаляет элемент управления с текущей карты и прикрепляет его к новой. Передайте null, чтобы просто удалить элемент управления с текущей карты. Здесь подклассы могут настраивать обработчики событий для получения уведомлений об изменениях карты.

Имя	Тип	Описание
`map`	Map \| null	Карта.

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

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

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

setTarget(target) унаследовано control/Control.js, строка 155

Эта функция задаёт целевой элемент для элемента управления. Если вызвать её после добавления элемента управления на карту (то есть после вызова setMap для элемента управления), она не повлияет на результат. Если в параметрах, переданных конструктору элемента управления, не задан параметр target и метод setTarget не вызван, элемент управления добавляется в контейнер наложений карты.

Имя	Тип	Описание
`target`	HTMLElement \| string	Целевой элемент.

un(type, listener) унаследовано Observable.js, строка 173

Прекращает ожидание события определённого типа.

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция-обработчик.

unset(key, silent) унаследовано Object.js, строка 262

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

Имя	Тип	Описание
`key`	string	Имя ключа.
`silent`	boolean \| undefined	Удалить без вызова события.