Photo Sphere Viewer
    Preparing search index...

    Type Alias PlanPluginConfig

    type PlanPluginConfig = {
        bearing?: string | number;
        buttons?: { close?: boolean; maximize?: boolean; reset?: boolean };
        configureLeaflet?: (map: Map) => void;
        coordinates?: GpsPosition;
        defaultZoom?: number;
        hotspots?: PlanHotspot[];
        layers?: PlanLayer[];
        minimizeOnHotspotClick?: boolean;
        pinImage?: string;
        pinSize?: number;
        position?: string | [string, string];
        size?: CssSize;
        spotStyle?: PlanHotspotStyle;
        visibleOnLoad?: boolean;
    }
    Index

    Properties

    bearing?: string | number

    Rotation offset to apply to the central pin

    0
    
    buttons?: { close?: boolean; maximize?: boolean; reset?: boolean }

    Configuration of map buttons

    Type declaration

    • Optionalclose?: boolean
      true
      
    • Optionalmaximize?: boolean
      true
      
    • Optionalreset?: boolean
      true
      
    configureLeaflet?: (map: Map) => void

    Let you configure Leaflet from scratch

    coordinates?: GpsPosition

    GPS position of the current panorama

    defaultZoom?: number

    Default zoom level

    15
    
    hotspots?: PlanHotspot[]

    Points of interest on the map

    layers?: PlanLayer[]

    Define the available layers

    OpenStreetMap
    
    minimizeOnHotspotClick?: boolean

    Always minimize the map when an hotspot/marker is clicked

    pinImage?: string

    SVG or image URL used for the central pin (must be square)

    pinSize?: number

    Size of the central pin

    35
    
    position?: string | [string, string]

    Position of the map

    'bottom left'
    
    size?: CssSize

    Size of the map

    '300px * 200px'
    
    spotStyle?: PlanHotspotStyle

    Default style of hotspots

    visibleOnLoad?: boolean

    Displays the map when loading the first panorama

    true