Photo Sphere Viewer
    Preparing search index...

    Type Alias ViewerConfig

    Viewer configuration

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

    type 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";
        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;
    }
    Index

    Properties

    adapter? canvasBackground? caption? container defaultPitch? defaultTransition? defaultYaw? defaultZoomLvl? description? downloadName? downloadUrl? fisheye? keyboard? keyboardActions? lang? loadingImg? loadingTxt? maxFov? minFov? mousemove? mousewheel? mousewheelCtrlKey? moveInertia? moveSpeed? navbar? panoData? panorama? plugins? rendererParameters? requestHeaders? size? sphereCorrection? touchmoveTwoFingers? withCredentials? zoomSpeed?

    Properties

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

    container size

    sphereCorrection?: SphereCorrection

    0,0,0

    touchmoveTwoFingers?: boolean
    false
    withCredentials?: boolean
    false
    zoomSpeed?: number
    1

    Settings

    Member Visibility

    On This Page

    Properties