Photo Sphere Viewer
    Preparing search index...

    Type Alias VirtualTourNode

    Definition of a single node in the tour

    type VirtualTourNode = {
        caption?: string;
        data?: any;
        description?: string;
        gps?: GpsPosition;
        id: string;
        links?: VirtualTourLink[];
        map?: false | Partial<Point> & Omit<MapHotspot, "id" | "yaw" | "distance">;
        markers?: (MarkerConfig & { gps?: GpsPosition })[];
        name?: string;
        panoData?: PanoData | PanoDataProvider;
        panorama: any;
        plan?: false | Omit<PlanHotspot, "id" | "coordinates">;
        showInGallery?: boolean;
        sphereCorrection?: SphereCorrection;
        thumbnail?: string;
    }
    Index

    Properties

    caption?: string

    caption visible in the navbar

    data?: any

    Any custom data you want to attach to the node

    description?: string

    description visible in the side panel

    GPS position

    id: string
    links?: VirtualTourLink[]

    links to other nodes

    map?: false | Partial<Point> & Omit<MapHotspot, "id" | "yaw" | "distance">

    configuration of the hotspot when using the MapPlugin set to false to hide this node from the map

    markers?: (MarkerConfig & { gps?: GpsPosition })[]

    additional markers to use on this node

    name?: string

    short name of the node (links tooltip, gallery)

    data used for this panorama

    panorama: any
    plan?: false | Omit<PlanHotspot, "id" | "coordinates">

    configuration of the hotspot when using the PlanPlugin set to false to hide this node from the plan

    showInGallery?: boolean

    display this node in the gallery (if the plugin is loaded)

    true
    
    sphereCorrection?: SphereCorrection

    sphere correction to apply to this panorama

    thumbnail?: string

    thumbnail for the gallery, also use in the tooltip