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;
    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;
}

Type declaration

  • Optionalbuttons?: {
        close?: boolean;
        maximize?: boolean;
        north?: boolean;
        reset?: boolean;
    }

    Configuration of map buttons

    • Optionalclose?: boolean

      Default

      true
    • Optionalmaximize?: boolean

      Default

      true
    • Optionalnorth?: boolean

      Default

      true
    • Optionalreset?: boolean

      Default

      true
  • Optionalcenter?: Point

    The position of the panorama on the map

  • OptionalconeColor?: string

    Color of the cone of the compass

    Default

    '#1E78E6'
  • OptionalconeSize?: number

    Size of the cone of the compass

    Default

    40
  • OptionaldefaultZoom?: number

    Default zoom level

    Default

    100
  • Optionalhotspots?: MapHotspot[]

    Points of interest on the map

  • OptionalimageUrl?: string

    URL of the map

  • OptionalmaxZoom?: number

    Maximum zoom level

    Default

    200
  • OptionalminimizeOnHotspotClick?: boolean

    Always minimize the map when an hotspot/marker is clicked

  • OptionalminZoom?: number

    Minimum zoom level

    Default

    20
  • OptionaloverlayImage?: string

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

  • OptionalpinImage?: string

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

  • OptionalpinSize?: number

    Size of the central pin

    Default

    35
  • Optionalposition?: string | [string, string]

    Position of the map

    Default

    'bottom left'
  • Optionalrotation?: string | number

    Rotation to apply to the image

    Default

    0
  • Optionalshape?: "round" | "square"

    Default

    'round'
  • Optionalsize?: string

    Size of the map

    Default

    '200px'
  • OptionalspotStyle?: MapHotspotStyle

    Default style of hotspots

  • Optionalstatic?: boolean

    Make the map static and rotate the pin instead

    Default

    false
  • OptionalvisibleOnLoad?: boolean

    Displays the map when loading the first panorama

    Default

    true

Settings

Member Visibility