Class MagnetometerService

Magnetometer Service

Hierarchy

TypedDispatcher<MagnetometerEvents, this>
- MagnetometerService

Methods

addEventListener

addEventListener<K>(type, listener): void
Type Parameters
- K extends keyof MagnetometerEvents
Parameters
- type: K
- listener: ((event: CustomEvent<MagnetometerEvents[K]>) => void)
  - - (event): void
    - Parameters
      event: CustomEvent<MagnetometerEvents[K]>
      Returns void
Returns void
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).addEventListener
- Defined in src/event-dispatcher.ts:32

addListener

addListener<K>(event, listener): this
Type Parameters
- K extends keyof MagnetometerEvents
Parameters
- event: K
- listener: ((data: MagnetometerEvents[K]) => void)
  - - (data): void
    - Parameters
      data: MagnetometerEvents[K]
      Returns void
Returns this
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).addListener
- Defined in src/event-dispatcher.ts:36

calibrate

calibrate(): Promise<void>
Request magnetometer calibration

Returns Promise<void>
- Defined in src/services/magnetometer.ts:148

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: CustomEvent<MagnetometerEvents>
Returns boolean
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).dispatchEvent
- Defined in src/event-dispatcher.ts:34
dispatchEvent<K>(type, detail): boolean
Type Parameters
- K extends keyof MagnetometerEvents
Parameters
- type: K
- detail: MagnetometerEvents[K]
Returns boolean
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).dispatchEvent
- Defined in src/event-dispatcher.ts:35

emit

emit<K>(event, data): boolean
Type Parameters
- K extends keyof MagnetometerEvents
Parameters
- event: K
- data: MagnetometerEvents[K]
Returns boolean
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).emit
- Defined in src/event-dispatcher.ts:46

eventNames

eventNames<K>(): K[]
Type Parameters
- K extends keyof MagnetometerEvents
Returns K[]
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).eventNames
- Defined in src/event-dispatcher.ts:47

getMagnetometerPeriod

getMagnetometerPeriod(): Promise<MagnetometerPeriod>
Get magnetometer sample period

Returns Promise<MagnetometerPeriod>
- Defined in src/services/magnetometer.ts:174

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).getMaxListeners
- Defined in src/event-dispatcher.ts:50

listenerCount

listenerCount<K>(type): number
Type Parameters
- K extends keyof MagnetometerEvents
Parameters
- type: K
Returns number
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).listenerCount
- Defined in src/event-dispatcher.ts:48

listeners

listeners<K>(event): Function[]
Type Parameters
- K extends keyof MagnetometerEvents
Parameters
- event: K
Returns Function[]
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).listeners
- Defined in src/event-dispatcher.ts:45

off

off<K>(event, listener): this
Type Parameters
- K extends keyof MagnetometerEvents
Parameters
- event: K
- listener: ((data: MagnetometerEvents[K]) => void)
  - - (data): void
    - Parameters
      data: MagnetometerEvents[K]
      Returns void
Returns this
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).off
- Defined in src/event-dispatcher.ts:39

on

on<K>(event, listener): this
Type Parameters
- K extends keyof MagnetometerEvents
Parameters
- event: K
- listener: ((data: MagnetometerEvents[K]) => void)
  - - (data): void
    - Parameters
      data: MagnetometerEvents[K]
      Returns void
Returns this
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).on
- Defined in src/event-dispatcher.ts:37

once

once<K>(event, listener): this
Type Parameters
- K extends keyof MagnetometerEvents
Parameters
- event: K
- listener: ((data: MagnetometerEvents[K]) => void)
  - - (data): void
    - Parameters
      data: MagnetometerEvents[K]
      Returns void
Returns this
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).once
- Defined in src/event-dispatcher.ts:38

prependListener

prependListener<K>(event, listener): this
Type Parameters
- K extends keyof MagnetometerEvents
Parameters
- event: K
- listener: ((data: MagnetometerEvents[K]) => void)
  - - (data): void
    - Parameters
      data: MagnetometerEvents[K]
      Returns void
Returns this
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).prependListener
- Defined in src/event-dispatcher.ts:40

prependOnceListener

prependOnceListener<K>(event, listener): this
Type Parameters
- K extends keyof MagnetometerEvents
Parameters
- event: K
- listener: ((data: MagnetometerEvents[K]) => void)
  - - (data): void
    - Parameters
      data: MagnetometerEvents[K]
      Returns void
Returns this
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).prependOnceListener
- Defined in src/event-dispatcher.ts:41

rawListeners

rawListeners<K>(event): Function[]
Type Parameters
- K extends keyof MagnetometerEvents
Parameters
- event: K
Returns Function[]
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).rawListeners
- Defined in src/event-dispatcher.ts:52

readMagnetometerBearing

readMagnetometerBearing(): Promise<undefined | number>
Read magnetometer bearing

Returns Promise<undefined | number>
- Defined in src/services/magnetometer.ts:163

readMagnetometerData

readMagnetometerData(): Promise<MagnetometerData>
Read magnetometer data

Returns Promise<MagnetometerData>
- Defined in src/services/magnetometer.ts:155

removeAllListeners

removeAllListeners<K>(event?): this
Type Parameters
- K extends keyof MagnetometerEvents
Parameters
- Optionalevent: K
Returns this
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).removeAllListeners
- Defined in src/event-dispatcher.ts:43

removeEventListener

removeEventListener<K>(type, callback): void
Type Parameters
- K extends keyof MagnetometerEvents
Parameters
- type: K
- callback: ((event: CustomEvent<MagnetometerEvents[K]>) => void)
  - - (event): void
    - Parameters
      event: CustomEvent<MagnetometerEvents[K]>
      Returns void
Returns void
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).removeEventListener
- Defined in src/event-dispatcher.ts:33

removeListener

removeListener<K>(event, listener): this
Type Parameters
- K extends keyof MagnetometerEvents
Parameters
- event: K
- listener: ((data: MagnetometerEvents[K]) => void)
  - - (data): void
    - Parameters
      data: MagnetometerEvents[K]
      Returns void
Returns this
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).removeListener
- Defined in src/event-dispatcher.ts:42

setMagnetometerPeriod

setMagnetometerPeriod(frequency): Promise<void>
Set magnetometer sample period
Parameters
- frequency: MagnetometerPeriod
  The frequency interval to use
Returns Promise<void>
- Defined in src/services/magnetometer.ts:183

setMaxListeners

setMaxListeners(n): this
Parameters
- n: number
Returns this
Inherited from (EventDispatcher as new() => TypedDispatcher<MagnetometerEvents>).setMaxListeners
- Defined in src/event-dispatcher.ts:49

Class MagnetometerService

Hierarchy

Index

Methods

Methods

addEventListener

Type Parameters

Parameters

Parameters

Returns void

Returns void

addListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

calibrate

Returns Promise<void>

dispatchEvent

Parameters

Returns boolean

Type Parameters

Parameters

Returns boolean

emit

Type Parameters

Parameters

Returns boolean

eventNames

Type Parameters

Returns K[]

getMagnetometerPeriod

Returns Promise<MagnetometerPeriod>

getMaxListeners

Returns number

listenerCount

Type Parameters

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns Function[]

off

Type Parameters

Parameters

Parameters

Returns void

Returns this

on

Type Parameters

Parameters

Parameters

Returns void

Returns this

once

Type Parameters

Parameters

Parameters

Returns void

Returns this

prependListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

prependOnceListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

rawListeners

Type Parameters

Parameters

Returns Function[]

readMagnetometerBearing

Returns Promise<undefined | number>