panorama.Player
Расширяет IEventEmitter.
Класс для создания и управления плеером панорам.
Конструктор | Поля | События | Методы
Конструктор
panorama.Player(element, panorama[, options])
Создает экземпляр плеера панорам.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: HTMLElement|String Ссылка на HTML-элемент, в котором будет размещен плеер, или идентификатор этого HTML-элемента. |
|
— |
Тип: IPanorama Панорама, которая будет открыта в созданном плеере. |
|
— |
Тип: Object Опции. |
|
"always" |
Тип: String Опция, позволяющая отключить автоматическое слежение за размером контейнера плеера. По умолчанию плеер всегда следит за размером своего контейнера, перестраивая изображение, если они изменились. Доступные значения:
|
|
— |
Тип: String[] Набор контролов плеера. Доступные контролы:
|
|
'auto' |
Тип: Number[]|String Направление взгляда в формате |
|
false |
Тип: Boolean Опция, включающая управление плеером с клавиатуры. Обратите внимание, что при включении плеер начинает перехватывать нажатия некоторых клавиш (например, курсорных), отменяя при это реакцию браузера по умолчанию, что может мешать пользователю взаимодействовать с вашей страницей. Поэтому по умолчанию управление с клавиатуры выключено. |
|
true |
Тип: Boolean Опция, позволяющая отключить масштабирование панорамы колесом мыши. По умолчаню включено, и плеер перехватывает события колеса мыши. |
|
'auto' |
Тип: Number[]|String Угловые размеры поля обзора в формате |
|
false |
Тип: Boolean Нужно ли скрывать предложение открыть текущую панораму в Яндекс Картах, максимально сохранив всю имеющуюся информацию о ней. |
* Обязательный параметр/опция.
Поля
Имя |
Тип |
Описание |
Менеджер событий. Унаследовано от IEventEmitter. |
События
Имя |
Описание |
Плеер закрыт пользователем или уничтожен с помощью метода panorama.Player.destroy. |
|
Сменилось направление взгляда. |
|
В процессе работы плеера возникла ошибка. При этом пользователю будет показан соответствующий экран. |
|
Плеер перешел в полноэкранный режим. |
|
Плеер вышел из полноэкранного режима. |
|
Пользователь кликнул по раскрытому маркеру. Имена полей, доступных через метод Event.get:
|
|
Пользователь кликнул по свернутому маркеру. Имена полей, доступных через метод Event.get:
|
|
На маркер наведен указатель мыши. Имена полей, доступных через метод Event.get:
|
|
Пользователь сместил указатель мыши за пределы маркера. Имена полей, доступных через метод Event.get:
|
|
Сменилась открытая панорама (например, в результате вызова функции panorama.Player.setPanorama или пользовательского действия). |
|
Сменился размер поля обзора. |
Методы
Имя |
Возвращает |
Описание |
destroy() |
Уничтожает плеер. |
|
Проверяет размер контейра плеера и, если он изменился с последней проверки, перестраивает изображение. |
||
Number[] |
Возвращает текущее направление обзора в формате |
|
Возвращает панораму, которая открыта в плеере на данный момент. |
||
getSpan() |
Number[] |
Возвращает текущие угловые размеры поля обзора в формате |
Поворачивает обзор так, чтобы в центре поля зрения оказалась переданная точка. |
||
Ищет панорамy по заданным параметрам и открывает ее. |
||
Устанавливает новое направление обзора. |
||
Открывает в плеере переданную панораму. |
||
Устанавливает новые размеры поля обзора. |
Описание событий
destroy
Плеер закрыт пользователем или уничтожен с помощью метода panorama.Player.destroy.
directionchange
Сменилось направление взгляда.
error
В процессе работы плеера возникла ошибка. При этом пользователю будет показан соответствующий экран.
fullscreenenter
Плеер перешел в полноэкранный режим.
fullscreenexit
Плеер вышел из полноэкранного режима.
markercollapse
Пользователь кликнул по раскрытому маркеру. Имена полей, доступных через метод Event.get:
- marker – маркер, который был свернут.
markerexpand
Пользователь кликнул по свернутому маркеру. Имена полей, доступных через метод Event.get:
- marker – маркер, который был развернут.
markermouseenter
На маркер наведен указатель мыши. Имена полей, доступных через метод Event.get:
- marker – маркер, на который был наведен указатель мыши.
markermouseleave
Пользователь сместил указатель мыши за пределы маркера. Имена полей, доступных через метод Event.get:
- marker – маркер, с которого был убран указатель мыши.
panoramachange
Сменилась открытая панорама (например, в результате вызова функции panorama.Player.setPanorama или пользовательского действия).
spanchange
Сменился размер поля обзора.
Описание методов
destroy
{} destroy()
Уничтожает плеер.
fitToViewport
{} fitToViewport()
Проверяет размер контейра плеера и, если он изменился с последней проверки, перестраивает изображение.
getDirection
{Number[]} getDirection()
Возвращает текущее направление обзора в формате [bearing, pitch]
, где bearing
— азимут направления в градусах, pitch
— угол подъема над линией горизонта в градусах.
getPanorama
{IPanorama} getPanorama()
Возвращает открытую панораму в плеере.
getSpan
{Number[]} getSpan()
Возвращает текущие угловые размеры поля обзора в формате [horizontalSpan, verticalSpan]
, где horizontalSpan
— горизонтальный размер поля в градусах, verticalSpan
— вертикальный размер в градусах.
lookAt
{panorama.Player} lookAt(point)
Поворачивает обзор так, чтобы в центре поля зрения оказалась переданная точка.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Number[] Точка, на которую будет повернут обзор. Может быть представлена в виде массива двух или трех координат. Первые две координаты интерпретируются как географические координаты точки. Если переданы три координаты, то третья интерпретируется как высота точки относительно панорамы в метрах. |
* Обязательный параметр/опция.
moveTo
{vow.Promise} moveTo(point[, options])
Ищет панорамy по заданным параметрам и открывает ее.
Возвращает объект-обещание, который будет разрешен, если панорама найдена и успешно открыта в плеере, или отклонен с описанием ошибки в ином случае.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Number[] Точка, около которой будет произведен поиск панорамы. |
|
— |
Тип: Object Опции. |
|
'auto' |
Тип: Number[]|String Направление взгляда в формате |
|
'yandex#panorama' |
Тип: String Слой, в котором будет произведен поиск панорамы. Доступны два слоя:
|
|
'auto' |
Тип: Number[]|String Угловые размеры поля обзора в формате |
* Обязательный параметр/опция.
setDirection
{panorama.Player} setDirection(direction)
Устанавливает новое направление обзора.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Number[]|String Направление взгляда в формате |
* Обязательный параметр/опция.
setPanorama
{panorama.Player} setPanorama(panorama)
Открывает в плеере переданную панораму.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: IPanorama Панорама. |
* Обязательный параметр/опция.
setSpan
{panorama.Player} setSpan(span)
Устанавливает новые размеры поля обзора.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: Number[]|String Угловые размеры поля обзора в формате |
* Обязательный параметр/опция.
Обязательный параметр.