Interface LoggingDataValue

interface LoggingDataValue {
    getUnit(): string;
    getValue():
        | null
        | string
        | number
        | boolean;
    setDecimals(newDecimals: number): void;
    setFactor(newFactor: number): void;
    setUnit(newUnit: string): void;
    toString(): string;
}

Index

Methods

getUnit getValue setDecimals setFactor setUnit toString

Methods

getUnit

getUnit(): string
Get the values unit of measurement

Returns string

getValue

getValue():
    | null
    | string
    | number
    | boolean
Get the raw data value

Returns
    | null
    | string
    | number
    | boolean

setDecimals

setDecimals(newDecimals): void
Set the amount of decimals used when using toString
Parameters
- newDecimals: number
  amount of decimals to use
Returns void

setFactor

setFactor(newFactor): void
Set the value factor

This method only has effect on getFactor
Parameters
- newFactor: number
Returns void
Deprecated
This method does not change the value. A new query should be created with the new factor

setUnit

setUnit(newUnit): void
Overwrite the unit of measurement. Use in toString
Parameters
- newUnit: string
  new unit to use
Returns void

toString

toString(): string
Get a pretty printed version of the data value. This includes the unit and uses the set amount of decimals

Returns string