@kanunilabs/pivotgrid-react / PivotLayoutState

Interface: PivotLayoutState

Controls pivot grid layout, totals visibility, and structural options.

Properties

chartType?

optional chartType?: string

Chart integration type when rendering in chart mode.

dataFieldPosition?

optional dataFieldPosition?: "rows" | "columns"

Place data field labels in row headers or column headers.

hideEmptySummaryCells?

optional hideEmptySummaryCells?: boolean

Hide rows/columns that have no data.

prefilter?

optional prefilter?: FilterGroup

Server-side or computed prefilter applied before aggregation.

rowHeaderLayout?

optional rowHeaderLayout?: "tabular" | "tree"

Row header style: 'tabular' gives one column per row field, 'tree' nests all into one column.

showColumnGrandTotals?

optional showColumnGrandTotals?: boolean

The grand total COLUMN, at the end of every row.

showColumnTotals?

optional showColumnTotals?: boolean

Deprecated

NOT IMPLEMENTED. Subtotals on the column axis do not exist: row subtotals are inserted while flattening the row tree, and the column axis has no equivalent pass in the renderer. Setting this to true explicitly reports through onError; it is left in the type because it has always had a default of true, so removing it would be a breaking change for a value that never did anything.

showFilterArea?

optional showFilterArea?: boolean

showFooter?

optional showFooter?: boolean

showGrandTotals?

optional showGrandTotals?: "none" | "rows" | "columns" | "both"

Coarse form of showRowGrandTotals + showColumnGrandTotals. Bridged to them at the controller boundary; an explicitly passed granular flag wins.

showRowGrandTotals?

optional showRowGrandTotals?: boolean

The grand total ROW, at the end of the grid.

showRowTotals?

optional showRowTotals?: boolean

Per-level subtotals on the row axis.

showSubTotals?

optional showSubTotals?: "none" | "rows" | "columns" | "both"

Coarse form of showRowTotals. Bridged for the ROW axis only — asking for 'columns' or 'both' reports through onError, because column subtotals are not implemented. See showColumnTotals.

totalsDisplayMode?

optional totalsDisplayMode?: "top" | "bottom"

Alias of totalsPosition, bridged at the controller boundary.

totalsPosition?

optional totalsPosition?: "top" | "bottom"

Whether subtotals appear above or below their groups.