Type Alias UseDataVariableHookResult<V>

Type Declaration

• maxValue: { formatted: Formatted; raw: number | undefined }

  • formatted: Formatted

    Value, formatted with correct number format, enums and translations applied. Should be used when displaying values to the user.

  • raw: number | undefined

    The raw unformatted variable value.

    Can be used in calculations. When displaying values to the user, you should prefer to use .formatted.

• minValue: { formatted: Formatted; raw: number | undefined }

  • formatted: Formatted

    Value, formatted with correct number format, enums and translations applied. Should be used when displaying values to the user.

  • raw: number | undefined

    The raw unformatted variable value.

    Can be used in calculations. When displaying values to the user, you should prefer to use .formatted.

• ranges: DataVariableDisplayRange[] | undefined

• status: DataVariableStatus | undefined

  Variable status if affected by ranges, otherwise undefined.

• unit: string | undefined

  Variable unit (if present)

• value: {
      formatted: Formatted;
      raw: ValueReturnType<V> | undefined;
      relative: number | undefined;
      untranslated: Formatted;
  }

  • formatted: Formatted

    Value, formatted with correct number format, enums and translations applied. Should be used when displaying values to the user.

  • raw: ValueReturnType<V> | undefined

    The raw unformatted variable value.

    Can be used in calculations. When displaying values to the user, you should prefer to use .formatted.

  • relative: number | undefined

    Relative value between 0–1.

    Only available for numeric values that have set minima and maxima.

  • untranslated: Formatted

    Value, formatted with correct number format and enums but without translations applied. Can for example be used when directly working with underlying enum values.

• formatValue: function

  • formatValue(value: number): Formatted

    Format a given value using this variable's meta data

    Parameters

    • value: number

    Returns Formatted