Class GetStateDataObject

constructor

• new GetStateDataObject(
      index: number,
      name: string,
      unit: string,
      offset: string,
      gain: string,
      measure: string,
  ): GetStateDataObject

  Passthru all parameters to GetStateDataObject.set.

  Parameters

  • index: number

    Column id/index

  • name: string

    Column or data portion name

  • unit: string

    Column or data portion unit (if applicable in any way)

  • offset: string

    Column value offset

  • gain: string

    Column value gain

  • measure: string

    Column value raw measurement

  Returns GetStateDataObject

active

category

categoryId

displayValue

gain

id

label

offset

raw

unit

value

forFields

• forFields(callback: (field: string) => void): void

  Iterate all fields of this object.

  Parameters

  • callback: (field: string) => void

    A user-defined callback.

  Returns void

set

• set(
      index: number,
      name: string,
      unit: string,
      offset: string,
      gain: string,
      measure: string,
  ): void

  Set object values based on the raw input values.

  The input values correspond to the data rows of the represented column (except the index paramter which indeed is the column id/index itself).

  Parameters

  • index: number

    Column id/index

  • name: string

    Column or data portion name

  • unit: string

    Column or data portion unit (if applicable in any way)

  • offset: string

    Column value offset

  • gain: string

    Column value gain

  • measure: string

    Column value raw measurement

  Returns void