Class DataSpeed

A typed metric value. Data objects retain the canonical metric type and unit alongside their value.

Hierarchy (View Summary)

DataNumber
- DataSpeed

Index

Constructors

Properties

value displayType? type unit unitSystem

Methods

getDisplayType getDisplayUnit getDisplayValue getType getUnit getUnitSystem getValue isValueTypeValid setValue toJSON

Constructors

constructor

new DataSpeed(value: number): DataSpeed
Parameters
- value: number
Returns DataSpeed
Inherited from DataNumber.constructor
- Defined in src/data/data.number.ts:4

Properties

`Protected`value

value: number

`Static` `Optional`displayType

displayType?: string

`Static`type

type: string = 'Speed'

`Static`unit

unit: string = 'm/s'

`Static`unitSystem

unitSystem: UnitSystem = UnitSystem.Metric

Methods

getDisplayType

getDisplayType(): string
Returns string
Inherited from DataNumber.getDisplayType
- Defined in src/data/data.ts:58

getDisplayUnit

getDisplayUnit(): string
Returns string
Inherited from DataNumber.getDisplayUnit
- Defined in src/data/data.ts:54

getDisplayValue

getDisplayValue(): string
Returns string
Overrides DataNumber.getDisplayValue
- Defined in src/data/data.speed.ts:21

getType

getType(): string
Returns string
Inherited from DataNumber.getType
- Defined in src/data/data.ts:46

getUnit

getUnit(): string
Returns string
Inherited from DataNumber.getUnit
- Defined in src/data/data.ts:50

getUnitSystem

getUnitSystem(): UnitSystem
Returns UnitSystem
Inherited from DataNumber.getUnitSystem
- Defined in src/data/data.ts:62

getValue

getValue(formatForDataType?: string): number
Parameters
- OptionalformatForDataType: string
Returns number
Overrides DataNumber.getValue
- Defined in src/data/data.speed.ts:25

isValueTypeValid

isValueTypeValid(value: any): boolean
Parameters
- value: any
Returns boolean
Inherited from DataNumber.isValueTypeValid
- Defined in src/data/data.number.ts:13

setValue

setValue(value: number): this
Parameters
- value: number
Returns this
Inherited from DataNumber.setValue
- Defined in src/data/data.ts:23

toJSON

toJSON(): DataJSONInterface
Returns DataJSONInterface
Inherited from DataNumber.toJSON
- Defined in src/data/data.ts:78