Type Alias CompassPluginConfig

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

Type declaration

  • OptionalbackgroundSvg?: string

    SVG used as background of the compass

  • OptionalclassName?: string

    CSS class(es) added to the compass element.

  • OptionalconeColor?: string

    color of the cone of the compass

    Default

    'rgba(255, 255, 255, 0.5)'
  • OptionalhotspotColor?: string

    default color of hotspots

    Default

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

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

  • Optionalnavigation?: boolean

    allows to click on the compass to rotate the viewer

    Default

    true
  • OptionalnavigationColor?: string

    color of the navigation cone

    Default

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

    position of the compass

    Default

    'top left'
  • OptionalresetPitch?: boolean

    Reset viewer pitch to defaultPitch when using the compass navigation

    Default

    false
  • Optionalsize?: string

    size of the compass

    Default

    '120px'

Settings

Member Visibility