Type alias MapPluginConfig

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

Type declaration

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

    Configuration of map buttons

    • Optional close?: boolean

      Default

      true
      
    • Optional maximize?: boolean

      Default

      true
      
    • Optional north?: boolean

      Default

      true
      
    • Optional reset?: boolean

      Default

      true
      
  • Optional center?: Point

    The position of the panorama on the map

  • Optional coneColor?: string

    Color of the cone of the compass

    Default

    '#1E78E6'
    
  • Optional coneSize?: number

    Size of the cone of the compass

    Default

    40
    
  • Optional defaultZoom?: number

    Default zoom level

    Default

    100
    
  • Optional hotspots?: MapHotspot[]

    Points of interest on the map

  • Optional imageUrl?: string

    URL of the map

  • Optional maxZoom?: number

    Maximum zoom level

    Default

    200
    
  • Optional minZoom?: number

    Minimum zoom level

    Default

    20
    
  • Optional overlayImage?: string

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

  • Optional pinImage?: string

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

  • Optional pinSize?: number

    Size of the central pin

    Default

    35
    
  • Optional position?: string | [string, string]

    Position of the map

    Default

    'bottom left'
    
  • Optional rotation?: string | number

    Rotation to apply to the image

    Default

    0
    
  • Optional size?: string

    Size of the map

    Default

    '200px'
    
  • Optional spotStyle?: MapHotspotStyle

    Default style of hotspots

  • Optional static?: boolean

    Make the map static and rotate the pin instead

    Default

    false
    
  • Optional visibleOnLoad?: boolean

    Displays the map when loading the first panorama

    Default

    true
    

Generated using TypeDoc