Type Alias PlanPluginConfig

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

Type declaration

  • Optionalbearing?: string | number

    Rotation offset to apply to the central pin

    Default

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

    Configuration of map buttons

    • Optionalclose?: boolean

      Default

      true
    • Optionalmaximize?: boolean

      Default

      true
    • Optionalreset?: boolean

      Default

      true
  • OptionalconfigureLeaflet?: ((map: Map) => void)

    Let you configure Leaflet from scratch

      • (map): void

      • Parameters

        • map: Map

        Returns void

  • Optionalcoordinates?: GpsPosition

    GPS position of the current panorama

  • OptionaldefaultZoom?: number

    Default zoom level

    Default

    15
  • Optionalhotspots?: PlanHotspot[]

    Points of interest on the map

  • Optionallayers?: PlanLayer[]

    Define the available layers

    Default

    OpenStreetMap
  • OptionalminimizeOnHotspotClick?: boolean

    Always minimize the map when an hotspot/marker is clicked

  • 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'
  • Optionalsize?: CssSize

    Size of the map

    Default

    '300px * 200px'
  • OptionalspotStyle?: PlanHotspotStyle

    Default style of hotspots

  • OptionalvisibleOnLoad?: boolean

    Displays the map when loading the first panorama

    Default

    true

Settings

Member Visibility