Type Alias ViewerConfig

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

Viewer configuration

Type declaration

Optionaladapter?: AdapterConstructor | [AdapterConstructor, any]
Default
```
equirectangular
```
OptionalcanvasBackground?: string
Default
```
'#000'
```
Optionalcaption?: string
Default
```
null
```
container: HTMLElement | string
OptionaldefaultPitch?: number | string
Default
```
0
```

`Optional`defaultTransition?: TransitionOptions

Default

'{ speed: 1500, rotation: true, effect: "fade" }'

OptionaldefaultYaw?: number | string
Default
```
0
```
OptionaldefaultZoomLvl?: number
Default
```
50
```
Optionaldescription?: string
Default
```
null
```
OptionaldownloadName?: string
Default
```
null
```
OptionaldownloadUrl?: string
Default
```
null
```
Optionalfisheye?: boolean | number
Default
```
false
```
Optionalkeyboard?:
    | boolean
    | "always"
    | "fullscreen"
    | Record<string, ACTIONS | (viewer: Viewer) => void>
OptionalkeyboardActions?: Record<string, ACTIONS | (viewer: Viewer, e: KeyboardEvent) => void>
Optionallang?: Record<string, string>
OptionalloadingImg?: string
Default
```
null
```
OptionalloadingTxt?: string
Default
```
'Loading...'
```
OptionalmaxFov?: number
Default
```
90
```
OptionalminFov?: number
Default
```
30
```
Optionalmousemove?: boolean
Default
```
true
```
Optionalmousewheel?: boolean
Default
```
true
```
OptionalmousewheelCtrlKey?: boolean
Default
```
false
```
OptionalmoveInertia?: boolean | number
Default
```
0.8
```
OptionalmoveSpeed?: number
Default
```
1
```
Optionalnavbar?: boolean | string | (string | NavbarCustomButton)[]
Default
```
'zoom move download description caption fullscreen'
```
OptionalpanoData?: PanoData | PanoDataProvider
Optionalpanorama?: any
Optionalplugins?: (PluginConstructor | [PluginConstructor, any])[]
OptionalrendererParameters?: WebGLRendererParameters
Default
```
'{ alpha: true, antialias: true }'
```
OptionalrequestHeaders?: Record<string, string> | (url: string) => Record<string, string>
Optionalsize?: CssSize
Default
container size
OptionalsphereCorrection?: SphereCorrection
Default
0,0,0
OptionaltouchmoveTwoFingers?: boolean
Default
```
false
```
OptionalwithCredentials?: boolean
Default
```
false
```
OptionalzoomSpeed?: number
Default
```
1
```

See

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

Type Alias ViewerConfig

Type declaration

Optionaladapter?: AdapterConstructor | [AdapterConstructor, any]

Default

OptionalcanvasBackground?: string

Default

Optionalcaption?: string

Default

container: HTMLElement | string

OptionaldefaultPitch?: number | string

Default

OptionaldefaultTransition?: TransitionOptions

Default

OptionaldefaultYaw?: number | string

Default

OptionaldefaultZoomLvl?: number

Default

Optionaldescription?: string

Default

OptionaldownloadName?: string

Default

OptionaldownloadUrl?: string

Default

Optionalfisheye?: boolean | number

Default

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

OptionalkeyboardActions?: Record<string, ACTIONS | (viewer: Viewer, e: KeyboardEvent) => void>

Optionallang?: Record<string, string>

OptionalloadingImg?: string

Default

OptionalloadingTxt?: string

Default

OptionalmaxFov?: number

Default

OptionalminFov?: number

Default

Optionalmousemove?: boolean

Default

Optionalmousewheel?: boolean

Default

OptionalmousewheelCtrlKey?: boolean

Default

OptionalmoveInertia?: boolean | number

Default

OptionalmoveSpeed?: number

Default

Optionalnavbar?: boolean | string | (string | NavbarCustomButton)[]

Default

OptionalpanoData?: PanoData | PanoDataProvider

Optionalpanorama?: any

Optionalplugins?: (PluginConstructor | [PluginConstructor, any])[]

OptionalrendererParameters?: WebGLRendererParameters

Default

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

Optionalsize?: CssSize

Default

OptionalsphereCorrection?: SphereCorrection

Default

OptionaltouchmoveTwoFingers?: boolean

Default

OptionalwithCredentials?: boolean

Default

OptionalzoomSpeed?: number

Default

See

Settings

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

`Optional`canvasBackground?: string

`Optional`caption?: string

`Optional`defaultPitch?: number | string

`Optional`defaultTransition?: TransitionOptions

`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: Viewer) => void>

`Optional`keyboardActions?: Record<string, ACTIONS | (viewer: Viewer, e: KeyboardEvent) => 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 | number

`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: string) => Record<string, string>

`Optional`size?: CssSize

`Optional`sphereCorrection?: SphereCorrection

`Optional`touchmoveTwoFingers?: boolean

`Optional`withCredentials?: boolean

`Optional`zoomSpeed?: number