Class BlueDotLayer

Hierarchy

PubSub<E_BLUEDOT_EVENT_PAYLOAD, E_BLUEDOT_EVENT>
- BlueDotLayer

Index

Methods

Methods

disable

disable(): void

Disable BlueDot

Returns void

enable

enable(options?: TEnableBlueDotOptions): void

Enables Blue Dot. BlueDot then emits TBlueDotStateChange and TBlueDotPositionUpdate events via E_BLUEDOT_EVENT

Parameters
- Optional options: TEnableBlueDotOptions
Returns void

off

off<EVENT_NAME>(eventName: EVENT_NAME, fn: (payload: E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME]) => void): void

Inherited from PubSub.off

Type parameters
- EVENT_NAME: keyof E_BLUEDOT_EVENT_PAYLOAD
Parameters
- eventName: EVENT_NAME
- fn: (payload: E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME]) => void
  - - (payload: E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME]): void
    - Parameters
      - payload: E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME]
      Returns void
Returns void

on

on<EVENT_NAME>(eventName: EVENT_NAME, fn: (payload: E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME] extends { data: null } ? any[any]["data"] : E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME]) => void): void

Inherited from PubSub.on

Type parameters
- EVENT_NAME: E_BLUEDOT_EVENT
Parameters
- eventName: EVENT_NAME
- fn: (payload: E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME] extends { data: null } ? any[any]["data"] : E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME]) => void
  - - (payload: E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME] extends { data: null } ? any[any]["data"] : E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME]): void
    - Parameters
      - payload: E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME] extends { data: null } ? any[any]["data"] : E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME]
      Returns void
Returns void