@serenity-is/corelib / Aggregators / WeightedAvg
Class: WeightedAvg
Defined in: src/slick/aggregators.ts:68
Weighted average given a value field and a weight field.
Implements
Constructors
Constructor
new WeightedAvg(
field,weightedField):WeightedAvg
Defined in: src/slick/aggregators.ts:79
Creates a new weighted average aggregator.
Parameters
field
string
The value field name.
weightedField
string
The weight field name.
Returns
WeightedAvg
Properties
field
readonlyfield:string
Defined in: src/slick/aggregators.ts:79
The value field name.
sum
sum:
number
Defined in: src/slick/aggregators.ts:70
Weighted sum of values.
weightedField
readonlyweightedField:string
Defined in: src/slick/aggregators.ts:80
The weight field name.
weightedSum
weightedSum:
number
Defined in: src/slick/aggregators.ts:72
Sum of weights.
aggregateKey
readonlystaticaggregateKey:"weightedAvg"="weightedAvg"
Defined in: src/slick/aggregators.ts:120
Key used to store/lookup this aggregator in totals.
Accessors
displayName
Get Signature
get
staticdisplayName():string
Defined in: src/slick/aggregators.ts:122
Localized display name for this aggregator.
Returns
string
Methods
accumulate()
accumulate(
item):void
Defined in: src/slick/aggregators.ts:90
Accumulates a single item into the aggregator state.
Parameters
item
any
Row item to accumulate; both value and weight fields must contain valid numeric values.
Returns
void
Implementation of
init()
init():
void
Defined in: src/slick/aggregators.ts:84
Initializes state before a new group is processed.
Returns
void
Implementation of
storeResult()
storeResult(
groupTotals):void
Defined in: src/slick/aggregators.ts:101
Writes computed totals into the group totals object.
Parameters
groupTotals
any
Totals container to write the computed weighted average into, keyed by field name.
Returns
void
Implementation of
isValid()
staticisValid(val):boolean
Defined in: src/slick/aggregators.ts:115
Checks if a value is valid for aggregation.
Parameters
val
any
The value to check.
Returns
boolean
True if valid.