Photo Sphere Viewer
    Preparing search index...

    Type Alias CompassPluginConfig

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

    Properties

    backgroundSvg? className? coneColor? hotspotColor? hotspots? navigation? navigationColor? position? resetPitch? size?

    Properties

    backgroundSvg?: string

    SVG used as background of the compass

    className?: string

    CSS class(es) added to the compass element.

    coneColor?: string

    color of the cone of the compass

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

    default color of hotspots

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

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

    navigation?: boolean

    allows to click on the compass to rotate the viewer

    true
    navigationColor?: string

    color of the navigation cone

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

    position of the compass

    'top left'
    resetPitch?: boolean

    Reset viewer pitch to defaultPitch when using the compass navigation

    false
    size?: string

    size of the compass

    '120px'

    Settings

    Member Visibility

    On This Page

    Properties