Link~Ссылка

import Link from 'ol/interaction/Link.js';

Взаимодействие, синхронизирующее состояние карты с URL.

new Ссылка(options) interaction/Link.js, строка 79

Имя	Тип	Описание
`animate`	boolean \| AnimationOptions (по умолчанию true)	Анимировать переходы просмотра.
`params`	Array<Params> (по умолчанию ['x', 'y', 'z', 'r', 'l'])	Свойства для отслеживания. По умолчанию отслеживаются `x` (координата x центра), `y` (координата y центра), `z` (масштаб), `r` (поворот) и `l` (слои).
`replace`	boolean (по умолчанию false)	Заменить текущий URL без создания новой записи в истории браузера. По умолчанию изменения состояния карты приводят к добавлению новой записи в историю браузера.
`prefix`	string (по умолчанию '')	По умолчанию URL будет обновлён с параметрами поиска x, y, z и r. Чтобы избежать конфликтов с существующими параметрами поиска, используемыми вашим приложением, можно указать настраиваемый префикс для используемых этим взаимодействием параметров (например, 'ol:').

Вызывает:

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

Расширяет

Interaction

Наблюдаемые свойства

Имя	Тип	Устанавливаемое	ObjectEvent тип	Описание
`active`	boolean	да	`change:active`	`true` если взаимодействие активно, `false` в противном случае.

Методы

changed() inherited Observable.js, line 68

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

dispatchEvent(event){boolean | undefined} inherited events/Target.js, line 85

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

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

Возвращает:

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

get(key){*} inherited Object.js, line 135

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

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

Возвращает:

Значение.

getActive(){boolean} inherited interaction/Interaction.js, line 82

Возвращает, активен ли в данный момент интерактивный элемент.

Возвращает:

true, если интерактивный элемент активен, false в противном случае.

getKeys(){Array.<string>} inherited Object.js, line 148

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

Возвращает:

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

getMap(){Map | null} inherited interaction/Interaction.js, line 91

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

Возвращает:

Карту.

getProperties(){Object.<string, *>} inherited Object.js, line 157

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

Возвращает:

Объект.

getRevision(){number} inherited Observable.js, line 79

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

Возвращает:

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

handleEvent(mapBrowserEvent){boolean} inherited interaction/Interaction.js, line 101

Обрабатывает событие map browser event.

Имя	Тип	Описание
`mapBrowserEvent`	MapBrowserEvent	Событие браузера карты.

Возвращает:

false для остановки распространения события.

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 152

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

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

Возвращает:

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

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 164

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

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

Возвращает:

set(key, value, silent) inherited Object.js, line 215

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

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

setActive(active) унаследованный interaction/Interaction.js, строка 111

Активировать или деактивировать взаимодействие.

Имя	Тип	Описание
`active`	boolean	Активно.

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

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

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

track(key, callback){string | null} interaction/Link.js, строка 384

Регистрирует обработчик для параметра URL-строки. Обработчик вызывается с новым значением, когда соответствующий параметр строки запроса меняется из-за событий истории (например, навигации браузера).

Имя	Тип	Описание
`key`	string	Параметр строки запроса URL.
`callback`	Callback	Функция, вызываемая при изменении параметра строки запроса.

Возвращает:

Начальное значение параметра строки запроса (или null, если его нет в URL).

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

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

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

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

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

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

update(key, value) interaction/Link.js, строка 401

Обновляет URL с новым значением параметра строки запроса. Если значение равно null, оно будет удалено из параметров строки запроса.

Имя	Тип	Описание
`key`	string	Параметр строки запроса URL.
`value`	string \| null	Обновленное значение (или null для удаления из URL).