MousePosition~MousePosition

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

Контрол для отображения 2D координат курсора мыши. По умолчанию, эти координаты находятся в проекции просмотра, но могут быть в любой поддерживаемой проекции. По умолчанию, контрол отображается в правом верхнем углу карты, но это можно изменить, используя CSS селектор .ol-mouse-position.

На сенсорных устройствах, которые обычно не имеют курсора мыши, отображаются координаты текущей точки касания.

new MousePosition(options) control/MousePosition.js, line 66

Имя	Тип	Описание
`className`	string (defaults to 'ol-mouse-position')	Имя CSS класса.
`coordinateFormat`	CoordinateFormat \| undefined	Формат координат.
`projection`	ProjectionLike \| undefined	Проекция. По умолчанию используется проекция просмотра.
`render`	function \| undefined	Функция, вызываемая при необходимости повторной отрисовки контрола. Она вызывается в `requestAnimationFrame` обработчике.
`target`	HTMLElement \| string \| undefined	Укажите целевой элемент, если вы хотите отобразить контрол вне области просмотра карты.
`placeholder`	string \| undefined	Разметка для отображения, когда координаты мыши недоступны (например, когда указатель выходит за пределы области просмотра карты). По умолчанию, сначала отображается неразрывный пробел, а при выходе указателя за пределы области просмотра сохраняется последняя позиция. При предоставлении строки (например, `'no position'` или `''` для пустой строки) она используется в качестве заполнительного значения.
`wrapX`	boolean (defaults to true)	Оборачивание мира по горизонтальной оси вдоль антимеридиана проекции, если это глобальная проекция.

События:

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

Расширяет

Control

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

Имя	Тип	Устанавливаемое	ObjectEvent тип	Описание
`coordinateFormat`	CoordinateFormat \| undefined	да	`change:coordinateformat`	Формат отображения текущей позиции.
`projection`	Projection \| undefined	да	`change:projection`	Проекция для отображения координат мыши.

Методы

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

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

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

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

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

Возвращает:

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

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

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

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

Возвращает:

Значение.

getCoordinateFormat(){CoordinateFormat | undefined} control/MousePosition.js, строка 159

Возвращает тип формата координат, используемого для рендеринга текущей позиции, или undefined.

Возвращает:

Формат для рендеринга текущей позиции.

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

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

Возвращает:

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

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

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

Возвращает:

Карта.

getProjection(){Проекция | undefined} control/MousePosition.js, строка 172

Возвращает проекцию, используемую для отображения положения указателя мыши.

Возвращает:

Проекция для отображения положения указателя мыши.

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

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

Возвращает:

Объект.

getRevision(){число} унаследованный 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`	логическое \| undefined	Обновить без срабатывания события.

установитьФорматКоординат(формат) control/MousePosition.js, строка 227

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

Имя	Тип	Описание
`format`	CoordinateFormat	Формат, в котором будет отображаться текущее положение.

установитьКарту(карта) control/MousePosition.js, строка 204

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

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

установитьПроекцию(проекция) control/MousePosition.js, строка 238

Установить проекцию, используемую для отслеживания положения мыши.

Имя	Тип	Описание
`projection`	ТипПроекции	Проекция для отслеживания положения мыши.

установитьСвойства(значения, безЗвука) унаследованный Object.js, строка 235

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

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

установитьЦель(цель) унаследованный control/Control.js, строка 155

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

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

отписаться(тип, слушатель) унаследованный Observable.js, строка 173

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

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

очистить(ключ, безЗвука) унаследованный Object.js, строка 259

Очищает свойство.

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