@sqlrooms/pivot
Slice-driven pivot table UI for SQLRooms, inspired by react-pivottable and backed by DuckDB SQL plus Vega-Lite charts.
Selection model
createPivotSlicemanages pivot definitions and runtime state, but not host-level selection.- Host apps should decide which pivot is visible, for example with layout tabs or an artifacts/workspace registry.
PivotViewnow requires an explicitpivotIdprop.
Stateful block adapter
createPivotBlockDefinition exposes pivot tables as stateful block implementations. Host apps can use this definition directly in block hosts or wrap it as a top-level artifact shell with @sqlrooms/artifacts.
tsx
import {createArtifactTypeFromStatefulBlock} from '@sqlrooms/artifacts';
import {createPivotBlockDefinition} from '@sqlrooms/pivot';
const pivotBlockDefinition = createPivotBlockDefinition();
export const pivotArtifactType = createArtifactTypeFromStatefulBlock(
pivotBlockDefinition,
);The adapter preserves pivot state in pivot.config.pivots and delegates creation, rename, and delete behavior to createPivotSlice.
Type Aliases
- PivotBlockRenderProps
- CreatePivotBlockDefinitionOptions
- PivotAggregatorDefinition
- PivotCellData
- PivotCell
- PivotRendererName
- PivotRendererName
- PivotSortOrder
- PivotSortOrder
- PivotFilterMap
- PivotValueFilter
- PivotConfig
- PivotConfig
- PivotSource
- PivotSource
- PivotRelationViews
- PivotRelationViews
- PivotRunState
- PivotRunState
- PivotStatus
- PivotStatus
- PivotSliceItem
- PivotSliceItem
- PivotSliceConfig
- PivotDropZone
- PivotField
- PivotQuerySource
- PivotSliceState
- PivotInstanceSnapshot
- PivotInstanceState
- PivotInstanceStore
- PivotOutputCell
Variables
- PivotCellContent
- PivotEditor
- PivotResults
- PivotView
- PIVOT_AGGREGATORS
- DEFAULT_PIVOT_AGGREGATOR
- pivotCellRegistryEntry
- PivotCellData
- PivotCell
- PivotCellSchema
- PIVOT_RENDERER_NAMES
- PivotFilterMapSchema
- PivotValueFilterSchema
- PivotSliceConfig
Functions
- createPivotBlockDefinition
- createDefaultPivotConfig
- normalizePivotConfig
- setAttributeFilterValuesInConfig
- addAttributeFilterValuesInConfig
- removeAttributeFilterValuesInConfig
- clearAttributeFilterInConfig
- createPivotCoreStore
- createPivotSlice
- getPivotAggregator
- getAggregatorLabel
- getDefaultValuesForAggregator
- formatAggregatorValue
- isPivotCell
- createPivotRelationViews
- createOrReplacePivotRelations
- dropPivotRelations
- createPivotQuerySource
- createPivotQuerySourceFromTable
- buildCellsQuery
- buildRowTotalsQuery
- buildColTotalsQuery
- buildGrandTotalQuery
- buildDistinctValuesQuery
- buildPivotExportQuery
- buildRendererTitle
References
PivotConfigSchema
Renames and re-exports PivotConfig
PivotRelationViewsSchema
Renames and re-exports PivotRelationViews
PivotRunStateSchema
Renames and re-exports PivotRunState
PivotSourceSchema
Renames and re-exports PivotSource
PivotStatusSchema
Renames and re-exports PivotStatus
