Attribution~Атрибуция

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

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

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

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

Срабатывает:

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

Расширяет

Control

Методы

changed() унаследованный Observable.js, строка 68

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

dispatchEvent(event){boolean | undefined} унаследованный events/Target.js, строка 85

Отправляет событие и вызывает всех слушателей, отслеживающих события этого типа. Параметр события может быть строкой или объектом с свойством type.

Имя	Тип	Описание
`event`	BaseEvent \| строка	Объект события.

Возвращает:

false, если кто-то вызвал preventDefault для объекта события или любой из слушателей вернул false.

get(key){*} унаследованный Object.js, строка 135

Получает значение.

Имя	Тип	Описание
`key`	строка	Имя ключа.

Возвращает:

Значение.

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

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

Возвращает:

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

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

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

Возвращает:

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

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

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

Возвращает:

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

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

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

Возвращает:

Карту.

getProperties(){Object.<string, *>} унаследованный Object.js, строка 157

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

Возвращает:

Объект.

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

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

Возвращает:

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

on(type, listener){EventsKey | Array<EventsKey>} унаследованный Observable.js, строка 152

Прослушивать события определённого типа.

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

Возвращает:

Уникальный ключ для слушателя. Если вызывается с массивом типов событий в качестве первого аргумента, возвращается массив ключей.

once(type, listener){EventsKey | Array<EventsKey>} унаследованный Observable.js, строка 164

Прослушать событие определённого типа один раз.

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

Возвращает:

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

Устанавливает значение.

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

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

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

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

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

Установить, должна ли подпись быть сворачиваемой.

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

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

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

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

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

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

Имя	Тип	Описание
`values`	Объект.<строка, *>	Значения.
`silent`	boolean \| undefined	Обновить без срабатывания события.

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

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

Имя	Тип	Описание
`target`	Элемент HTML \| строка	Цель.

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

Отменить прослушивание определённого типа события.

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

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

Сбросить свойство.

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