Type alias CompassPluginConfig

CompassPluginConfig: {
    backgroundSvg?: string;
    className?: string;
    coneColor?: string;
    hotspotColor?: string;
    hotspots?: CompassHotspot[];
    navigation?: boolean;
    navigationColor?: string;
    position?: string | [string, string];
    size?: string;
}

Type declaration

  • Optional backgroundSvg?: string

    SVG used as background of the compass

  • Optional className?: string

    CSS class(es) added to the compass element.

  • Optional coneColor?: string

    color of the cone of the compass

    Default

    'rgba(255, 255, 255, 0.5)'
  • Optional hotspotColor?: string

    default color of hotspots

    Default

    'rgba(0, 0, 0, 0.5)'
  • Optional hotspots?: CompassHotspot[]

    small dots visible on the compass (will contain every marker with the "compass" data)

  • Optional navigation?: boolean

    allows to click on the compass to rotate the viewer

    Default

    true
  • Optional navigationColor?: string

    color of the navigation cone

    Default

    'rgba(255, 0, 0, 0.2)'
  • Optional position?: string | [string, string]

    position of the compass

    Default

    'top left'
  • Optional size?: string

    size of the compass

    Default

    '120px'

Settings

Member Visibility

Theme

Generated using TypeDoc