ol/Geolocation~Геолокация

import Geolocation from 'ol/Geolocation.js';

Вспомогательный класс для предоставления возможностей HTML5 Geolocation. API геолокации Geolocation API используется для определения местоположения пользователя.

Для получения уведомлений о изменениях местоположения и ошибках, зарегистрируйте слушателей для общего события change и события error на вашем экземпляре Geolocation.

Пример:

const geolocation = new Geolocation({
  // take the projection to use from the map's view
  projection: view.getProjection()
});
// listen to changes in position
geolocation.on('change', function(evt) {
  console.log(geolocation.getPosition());
});
// listen to error
geolocation.on('error', function(evt) {
  window.console.log(evt.message);
});

new Geolocation(options) Geolocation.js, строка 120

Имя	Тип	Описание
`tracking`	boolean (по умолчанию false)	Начать отслеживание сразу после создания.
`trackingOptions`	PositionOptions \| undefined	Параметры отслеживания. См. https://www.w3.org/TR/geolocation-API/#position_options_interface.
`projection`	ProjectionLike \| undefined	Проекция, в которой сообщается положение.

Срабатывающие события:

change (BaseEvent) - Общее событие изменения. Срабатывает при увеличении счётчика версий.
change:accuracy (ObjectEvent)
change:accuracyGeometry (ObjectEvent)
change:altitude (ObjectEvent)
change:altitudeAccuracy (ObjectEvent)
change:heading (ObjectEvent)
change:position (ObjectEvent)
change:projection (ObjectEvent)
change:speed (ObjectEvent)
change:tracking (ObjectEvent)
change:trackingOptions (ObjectEvent)
error (GeolocationError) - Срабатывает при возникновении GeolocationPositionError.
error (BaseEvent) - Общее событие ошибки. Срабатывает при возникновении ошибки.
propertychange (ObjectEvent) - Срабатывает при изменении свойства.

Расширяет

BaseObject

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

Имя	Тип	Изменяемое	ObjectEvent тип	Описание
`accuracy`	number \| undefined	нет	`change:accuracy`	Точность измерения местоположения в метрах.
`accuracyGeometry`	Polygon	нет	`change:accuracygeometry`	Геометрия точности местоположения.
`altitude`	number \| undefined	нет	`change:altitude`	Высота местоположения в метрах над уровнем моря.
`altitudeAccuracy`	number \| undefined	нет	`change:altitudeaccuracy`	Точность измерения высоты в метрах.
`heading`	number \| undefined	нет	`change:heading`	Азимут устройства в радианах от северной стороны.
`position`	Coordinate \| undefined	нет	`change:position`	Текущее местоположение устройства, указанное в текущей проекции.
`projection`	Projection \| undefined	да	`change:projection`	Проекция, в которой сообщается положение.
`speed`	number \| undefined	нет	`change:speed`	Мгновенная скорость устройства в метрах в секунду.
`tracking`	boolean	да	`change:tracking`	Местоположение устройства отслеживается.
`trackingOptions`	PositionOptions \| undefined	да	`change:trackingoptions`	PositionOptions, как определено в спецификации HTML5 Geolocation.

Методы

changed() inherited Observable.js, line 68

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

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

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

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

Возвращает:

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

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

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

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

Возвращает:

Значение.

getAccuracy(){number | undefined} Geolocation.js, line 269

Получить точность определения позиции в метрах.

Возвращает:

Точность измерения позиции в метрах.

getAccuracyGeometry(){Polygon} Geolocation.js, line 279

Получить геометрию точности определения позиции.

Возвращает:

Геометрию точности определения позиции.

getAltitude(){number | undefined} Geolocation.js, line 292

Получить высоту, связанную с позицией.

Возвращает:

Высоту позиции в метрах над уровнем моря.

getAltitudeAccuracy(){number | undefined} Geolocation.js, line 303

Получить точность измерения высоты позиции.

Возвращает:

Точность измерения высоты в метрах.

getHeading(){number | undefined} Geolocation.js, line 317

Получить курс в радианах по часовой стрелке от севера. Примечание: в зависимости от браузера, курс определяется только если enableHighAccuracy задано как true в опциях отслеживания.

Возвращает:

Курс устройства в радианах от севера.

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

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

Возвращает:

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

getPosition(){Coordinate | undefined} Geolocation.js, line 328

Получить позицию устройства.

Возвращает:

Текущую позицию устройства, представленную в текущей проекции.

getProjection(){Projection | undefined} Geolocation.js, line 341

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

Возвращает:

Проекцию, в которой представлена позиция.

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

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

Возвращает:

Объект.

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

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

Возвращает:

Ревизия.

getSpeed(){number | undefined} Geolocation.js, line 354

Получить скорость в метрах в секунду.

Возвращает:

Текущая скорость устройства в метрах в секунду.

getTracking(){boolean} Geolocation.js, line 364

Определить, отслеживается ли местоположение устройства.

Возвращает:

Отслеживается ли местоположение устройства.

getTrackingOptions(){PositionOptions | undefined} Geolocation.js, line 377

Получить опции отслеживания. См. https://www.w3.org/TR/geolocation-API/#position-options.

Возвращает:

PositionOptions, как определено в спецификации HTML5 Geolocation.

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, строка 152

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

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

Возвращает:

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

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, строка 164

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

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

Возвращает:

set(key, value, silent) inherited Object.js, строка 215

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

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

setProjection(projection) Geolocation.js, строка 390

Установить проекцию для преобразования координат.

Имя	Тип	Описание
`projection`	ProjectionLike	Проекция, в которой сообщается положение.

setProperties(values, silent) inherited Object.js, строка 235

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

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

setTracking(tracking) Geolocation.js, строка 400

Включить или выключить отслеживание.

Имя	Тип	Описание
`tracking`	boolean	Включить отслеживание.

setTrackingOptions(options) Geolocation.js, строка 413

Установить параметры отслеживания. См. http://www.w3.org/TR/geolocation-API/#position-options.

Имя	Тип	Описание
`options`	PositionOptions	PositionOptions, как определено в спецификации HTML5 Geolocation спецификации.

un(type, listener) inherited Observable.js, строка 173

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

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

unset(key, silent) inherited Object.js, строка 259

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

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