@terascope/data-mate / column/aggregations

column/aggregations

Enumerations

Enumeration	Description
KeyAggregation	-
ValueAggregation	-

Interfaces

Interface	Description
FieldAgg	-

Type Aliases

KeyAggFn

KeyAggFn = (index) => object

Defined in: data-mate/src/column/aggregations.ts:209

Parameters

Parameter	Type
index	number

Returns

object

key

key: string | undefined

value

value: unknown

---

MakeKeyAggFn

MakeKeyAggFn = (col) => KeyAggFn

Defined in: data-mate/src/column/aggregations.ts:213

Parameters

Parameter	Type
col	Vector<unknown>

Returns

KeyAggFn

---

MakeValueAgg

MakeValueAgg = (vector) => FieldAgg

Defined in: data-mate/src/column/aggregations.ts:35

Parameters

Parameter	Type
vector	Vector<unknown>

Returns

FieldAgg

Variables

keyAggMap

const keyAggMap: Record<KeyAggregation, MakeKeyAggFn>

Defined in: data-mate/src/column/aggregations.ts:215

---

keyAggregationDescriptions

const keyAggregationDescriptions: object

Defined in: data-mate/src/column/aggregations.ts:222

Type Declaration

daily

daily: string = 'Group the data in daily buckets'

hourly

hourly: string = 'Group the data in hourly buckets'

monthly

monthly: string = 'Group the data in monthly buckets'

yearly

yearly: string = 'Group the data in yearly buckets'

---

valueAggMap

const valueAggMap: Record<ValueAggregation, MakeValueAgg>

Defined in: data-mate/src/column/aggregations.ts:37

---

valueAggregationDescriptions

const valueAggregationDescriptions: object

Defined in: data-mate/src/column/aggregations.ts:45

Type Declaration

avg

avg: string = 'Calculate the average value in a column'

count

count: string = 'Count all of the values in a column'

max

max: string = 'Find the maximum value in a column'

min

min: string = 'Find the minimum value in a column'

sum

sum: string = 'Add all of the values in a column together'

Functions

makeUniqueKeyAgg()

makeUniqueKeyAgg(vector, options?): KeyAggFn

Defined in: data-mate/src/column/aggregations.ts:243

Parameters

Parameter	Type
vector	Vector<any>
options?	SerializeOptions

Returns

KeyAggFn

---

runVectorAggregation()

runVectorAggregation<V>(vector, valueAgg): V

Defined in: data-mate/src/column/aggregations.ts:53

Type Parameters

Type Parameter
V

Parameters

Parameter	Type
vector	Vector<any>
valueAgg	ValueAggregation

Returns

V