BlueDotLayer | Mappedin Web SDK

Blue Dot Layer used for controlling the Blue Dot and listening to Blue Dot state change and position update events. Use the on-method to set listeners for TBlueDotStateChange and TBlueDotPositionUpdate events.

Hierarchy

PubSub<E_BLUEDOT_EVENT_PAYLOAD, E_BLUEDOT_EVENT>
- BlueDotLayer

Index

Methods

disable

disable(): void

Disables Blue Dot and stops emitting events.

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 extends 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 extends 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

Hierarchy

Index

Methods

Methods

disable

Returns void

enable

Parameters

Optional options: TEnableBlueDotOptions

Returns void

off

Type Parameters

EVENT_NAME extends keyof E_BLUEDOT_EVENT_PAYLOAD

Parameters

eventName: EVENT_NAME

fn: ((payload: E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME]) => void)

Parameters

payload: E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME]

Returns void

Returns void

on

Type Parameters

EVENT_NAME extends 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)

Parameters

payload: E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME] extends { data: null } ? any[any]["data"] : E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME]

Returns void

Returns void