Type alias PlanPluginConfig

Type declaration

• Optional bearing?: string | number

  Rotation offset to apply to the central pin

  Default

  0
  Copy

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

  Configuration of map buttons

  • Optional close?: boolean

    Default

    true
    Copy

  • Optional maximize?: boolean

    Default

    true
    Copy

  • Optional reset?: boolean

    Default

    true
    Copy

• Optional configureLeaflet?: ((map) => void)

  • • (map): void

    • Let you configure Leaflet from scratch

      Parameters

      • map: Map

      Returns void

• Optional coordinates?: GpsPosition

  GPS position of the current panorama

• Optional defaultZoom?: number

  Default zoom level

  Default

  15
  Copy

• Optional hotspots?: PlanHotspot[]

  Points of interest on the map

• Optional layers?: PlanLayer[]

  Define the available layers

  Default

  OpenStreetMap
  Copy

• 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
  Copy

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

  Position of the map

  Default

  'bottom left'
  Copy

• Optional size?: CssSize

  Size of the map

  Default

  '300px * 200px'
  Copy

• Optional spotStyle?: PlanHotspotStyle

  Default style of hotspots

• Optional visibleOnLoad?: boolean

  Displays the map when loading the first panorama

  Default

  true
  Copy