Skip to content

pivotick v3.0.0


pivotick / Pivot / PivotSummary

Interface: PivotSummary ​

Defined in: interfaces/Pivot.ts:300

What PivotDefinition.summarize advertises.

Every count here is advisory. It legitimately differs from what ingest lands — dedup is the common case — and a shrink is never an error.

Properties ​

facets? ​

optional facets: PivotFacet[]

Defined in: interfaces/Pivot.ts:310

Optional breakdown; each entry becomes one narrowing control.


total? ​

optional total: number | null

Defined in: interfaces/Pivot.ts:308

Advisory total. Render it as approximate.

null or left out means the provider does not know, which is not the same claim as 0. No count is drawn for it, and PivotDefinition.maxCandidates is not judged on it: only PivotManagerLike.candidateCeiling bounds what the fetch returns.