Photo Sphere Viewer
    Preparing search index...

    Type Alias VirtualTourPluginConfig

    type VirtualTourPluginConfig = {
        arrowsPosition?: {
            linkOverlapAngle?: number;
            linkPitchOffset?: number;
            maxPitch?: number;
            minPitch?: number;
        };
        arrowStyle?: VirtualTourArrowStyle;
        dataMode?: "client"
        | "server";
        getLinkTooltip?: (
            content: string,
            link: VirtualTourLink,
            node: VirtualTourNode,
        ) => string;
        getNode?: (nodeId: string) => VirtualTourNode | Promise<VirtualTourNode>;
        linksOnCompass?: boolean;
        map?: {
            extent?: [number, number, number, number];
            imageUrl: string;
            size?: Size;
        };
        nodes?: VirtualTourNode[];
        positionMode?: "manual"
        | "gps";
        preload?:
            | boolean
            | ((node: VirtualTourNode, link: VirtualTourLink) => boolean);
        renderMode?: "3d" | "2d";
        showLinkTooltip?: boolean;
        startNodeId?: string;
        transitionOptions?:
            | Pick<
                VirtualTourTransitionOptions,
                "showLoader"
                | "speed"
                | "effect"
                | "rotation",
            >
            | (
                (
                    toNode: VirtualTourNode,
                    fromNode?: VirtualTourNode,
                    fromLink?: VirtualTourLink,
                ) => VirtualTourTransitionOptions
            );
    }
    Index

    Properties

    arrowsPosition? arrowStyle? dataMode? getLinkTooltip? getNode? linksOnCompass? map? nodes? positionMode? preload? renderMode? showLinkTooltip? startNodeId? transitionOptions?

    Properties

    arrowsPosition?: {
        linkOverlapAngle?: number;
        linkPitchOffset?: number;
        maxPitch?: number;
        minPitch?: number;
    }

    configuration of the arrows container

    Type declaration

    • OptionallinkOverlapAngle?: number

      (3D mode) Make transparent links that are close to each other

      PI/4
    • OptionallinkPitchOffset?: number

      (2D+GPS mode) vertical offset applied to link markers, to compensate for viewer height

      -0.1
    • OptionalmaxPitch?: number

      (3D mode) Maximal vertical view angle

      PI/2
    • OptionalminPitch?: number

      (3D mode) Minimal vertical view angle

      0.3
    arrowStyle?: VirtualTourArrowStyle

    global arrow style

    dataMode?: "client" | "server"

    configure data mode

    'client'
    getLinkTooltip?: (
        content: string,
        link: VirtualTourLink,
        node: VirtualTourNode,
    ) => string

    callback to modify the content of the tooltip

    getNode?: (nodeId: string) => VirtualTourNode | Promise<VirtualTourNode>

    function to fetch a node (server mode)

    linksOnCompass?: boolean

    if the Compass plugin is enabled, displays the links on the compass

    true
    map?: {
        extent?: [number, number, number, number];
        imageUrl: string;
        size?: Size;
    }

    special configuration when using the MapPlugin

    Type declaration

    • Optionalextent?: [number, number, number, number]

      bounds of the map in GPS coordinates (minX, minY, maxX, maxY)

    • imageUrl: string

      URL of the map

    • Optionalsize?: Size

      size of the map in pixels

    nodes?: VirtualTourNode[]

    initial nodes (client mode)

    positionMode?: "manual" | "gps"

    configure positioning mode

    'manual'
    preload?: boolean | ((node: VirtualTourNode, link: VirtualTourLink) => boolean)

    preload linked panoramas

    renderMode?: "3d" | "2d"

    configure rendering mode of links

    '3d'
    showLinkTooltip?: boolean

    display a tooltip on each link, by default it contains "name" + "thumbnail" + "caption"

    true
    startNodeId?: string

    id of the initial node, if not defined the first node will be used

    transitionOptions?:
        | Pick<
            VirtualTourTransitionOptions,
            "showLoader"
            | "speed"
            | "effect"
            | "rotation",
        >
        | (
            (
                toNode: VirtualTourNode,
                fromNode?: VirtualTourNode,
                fromLink?: VirtualTourLink,
            ) => VirtualTourTransitionOptions
        )

    Configuration of the transition between nodes. Can be a callback.

    { showLoader: true, speed: '20rpm', effect: 'fade', rotation: true }

    Settings

    Member Visibility

    On This Page

    Properties