Type Alias TBlueDotOptions

TBlueDotOptions: {
    accuracyRing?: {
        color?: string;
        opacity?: number;
    };
    color?: string;
    debug?: boolean;
    heading?: {
        color?: string;
        opacity?: number;
    };
    inactiveColor?: string;
    radius?: number;
    timeout?: number;
    watchBrowserPosition?: boolean;
}

Type declaration

  • OptionalaccuracyRing?: {
        color?: string;
        opacity?: number;
    }

    Options for the accuracy ring around the BlueDot.

    • Optionalcolor?: string

      The color of the accuracy ring.

      Default

      #2266ff
    • Optionalopacity?: number

      The opacity of the accuracy ring.

      Default

      0.3
  • Optionalcolor?: string

    The color of the BlueDot core element.

    Default

    #2266ff
  • Optionaldebug?: boolean

    Whether to log debug messages.

    Default

    false
  • Optionalheading?: {
        color?: string;
        opacity?: number;
    }

    Options for the heading directional indicator.

    • Optionalcolor?: string

      The color of the heading cone.

      Default

      #2266ff
    • Optionalopacity?: number

      The opacity of the heading cone.

      Default

      0.7
  • OptionalinactiveColor?: string

    The color of the BlueDot when it has timed out and gone inactive.

    Default

    #808080
  • Optionalradius?: number

    The radius of the BlueDot in pixels. The BlueDot will maintain this size clamped to a minimum of 0.35 metres.

    Default

    10
  • Optionaltimeout?: number

    The duration of the timeout in milliseconds. If the BlueDot does not receive a position update within this time, it will grey out until a position is received.

    Default

    30000
  • OptionalwatchBrowserPosition?: boolean

    Whether to watch the browser's position.

    Default

    true

Settings

Member Visibility