---
metadata:
  - name: generator
    content: Diplodoc Platform v5.64.2
alternate:
  - https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/panorama.Player.md
  - https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md
  - href: https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.com/dev/jsapi-v2-1/doc/ru/llms.txt?revision=r21950234
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/jsapi-v2-1/doc/ru/llms.txt?revision=r21950234

# panorama.Player

Расширяет [IEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md).

Класс для создания и управления плеером панорам.

[Конструктор](#constructor-summary) | [Поля ](#properties-summary) | [События ](#events-summary) | [Методы ](#methods-summary)

## Конструктор {#constructor-summary}

```javascript
panorama.Player(element, panorama[, options])
```

Создает экземпляр плеера панорам.

**Параметры:**

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`element`](#param-element)[*](*star) | — | Тип: HTMLElement\|String

Ссылка на HTML-элемент, в котором будет размещен плеер, или идентификатор этого HTML-элемента. ||
|| [`panorama`](#param-panorama)[*](*star) | — | Тип: [IPanorama](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPanorama.md)

Панорама, которая будет открыта в созданном плеере. ||
|| [`options`](#param-options) | — | Тип: Object

Опции. ||
|| [`options.autoFitToViewport`](#param-options.autoFitToViewport) | "always" | Тип: String

Опция, позволяющая отключить автоматическое слежение за размером контейнера плеера. По умолчанию плеер всегда следит за размером своего контейнера, перестраивая изображение, если они изменились. Доступные значения:
- `none` – не отслеживать изменения размеров контейнера.
- `ifNull` – как только контейнер получит CSS значение 'display', отличное от «none», плеер автоматически подстроит свои размеры под это значение. После отслеживание будет остановлено.
- `always` – всегда отслеживать изменения размеров контейнера. ||
|| [`options.controls`](#param-options.controls) | — | Тип: String[]

Набор контролов плеера. Доступные контролы:
- `closeControl` – кнопка для закрытия плеера.
- `fullscreenControl` – кнопка перевода плеера в полноэкранный режим.
- `panoramaName` – название панорамы (автоматически скрывается в плеере маленького размера).
- `zoomControl` – кнопки для управления масштабом панорамы.
Набор контролов по умолчанию включает в себя все вышеперечисленные. ||
|| [`options.direction`](#param-options.direction) | 'auto' | Тип: Number[]\|String

Направление взгляда в формате `[bearing, pitch]`, где `bearing` – азимут направления в градусах, `pitch` – угол подъема над линией горизонта в градусах. Специальное строковое значение `auto` означает, что после открытия панорамы будет применено направление, указанное в метаданных панорамы. ||
|| [`options.hotkeysEnabled`](#param-options.hotkeysEnabled) | false | Тип: Boolean

Опция, включающая управление плеером с клавиатуры. Обратите внимание, что при включении плеер начинает перехватывать нажатия некоторых клавиш (например, курсорных), отменяя при это реакцию браузера по умолчанию, что может мешать пользователю взаимодействовать с вашей страницей. Поэтому по умолчанию управление с клавиатуры выключено. ||
|| [`options.scrollZoomBehavior`](#param-options.scrollZoomBehavior) | true | Тип: Boolean

Опция, позволяющая отключить масштабирование панорамы колесом мыши. По умолчаню включено, и плеер перехватывает события колеса мыши. ||
|| [`options.span`](#param-options.span) | 'auto' | Тип: Number[]\|String

Угловые размеры поля обзора в формате `[horizontalSpan, verticalSpan]`, где `horizontalSpan` — горизонтальный размер поля, `verticalSpan` — вертикальный. ||
|| [`options.suppressMapOpenBlock`](#param-options.suppressMapOpenBlock) | false | Тип: Boolean

Нужно ли скрывать предложение открыть текущую панораму в Яндекс Картах, максимально сохранив всю имеющуюся информацию о ней. `true` — скрывать, `false` — не скрывать. Ссылка на Яндекс Карты отображается в левом верхнем углу плеера. ||
|#

\* Обязательный параметр/опция.

## Поля {#properties-summary}

#|
|| **Имя** | **Тип** | **Описание** ||
||  [events](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventManager.md) | Менеджер событий.

Унаследовано от [IEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events). ||
|#

## События {#events-summary}

#|
|| **Имя** | **Описание** ||
|| [destroy](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#event-destroy) | Плеер закрыт пользователем или уничтожен с помощью метода panorama.Player.destroy. ||
|| [directionchange](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#event-directionchange) | Сменилось направление взгляда. ||
|| [error](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#event-error) | В процессе работы плеера возникла ошибка. При этом пользователю будет показан соответствующий экран. ||
|| [fullscreenenter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#event-fullscreenenter) | Плеер перешел в полноэкранный режим. ||
|| [fullscreenexit](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#event-fullscreenexit) | Плеер вышел из полноэкранного режима. ||
|| [markercollapse](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#event-markercollapse) | Пользователь кликнул по раскрытому маркеру. Имена полей, доступных через метод [Event.get](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- marker – маркер, который был свернут. ||
|| [markerexpand](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#event-markerexpand) | Пользователь кликнул по свернутому маркеру. Имена полей, доступных через метод [Event.get](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- marker – маркер, который был развернут. ||
|| [markermouseenter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#event-markermouseenter) | На маркер наведен указатель мыши. Имена полей, доступных через метод [Event.get](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- marker – маркер, на который был наведен указатель мыши. ||
|| [markermouseleave](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#event-markermouseleave) | Пользователь сместил указатель мыши за пределы маркера. Имена полей, доступных через метод [Event.get](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- marker – маркер, с которого был убран указатель мыши. ||
|| [panoramachange](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#event-panoramachange) | Сменилась открытая панорама (например, в результате вызова функции panorama.Player.setPanorama или пользовательского действия). ||
|| [spanchange](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#event-spanchange) | Сменился размер поля обзора. ||
|#

## Методы {#methods-summary}

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [destroy](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#destroy)() | | Уничтожает плеер. ||
|| [fitToViewport](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#fitToViewport)() | | Проверяет размер контейра плеера и, если он изменился с последней проверки, перестраивает изображение. ||
|| [getDirection](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#getDirection)() | Number[] | Возвращает текущее направление обзора в формате `[bearing, pitch]`, где `bearing` — азимут направления в градусах, `pitch` — угол подъема над линией горизонта в градусах. ||
|| [getPanorama](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#getPanorama)() | [IPanorama](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPanorama.md) | Возвращает панораму, которая открыта в плеере на данный момент. ||
|| [getSpan](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#getSpan)() | Number[] | Возвращает текущие угловые размеры поля обзора в формате `[horizontalSpan, verticalSpan]`, где `horizontalSpan` — горизонтальный размер поля в градусах, `verticalSpan` — вертикальный размер в градусах. ||
|| [lookAt](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#lookAt)([point](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#lookAt-param-point)) | [panorama.Player](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md) | Поворачивает обзор так, чтобы в центре поля зрения оказалась переданная точка. ||
|| [moveTo](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#moveTo)([point](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#moveTo-param-point)[, [options](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#moveTo-param-options)]) | [vow.Promise](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Ищет панорамy по заданным параметрам и открывает ее. ||
|| [setDirection](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#setDirection)([direction](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#setDirection-param-direction)) | [panorama.Player](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md) | Устанавливает новое направление обзора. ||
|| [setPanorama](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#setPanorama)([panorama](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#setPanorama-param-panorama)) | [panorama.Player](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md) | Открывает в плеере переданную панораму. ||
|| [setSpan](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#setSpan)([span](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md#setSpan-param-span)) | [panorama.Player](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/panorama.Player.md) | Устанавливает новые размеры поля обзора. ||
|#

## Описание событий {#event_detail}

### destroy {#destroy}

Плеер закрыт пользователем или уничтожен с помощью метода panorama.Player.destroy.

### directionchange {#directionchange}

Сменилось направление взгляда.

### error {#error}

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

### fullscreenenter {#fullscreenenter}

Плеер перешел в полноэкранный режим.

### fullscreenexit {#fullscreenexit}

Плеер вышел из полноэкранного режима.

### markercollapse {#markercollapse}

Пользователь кликнул по раскрытому маркеру. Имена полей, доступных через метод [Event.get](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- marker – маркер, который был свернут.

### markerexpand {#markerexpand}

Пользователь кликнул по свернутому маркеру. Имена полей, доступных через метод [Event.get](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- marker – маркер, который был развернут.

### markermouseenter {#markermouseenter}

На маркер наведен указатель мыши. Имена полей, доступных через метод [Event.get](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- marker – маркер, на который был наведен указатель мыши.

### markermouseleave {#markermouseleave}

Пользователь сместил указатель мыши за пределы маркера. Имена полей, доступных через метод [Event.get](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- marker – маркер, с которого был убран указатель мыши.

### panoramachange {#panoramachange}

Сменилась открытая панорама (например, в результате вызова функции panorama.Player.setPanorama или пользовательского действия).

### spanchange  {#spanchange}

Сменился размер поля обзора.

## Описание методов {#method_detail}

### destroy {#destroy}

```javascript
{} destroy()
```

Уничтожает плеер.
# fitToViewport

```javascript
{} fitToViewport()
```

Проверяет размер контейра плеера и, если он изменился с последней проверки, перестраивает изображение.

### getDirection {#getDirection}

```javascript
{Number[]} getDirection()
```

**Возвращает** текущее направление обзора в формате `[bearing, pitch]`, где `bearing` — азимут направления в градусах, `pitch` — угол подъема над линией горизонта в градусах.

### getPanorama {#getPanorama}

```javascript
{IPanorama} getPanorama()
```

**Возвращает** открытую панораму в плеере.

### getSpan {#getSpan}

```javascript
{Number[]} getSpan()
```

**Возвращает** текущие угловые размеры поля обзора в формате `[horizontalSpan, verticalSpan]`, где `horizontalSpan` — горизонтальный размер поля в градусах, `verticalSpan` — вертикальный размер в градусах.

### lookAt {#lookAt}

```javascript
{panorama.Player} lookAt(point)
```

Поворачивает обзор так, чтобы в центре поля зрения оказалась переданная точка.

**Возвращает** ссылку на себя.

**Параметры:**

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`point`](#lookAt-param-point)[*](*star) | — | Тип: Number[]

Точка, на которую будет повернут обзор. Может быть представлена в виде массива двух или трех координат. Первые две координаты интерпретируются как географические координаты точки. Если переданы три координаты, то третья интерпретируется как высота точки относительно панорамы в метрах. ||
|#

\* Обязательный параметр/опция.

### moveTo {#moveTo}

```javascript
{vow.Promise} moveTo(point[, options])
```

Ищет панорамy по заданным параметрам и открывает ее.

**Возвращает** объект-обещание, который будет разрешен, если панорама найдена и успешно открыта в плеере, или отклонен с описанием ошибки в ином случае.

**Параметры:**

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`point`](#moveTo-param-point)[*](*star) | — | Тип: Number[]

Точка, около которой будет произведен поиск панорамы. ||
|| [`options`](#moveTo-param-options) | — | Тип: Object

Опции. ||
|| [`options.direction`](#moveTo-param-options.direction) | 'auto' | Тип: Number[]\|String

Направление взгляда в формате `[bearing, pitch]`, где `bearing` – азимут направления в градусах, `pitch` – угол подъема над линией горизонта в градусах. Специальное строковое значение `auto` означает, что после открытия панорамы будет применено направление, указанное в метаданных панорамы. ||
|| [`options.layer`](#moveTo-param-options.layer) | 'yandex#panorama' | Тип: String

Слой, в котором будет произведен поиск панорамы. Доступны два слоя:
- 'yandex#panorama' – панорамы на земле;
- 'yandex#airPanorama' – воздушные панорамы. ||
|| [`options.span`](#moveTo-param-options.span) | 'auto' | Тип: Number[]\|String

Угловые размеры поля обзора в формате `[horizontalSpan, verticalSpan]`, где `horizontalSpan` – горизонтальный размер поля, `verticalSpan` – вертикальный. ||
|#

\* Обязательный параметр/опция.
# setDirection

```javascript
{panorama.Player} setDirection(direction)
```

Устанавливает новое направление обзора.

**Возвращает** ссылку на себя.

**Параметры:**

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`direction`](#setDirection-param-direction)[*](*star) | — | Тип: Number[]\|String

Направление взгляда в формате `[bearing, pitch]`, где `bearing` – азимут направления в градусах, `pitch` – угол подъема над линией горизонта в градусах. Специальное строковое значение `auto` означает, что после открытия панорамы будет применено направление, указанное в метаданных панорамы. ||
|#

\* Обязательный параметр/опция.

### setPanorama {#setPanorama}

```javascript
{panorama.Player} setPanorama(panorama)
```

Открывает в плеере переданную панораму.

**Возвращает** ссылку на себя.

**Параметры:**

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`panorama`](#setPanorama-param-panorama)[*](*star) | — | Тип: [IPanorama](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPanorama.md)

Панорама. ||
|#

\* Обязательный параметр/опция.

### setSpan {#setSpan}

```javascript
{panorama.Player} setSpan(span)
```

Устанавливает новые размеры поля обзора.

**Возвращает** ссылку на себя.

**Параметры:**

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`span`](#setSpan-param-span)[*](*star) | — | Тип: Number[]\|String

Угловые размеры поля обзора в формате `[horizontalSpan, verticalSpan]`, где `horizontalSpan` — горизонтальный размер поля, `verticalSpan` — вертикальный. ||
|#

\* Обязательный параметр/опция.

<!-- XLIFF_FARM_OWIzYmE4_CACHING -->

[*star]: Обязательный параметр.