Type Alias VirtualTourPluginConfig

VirtualTourPluginConfig: {
    arrowPosition?: "top" | "bottom";
    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;
    };
    markerPitchOffset?: number;
    markerStyle?: VirtualTourMarkerStyle;
    nodes?: VirtualTourNode[];
    positionMode?: "manual"
    | "gps";
    preload?:
        | boolean
        | (node: VirtualTourNode, link: VirtualTourLink) => boolean;
    renderMode?: "3d" | "2d" | "markers";
    showLinkTooltip?: boolean;
    startNodeId?: string;
    transitionOptions?:
        | Pick<
            VirtualTourTransitionOptions,
            "showLoader"
            | "speed"
            | "effect"
            | "fadeIn"
            | "rotation",
        >
        | (
            toNode: VirtualTourNode,
            fromNode?: VirtualTourNode,
            fromLink?: VirtualTourLink,
        ) => VirtualTourTransitionOptions;
}

Type declaration

  • OptionalarrowPosition?: "top" | "bottom"

    Deprecated

  • OptionalarrowsPosition?: {
        linkOverlapAngle?: number;
        linkPitchOffset?: number;
        maxPitch?: number;
        minPitch?: number;
    }

    configuration of the arrows container

    • OptionallinkOverlapAngle?: number

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

      Default

      PI/4
    • OptionallinkPitchOffset?: number

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

      Default

      -0.1
    • OptionalmaxPitch?: number

      (3D mode) Maximal vertical view angle

      Default

      PI/2
    • OptionalminPitch?: number

      (3D mode) Minimal vertical view angle

      Default

      0.3
  • OptionalarrowStyle?: VirtualTourArrowStyle

    global arrow style

  • OptionaldataMode?: "client" | "server"

    configure data mode

    Default

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

    callback to modify the content of the tooltip

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

    function to fetch a node (server mode)

  • OptionallinksOnCompass?: boolean

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

    Default

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

    special configuration when using the MapPlugin

    • 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

  • OptionalmarkerPitchOffset?: number

    Deprecated

  • OptionalmarkerStyle?: VirtualTourMarkerStyle

    Deprecated

  • Optionalnodes?: VirtualTourNode[]

    initial nodes (client mode)

  • OptionalpositionMode?: "manual" | "gps"

    configure positioning mode

    Default

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

    preload linked panoramas

  • OptionalrenderMode?: "3d" | "2d" | "markers"

    configure rendering mode of links

    Default

    '3d'
  • OptionalshowLinkTooltip?: boolean

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

    Default

    true
  • OptionalstartNodeId?: string

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

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

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

    Default

    { showLoader: true, speed: '20rpm', fadeIn: true, rotation: true }

Settings

Member Visibility