Skip to main content

getAuxHeartRateValue

FitFileViewer - API Documentation v30.0.1


FitFileViewer - API Documentation / utils/data/processing/auxHeartRateUtils / getAuxHeartRateValue

Function: getAuxHeartRateValue()

getAuxHeartRateValue(row: DataRecord, options?: { fieldDescriptionMesgs?: readonly unknown[]; recordMesgs?: DataRecord[]; resolution?: AuxHeartRateResolution; }): number | null

Defined in: utils/data/processing/auxHeartRateUtils.ts:493

Gets an auxiliary heart rate value from a single record.

Parameters​

row​

DataRecord

FIT record message.

options?​

Optional record context and precomputed resolution.

fieldDescriptionMesgs?​

readonly unknown[]

recordMesgs?​

DataRecord[]

resolution?​

AuxHeartRateResolution

Returns​

number | null

The auxiliary heart rate value, or null when unavailable.