Photo Sphere Viewer
    Preparing search index...

    Type Alias MapPluginConfig

    type MapPluginConfig = {
        buttons?: {
            close?: boolean;
            maximize?: boolean;
            north?: boolean;
            reset?: boolean;
        };
        center?: Point;
        coneColor?: string;
        coneSize?: number;
        defaultZoom?: number;
        hotspots?: MapHotspot[];
        imageUrl?: string;
        maxZoom?: number;
        minimizeOnHotspotClick?: boolean;
        minZoom?: number;
        overlayImage?: string;
        pinImage?: string;
        pinSize?: number;
        position?: string
        | [string, string];
        rotation?: string | number;
        shape?: "round" | "square";
        size?: string;
        spotStyle?: MapHotspotStyle;
        static?: boolean;
        visibleOnLoad?: boolean;
    }
    Index

    Properties

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

    Configuration of map buttons

    Type declaration

    • Optionalclose?: boolean
      true
      
    • Optionalmaximize?: boolean
      true
      
    • Optionalnorth?: boolean
      true
      
    • Optionalreset?: boolean
      true
      
    center?: Point

    The position of the panorama on the map

    coneColor?: string

    Color of the cone of the compass

    '#1E78E6'
    
    coneSize?: number

    Size of the cone of the compass

    40
    
    defaultZoom?: number

    Default zoom level

    100
    
    hotspots?: MapHotspot[]

    Points of interest on the map

    imageUrl?: string

    URL of the map

    maxZoom?: number

    Maximum zoom level

    200
    
    minimizeOnHotspotClick?: boolean

    Always minimize the map when an hotspot/marker is clicked

    minZoom?: number

    Minimum zoom level

    20
    
    overlayImage?: string

    SVG or image URL drawn on top of the map (must be square)

    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'
    
    rotation?: string | number

    Rotation to apply to the image

    0
    
    shape?: "round" | "square"
    'round'
    
    size?: string

    Size of the map

    '200px'
    
    spotStyle?: MapHotspotStyle

    Default style of hotspots

    static?: boolean

    Make the map static and rotate the pin instead

    false
    
    visibleOnLoad?: boolean

    Displays the map when loading the first panorama

    true