Interface IAccelerometer

Since

0.1

Accelerometer is an interface for accessing accelerometer data on the device.

Example

import Accelerometer from '@smartface/native/device/accelerometer';
    Accelerometer.start();
    Accelerometer.onAccelerate = function(e) {
        console.log("x: " + e.x + "  y : " + e.y + "  z : " + e.z);
        if (event.z > 9) {
            Accelerometer.stop();
        }
    };

Hierarchy

default<AccelerometerEvents>
- IAccelerometer

Index

Properties

`Protected` _nativeObject

_nativeObject: any

start

start: (() => void)

Type declaration

- (): void
- Starts capturing accelerometer values.
  
  Method
  start
  
  Android
  
  Ios
  
  Since
  0.1
  
  Returns void

stop

stop: (() => void)

Type declaration

- (): void
- Stops capturing.
  
  Method
  stop
  
  Android
  
  Ios
  
  Since
  0.1
  
  Returns void

ios

ios: Partial<{ accelerometerUpdateInterval: number }>

Accessors

nativeObject

get nativeObject(): any
Returns any
Inherited from NativeEventEmitterComponent.nativeObject
- Defined in core/native-component.ts:11
set nativeObject(value: any): void
Parameters
- value: any
Returns void
Inherited from NativeEventEmitterComponent.nativeObject
- Defined in core/native-component.ts:15

android

get android(): TProps["android"]
Returns TProps["android"]
Inherited from NativeEventEmitterComponent.android
- Defined in core/native-mobile-component.ts:52

Methods

`Protected` `Abstract` createNativeObject

createNativeObject(params?: Partial<Record<string, any>>): any
Executed before everything. This should return nativeObject since it will be assinged directly to nativeObject.
Parameters
- Optional params: Partial<Record<string, any>>
Returns any
Inherited from NativeEventEmitterComponent.createNativeObject
- Defined in core/native-component.ts:33

`Protected` preConstruct

preConstruct(params?: Partial<Record<string, any>>): void
Parameters
- Optional params: Partial<Record<string, any>>
Returns void
Inherited from NativeEventEmitterComponent.preConstruct
- Defined in core/native-event-emitter-component.ts:27

`Protected` addAndroidProps

addAndroidProps(props: Partial<{ [key: string]: any }>): void
Parameters
- props: Partial<{ [key: string]: any }>
Returns void
Inherited from NativeEventEmitterComponent.addAndroidProps
- Defined in core/native-mobile-component.ts:43

`Protected` addIOSProps

addIOSProps(props: Partial<{ [key: string]: any }>): void
Parameters
- props: Partial<{ [key: string]: any }>
Returns void
Inherited from NativeEventEmitterComponent.addIOSProps
- Defined in core/native-mobile-component.ts:46

on

on(eventName: "accelerate", callback: ((e: { x: number; y: number; z: number }) => void)): (() => void)
Parameters
- eventName: "accelerate"
- callback: ((e: { x: number; y: number; z: number }) => void)
  - - (e: { x: number; y: number; z: number }): void
    - Parameters
      
      e: { x: number; y: number; z: number }
      
      x: number
      
      y: number
      
      z: number
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.on
- Defined in device/accelerometer/accelerometer.ts:63
on(eventName: "accelerate", callback: ((...args: any[]) => void)): (() => void)
Parameters
- eventName: "accelerate"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.on
- Defined in device/accelerometer/accelerometer.ts:64

off

off(eventName: "accelerate", callback: ((e: { x: number; y: number; z: number }) => void)): void
Parameters
- eventName: "accelerate"
- callback: ((e: { x: number; y: number; z: number }) => void)
  - - (e: { x: number; y: number; z: number }): void
    - Parameters
      
      e: { x: number; y: number; z: number }
      
      x: number
      
      y: number
      
      z: number
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.off
- Defined in device/accelerometer/accelerometer.ts:66
off(eventName: "accelerate", callback: ((...args: any[]) => void)): void
Parameters
- eventName: "accelerate"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.off
- Defined in device/accelerometer/accelerometer.ts:67

emit

emit(eventName: "accelerate", e: { x: number; y: number; z: number }): void
Parameters
- eventName: "accelerate"
- e: { x: number; y: number; z: number }
  - x: number
  - y: number
  - z: number
Returns void
Overrides NativeEventEmitterComponent.emit
- Defined in device/accelerometer/accelerometer.ts:69
emit(eventName: "accelerate", ...args: any[]): void
Parameters
- eventName: "accelerate"
- Rest ...args: any[]
Returns void
Overrides NativeEventEmitterComponent.emit
- Defined in device/accelerometer/accelerometer.ts:70

once

once(eventName: "accelerate", callback: ((e: { x: number; y: number; z: number }) => void)): (() => void)
Parameters
- eventName: "accelerate"
- callback: ((e: { x: number; y: number; z: number }) => void)
  - - (e: { x: number; y: number; z: number }): void
    - Parameters
      
      e: { x: number; y: number; z: number }
      
      x: number
      
      y: number
      
      z: number
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.once
- Defined in device/accelerometer/accelerometer.ts:72
once(eventName: "accelerate", callback: ((...args: any[]) => void)): (() => void)
Parameters
- eventName: "accelerate"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.once
- Defined in device/accelerometer/accelerometer.ts:73

prependListener

prependListener(eventName: "accelerate", callback: ((e: { x: number; y: number; z: number }) => void)): void
Parameters
- eventName: "accelerate"
- callback: ((e: { x: number; y: number; z: number }) => void)
  - - (e: { x: number; y: number; z: number }): void
    - Parameters
      
      e: { x: number; y: number; z: number }
      
      x: number
      
      y: number
      
      z: number
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependListener
- Defined in device/accelerometer/accelerometer.ts:75
prependListener(eventName: "accelerate", callback: ((...args: any[]) => void)): void
Parameters
- eventName: "accelerate"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependListener
- Defined in device/accelerometer/accelerometer.ts:76

prependOnceListener

prependOnceListener(eventName: "accelerate", callback: ((e: { x: number; y: number; z: number }) => void)): void
Parameters
- eventName: "accelerate"
- callback: ((e: { x: number; y: number; z: number }) => void)
  - - (e: { x: number; y: number; z: number }): void
    - Parameters
      
      e: { x: number; y: number; z: number }
      
      x: number
      
      y: number
      
      z: number
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependOnceListener
- Defined in device/accelerometer/accelerometer.ts:78
prependOnceListener(eventName: "accelerate", callback: ((...args: any[]) => void)): void
Parameters
- eventName: "accelerate"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependOnceListener
- Defined in device/accelerometer/accelerometer.ts:79

Events

onAccelerate

onAccelerate: ((e: { x: number; y: number; z: number }) => void)

Type declaration

- (e: { x: number; y: number; z: number }): void
- Callback to capture accelerometer events.
  
  Since
  0.1 onAccelerate
  
  Android
  
  Ios
  
  Deprecated
  
  Example
```
import AcceleroMeter from '@smartface/native/device/accelerometer';

AcceleroMeter.on(AcceleroMeter.Events.Accelerate, (params) => {
 console.info('onAccelerate', params);
});
```
  Parameters
  - e: { x: number; y: number; z: number }
    - x: number
    - y: number
    - z: number
  Returns void

Interface IAccelerometer

Since

Example

Hierarchy

Index

Properties

Accessors

Methods

Events

Properties

Protected _nativeObject

start

Type declaration

Method

Android

Ios

Since

Returns void

stop

Type declaration

Method

Android

Ios

Since

Returns void

ios

Accessors

nativeObject

Returns any

Parameters

value: any

Returns void

android

Returns TProps["android"]

Methods

Protected Abstract createNativeObject

Parameters

Optional params: Partial<Record<string, any>>

Returns any

Protected preConstruct

Parameters

Optional params: Partial<Record<string, any>>

Returns void

Protected addAndroidProps

Parameters

props: Partial<{ [key: string]: any }>

Returns void

Protected addIOSProps

Parameters

props: Partial<{ [key: string]: any }>

Returns void

on

Parameters

eventName: "accelerate"

callback: ((e: { x: number; y: number; z: number }) => void)

Parameters

e: { x: number; y: number; z: number }

x: number

y: number

z: number

Returns void

Returns (() => void)

Returns void

Parameters

eventName: "accelerate"

callback: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns (() => void)

Returns void

off

Parameters

eventName: "accelerate"

callback: ((e: { x: number; y: number; z: number }) => void)

Parameters

e: { x: number; y: number; z: number }

x: number

y: number

z: number

`Protected` _nativeObject

`Protected` `Abstract` createNativeObject

`Optional` params: Partial<Record<string, any>>

`Protected` preConstruct

`Optional` params: Partial<Record<string, any>>

`Protected` addAndroidProps

`Protected` addIOSProps

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]