# Interface: PlayerPano
PixellotPlayer.PlayerPano
# Hierarchy
-
↳
PlayerPano
# Table of contents
# Methods
- getD3ExtentData
- getPan
- getZoom
- isFullPano
- panBy
- panTo
- panToCenter
- switchToPanoMode
- zoomBy
- zoomIn
- zoomOut
- zoomTo
# Methods
# getD3ExtentData
▸ getD3ExtentData(): undefined | ID3ExtentData
# Returns
undefined | ID3ExtentData
# getPan
▸ getPan(): Object
Get the current x/y translation
current x/y translation
player.getPan(); // { x, y }
# Returns
Object
| Name | Type |
|---|---|
x | number |
y | number |
# Inherited from
# getZoom
▸ getZoom(): number
Get the current value of zoom in video
# Returns
number
zoom - point on which video is zoomed
player.getZoom(); // 1
# Inherited from
# isFullPano
▸ isFullPano(): boolean
# Returns
boolean
# panBy
▸ panBy(x, y, transition?): void
Pans the video in player by the given x and y coordinates, which are relative to the existing ones.
# Parameters
| Name | Type | Description |
|---|---|---|
x | number | axisX coordinate |
y | number | axisY coordinate |
transition? | number | transition duration (default is 750) // Translates the video in player to 50px, 100px player.panBy(50, 100) |
# Returns
void
# Inherited from
# panTo
▸ panTo(x, y): void
Pans the video in player by the given x and y coordinates, which are relative to the existing ones without transition effects.
# Parameters
| Name | Type | Description |
|---|---|---|
x | number | |
y | number | player.panTo(400, 200); |
# Returns
void
# Inherited from
# panToCenter
▸ panToCenter(): void
# Returns
void
# Inherited from
# switchToPanoMode
▸ switchToPanoMode(mode): void
# Parameters
| Name | Type |
|---|---|
mode | PanoMode |
# Returns
void
# zoomBy
▸ zoomBy(zoomFactor, transition?): void
Zooms the video by the given zoomFactor
# Parameters
| Name | Type | Description |
|---|---|---|
zoomFactor | number | |
transition? | number | transition duration (default is 750) player.getZoom(); // 1 player.zoomBy(2.2); player.getZoom(); // 2.2 |
# Returns
void
# Inherited from
# zoomIn
▸ zoomIn(): void
Zooms in the video on zoomFactor (default is 30 percents)
# Returns
void
# Inherited from
# zoomOut
▸ zoomOut(): void
Zooms out the video on zoomFactor (default is 30 percents)
# Returns
void
# Inherited from
# zoomTo
▸ zoomTo(zoomLevel, transition?): void
Zooms the video to the given zoomFactor
# Parameters
| Name | Type | Description |
|---|---|---|
zoomLevel | number | - |
transition? | number | transition duration (default is 750) player.zoomTo(2); |
# Returns
void