PitchKit
API Reference@pitchkit/coreFunctions

groupByPeriod()

function groupByPeriod(periods, minimum?): number[][];

Defined in: packages/core/src/chart/periods.ts:20

Indices into a flat list, grouped by period: groups[n - 1] holds the indices of everything in period n, in list order.

Feeds tag every row with its period rather than splitting them, so the charts take one flat list and group it here. Every period from 1 to the highest one seen gets a group, at least minimum of them, so a period with no rows still has its slot and the ones after it stay numbered right. Rows whose period isn't a whole number from 1 are left out.

Parameters

ParameterTypeDefault value
periodsreadonly number[]undefined
minimumnumber2

Returns

number[][]

On this page