Type alias ViewerConfig

ViewerConfig: {
    adapter?: AdapterConstructor | [AdapterConstructor, any];
    caption?: string;
    container: HTMLElement | string;
    defaultPitch?: number | string;
    defaultYaw?: number | string;
    defaultZoomLvl?: number;
    description?: string;
    downloadName?: string;
    downloadUrl?: string;
    fisheye?: boolean | number;
    keyboard?: boolean | "always" | "fullscreen" | Record<string, ACTIONS | ((viewer) => void)>;
    keyboardActions?: Record<string, ACTIONS | ((viewer) => void)>;
    lang?: Record<string, string>;
    loadingImg?: string;
    loadingTxt?: string;
    maxFov?: number;
    minFov?: number;
    mousemove?: boolean;
    mousewheel?: boolean;
    mousewheelCtrlKey?: boolean;
    moveInertia?: boolean;
    moveSpeed?: number;
    navbar?: boolean | string | (string | NavbarCustomButton)[];
    panoData?: PanoData | PanoDataProvider;
    panorama?: any;
    plugins?: (PluginConstructor | [PluginConstructor, any])[];
    rendererParameters?: WebGLRendererParameters;
    requestHeaders?: Record<string, string> | ((url) => Record<string, string>);
    size?: CssSize;
    sphereCorrection?: SphereCorrection;
    touchmoveTwoFingers?: boolean;
    withCredentials?: boolean;
    zoomSpeed?: number;
}

Viewer configuration

Type declaration

Optional adapter?: AdapterConstructor | [AdapterConstructor, any]
Default
```
equirectangular
```
Optional caption?: string
Default
```
null
```
container: HTMLElement | string
Optional defaultPitch?: number | string
Default
```
0
```
Optional defaultYaw?: number | string
Default
```
0
```
Optional defaultZoomLvl?: number
Default
```
50
```
Optional description?: string
Default
```
null
```
Optional downloadName?: string
Default
```
null
```
Optional downloadUrl?: string
Default
```
null
```
Optional fisheye?: boolean | number
Default
```
false
```
Optional keyboard?: boolean | "always" | "fullscreen" | Record<string, ACTIONS | ((viewer) => void)>
Optional keyboardActions?: Record<string, ACTIONS | ((viewer) => void)>
Optional lang?: Record<string, string>
Optional loadingImg?: string
Default
```
null
```
Optional loadingTxt?: string
Default
```
'Loading...'
```
Optional maxFov?: number
Default
```
90
```
Optional minFov?: number
Default
```
30
```
Optional mousemove?: boolean
Default
```
true
```
Optional mousewheel?: boolean
Default
```
true
```
Optional mousewheelCtrlKey?: boolean
Default
```
false
```
Optional moveInertia?: boolean
Default
```
true
```
Optional moveSpeed?: number
Default
```
1
```
Optional navbar?: boolean | string | (string | NavbarCustomButton)[]
Default
```
'zoom move download description caption fullscreen'
```
Optional panoData?: PanoData | PanoDataProvider
Optional panorama?: any
Optional plugins?: (PluginConstructor | [PluginConstructor, any])[]
Optional rendererParameters?: WebGLRendererParameters
Default
```
'{ alpha: true, antialias: true }'
```
Optional requestHeaders?: Record<string, string> | ((url) => Record<string, string>)
Optional size?: CssSize

Default
container size
Optional sphereCorrection?: SphereCorrection

Default
0,0,0
Optional touchmoveTwoFingers?: boolean
Default
```
false
```
Optional withCredentials?: boolean
Default
```
false
```
Optional zoomSpeed?: number
Default
```
1
```

Link

https://photo-sphere-viewer.js.org/guide/config.html

Type alias ViewerConfig

Type declaration

Optional adapter?: AdapterConstructor | [AdapterConstructor, any]

Default

Optional caption?: string

Default

container: HTMLElement | string

Optional defaultPitch?: number | string

Default

Optional defaultYaw?: number | string

Default

Optional defaultZoomLvl?: number

Default

Optional description?: string

Default

Optional downloadName?: string

Default

Optional downloadUrl?: string

Default

Optional fisheye?: boolean | number

Default

Optional keyboard?: boolean | "always" | "fullscreen" | Record<string, ACTIONS | ((viewer) => void)>

Optional keyboardActions?: Record<string, ACTIONS | ((viewer) => void)>

Optional lang?: Record<string, string>

Optional loadingImg?: string

Default

Optional loadingTxt?: string

Default

Optional maxFov?: number

Default

Optional minFov?: number

Default

Optional mousemove?: boolean

Default

Optional mousewheel?: boolean

Default

Optional mousewheelCtrlKey?: boolean

Default

Optional moveInertia?: boolean

Default

Optional moveSpeed?: number

Default

Optional navbar?: boolean | string | (string | NavbarCustomButton)[]

Default

Optional panoData?: PanoData | PanoDataProvider

Optional panorama?: any

Optional plugins?: (PluginConstructor | [PluginConstructor, any])[]

Optional rendererParameters?: WebGLRendererParameters

Default

Optional requestHeaders?: Record<string, string> | ((url) => Record<string, string>)

Optional size?: CssSize

Default

Optional sphereCorrection?: SphereCorrection

Default

Optional touchmoveTwoFingers?: boolean

Default

Optional withCredentials?: boolean

Default

Optional zoomSpeed?: number

Default

Link

Settings

Member Visibility

Theme

`Optional` adapter?: AdapterConstructor | [AdapterConstructor, any]

`Optional` caption?: string

`Optional` defaultPitch?: number | string

`Optional` defaultYaw?: number | string

`Optional` defaultZoomLvl?: number

`Optional` description?: string

`Optional` downloadName?: string

`Optional` downloadUrl?: string

`Optional` fisheye?: boolean | number

`Optional` keyboard?: boolean | "always" | "fullscreen" | Record<string, ACTIONS | ((viewer) => void)>

`Optional` keyboardActions?: Record<string, ACTIONS | ((viewer) => void)>

`Optional` lang?: Record<string, string>

`Optional` loadingImg?: string

`Optional` loadingTxt?: string

`Optional` maxFov?: number

`Optional` minFov?: number

`Optional` mousemove?: boolean

`Optional` mousewheel?: boolean

`Optional` mousewheelCtrlKey?: boolean

`Optional` moveInertia?: boolean

`Optional` moveSpeed?: number

`Optional` navbar?: boolean | string | (string | NavbarCustomButton)[]

`Optional` panoData?: PanoData | PanoDataProvider

`Optional` panorama?: any

`Optional` plugins?: (PluginConstructor | [PluginConstructor, any])[]

`Optional` rendererParameters?: WebGLRendererParameters

`Optional` requestHeaders?: Record<string, string> | ((url) => Record<string, string>)

`Optional` size?: CssSize

`Optional` sphereCorrection?: SphereCorrection

`Optional` touchmoveTwoFingers?: boolean

`Optional` withCredentials?: boolean

`Optional` zoomSpeed?: number