Type Alias TBlueDotOptions

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
    Copy

  • Optionalopacity?: number

    The opacity of the accuracy ring.

    Default

    0.3
    Copy

• Optionalcolor?: string

  The color of the BlueDot core element.

  Default

  #2266ff
  Copy

• Optionaldebug?: boolean

  Whether to log debug messages.

  Default

  false
  Copy

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

  Options for the heading directional indicator.

  • Optionalcolor?: string

    The color of the heading cone.

    Default

    #2266ff
    Copy

  • Optionalopacity?: number

    The opacity of the heading cone.

    Default

    0.7
    Copy

• OptionalinactiveColor?: string

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

  Default

  #808080
  Copy

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

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

• OptionalwatchDevicePosition?: boolean

  Whether to watch the device's position.

  Default

  true
  Copy