@gooddata/sdk-ui-pivot

This package provides the PivotTable component that you can use to visualize your data in a table-based manner.

Remarks

The PivotTable component provides additional capabilities such as totals, automatic column resizing, and more.

Functions

Function	Description
getPivotTableDimensions(buckets, isTransposed)	Prepares dimensions for pivot table execution from buckets and info if table is transposed or not.
isAbsoluteColumnWidth(columnWidth)	Tests whether object is an instance of IAbsoluteColumnWidth
isAllMeasureColumnWidthItem(obj)	Tests whether object is an instance of IAllMeasureColumnWidthItem
isAttributeColumnLocator(obj)	Tests whether object is an instance of IAttributeColumnLocator
isAttributeColumnWidthItem(obj)	Tests whether object is an instance of IAttributeColumnWidthItem
isMeasureColumnLocator(obj)	Tests whether object is an instance of IMeasureColumnLocator
isMeasureColumnWidthItem(obj)	Tests whether object is an instance of IMeasureColumnWidthItem
isMixedValuesColumnWidthItem(obj)	Tests whether object is an instance of IMixedValuesColumnWidthItem
isSliceMeasureColumnWidthItem(obj)	Tests whether object is an instance of ISliceMeasureColumnWidthItem
isTotalColumnLocator(obj)	Tests whether object is an instance of ITotalColumnLocator
isWeakMeasureColumnWidthItem(obj)	Tests whether object is an instance of IWeakMeasureColumnWidthItem
newAttributeColumnLocator(attributeOrId, element)	Creates a new attribute column locator
newTotalColumnLocator(attributeOrId, totalFunction)	*(ALPHA)* Creates a new total column locator
newWidthForAllColumnsForMeasure(measureOrId, width, allowGrowToFit)	Creates width item that will set width for all columns containing values of the provided measure.
newWidthForAllMeasureColumns(width, allowGrowToFit)	Creates width item that will set width for all measure columns in the table.
newWidthForAttributeColumn(attributeOrId, width, allowGrowToFit)	Creates width item that will set width of a column which contains values of a row attribute.
newWidthForSelectedColumns(measureOrId, locators, width, allowGrowToFit)	Creates width item that will set width for all columns containing values of the provided measure. To prepare width items for columns in tables without measures, pass measureOrId as `null`.
PivotTable(props)	PivotTable is a component with bucket props measures, rows, columns, totals, sortBy, filters
pivotTableMenuForCapabilities(capabilities, desiredMenu)	Given analytical backend capabilities and the desired aggregations menu config.
PivotTableNext(props)	PivotTableNext is the new pivot table component built on AG Grid Enterprise. This component replaces the legacy PivotTable component and offers: - Better performance for large datasets - Configurable text wrapping for long content - Cell selection and copy capabilities - Advanced column resizing options
setNewWidthForSelectedColumns(measuresOrIds, locators, width, allowGrowToFit)	Creates width item that will set width for all columns containing values of the provided measure. To prepare width items for columns in tables without measures, pass measureOrId as `null`.

Interfaces

Interface	Description
IAbsoluteColumnWidth
IAbsoluteColumnWidthNext
IAllMeasureColumnWidthItem
IAllMeasureColumnWidthItemBody	Object defining IAllMeasureColumnWidthItem object body.
IAllMeasureColumnWidthItemBodyNext	Object defining IAllMeasureColumnWidthItem object body.
IAllMeasureColumnWidthItemNext
IAttributeColumnLocator	Locates all columns for an attribute or columns for particular attribute element.
IAttributeColumnLocatorBody	Object defining the IAttributeColumnLocator object body.
IAttributeColumnLocatorBodyNext	Object defining the IAttributeColumnLocator object body.
IAttributeColumnLocatorNext	Locates all columns for an attribute or columns for particular attribute element.
IAttributeColumnWidthItem
IAttributeColumnWidthItemBody	Object defining the IAttributeColumnWidthItem object body.
IAttributeColumnWidthItemBodyNext	Object defining the IAttributeColumnWidthItem object body.
IAttributeColumnWidthItemNext
IAutoColumnWidth
IAutoColumnWidthNext
IColumnSizing
IColumnSizingNext
IColumnTextWrappingItem	Column text wrapping item that specifies text wrapping settings for specific column(s).
IMeasureColumnLocator	Locates table column by column measure’s localId.
IMeasureColumnLocatorBody	Object defining the IMeasureColumnLocator object body.
IMeasureColumnLocatorBodyNext	Object defining the IMeasureColumnLocator object body.
IMeasureColumnLocatorNext	Locates table column by column measure’s localId.
IMeasureColumnWidthItem
IMeasureColumnWidthItemBody	Object defining the IMeasureColumnWidthItem object body.
IMeasureColumnWidthItemBodyNext	Object defining the IMeasureColumnWidthItem object body.
IMeasureColumnWidthItemNext
IMenu
IMenuNext	Configuration for the aggregations menu.
IMixedValuesColumnWidthItem
IMixedValuesColumnWidthItemBody	Object defining the IMixedValuesColumnWidthItemBody object body.
IMixedValuesColumnWidthItemBodyNext	Object defining the IMixedValuesColumnWidthItemBody object body.
IMixedValuesColumnWidthItemNext
IPagination	Pagination settings for the PivotTableNext component.
IPivotTableBaseProps
IPivotTableBucketProps
IPivotTableConfig
IPivotTableNextProps	Props for the PivotTableNext component.
IPivotTableProps
ISliceMeasureColumnWidthItem
ISliceMeasureColumnWidthItemBody	Object defining the ISliceMeasureColumnWidthItem object body.
ISliceMeasureColumnWidthItemBodyNext	Object defining the ISliceMeasureColumnWidthItem object body.
ISliceMeasureColumnWidthItemNext
ITextWrapping
ITotalColumnLocator	Locates all columns for a columns for particular total.
ITotalColumnLocatorBody	Object defining the ITotalColumnLocator object body.
ITotalColumnLocatorBodyNext	Object defining the ITotalColumnLocator object body.
ITotalColumnLocatorNext	Locates all columns for a columns for particular total.
IWeakMeasureColumnWidthItem
IWeakMeasureColumnWidthItemBody	Object defining the IWeakMeasureColumnWidthItem object body.
IWeakMeasureColumnWidthItemBodyNext	Object defining the IWeakMeasureColumnWidthItem object body.
IWeakMeasureColumnWidthItemNext

Type Aliases

Type Alias	Description
ColumnHeadersPosition
ColumnHeadersPositionNext
ColumnLocator
ColumnLocatorNext
ColumnResizedCallback
ColumnResizedCallbackNext
ColumnWidth
ColumnWidthItem
ColumnWidthItemNext
ColumnWidthNext
DefaultColumnWidth
DefaultColumnWidthNext
GrandTotalsPosition	Position of grand totals rows in the table. “pinnedBottom” - Grand totals are pinned at the bottom of the table (always visible) - “pinnedTop” - Grand totals are pinned at the top of the table (always visible) - “bottom” - Grand totals appear at the end of the table data (scrolls with content) - “top” - Grand totals appear at the beginning of the table data (scrolls with content)
GrandTotalsPositionNext	Position of grand totals rows in the table. “pinnedBottom” - Grand totals are pinned at the bottom of the table (always visible) - “pinnedTop” - Grand totals are pinned at the top of the table (always visible) - “bottom” - Grand totals appear at the end of the table data (scrolls with content) - “top” - Grand totals appear at the beginning of the table data (scrolls with content)
MeasureGroupDimension
MeasureGroupDimensionNext	Whether to display measures in columns or rows (transposed). This affects how execution and result of the table is constructed: - “columns” - measures are included in the first dimension (top to bottom). - “rows” - measures are included in the second dimension (left to right).
PivotTableNextAccessibilityConfig	Accessibility-related configuration for the PivotTableNext component.
PivotTableNextAgGridLicenseConfig	AG Grid Enterprise license configuration.
PivotTableNextCellSelectionConfig
PivotTableNextColumnsSizingConfig
PivotTableNextConditionalFormattingConfig	*(ALPHA)* Config slot intersected into PivotTableNextConfig so conditional formatting can be passed through the `config` prop (and read back from insight properties).
PivotTableNextConfig	Configuration for the pivot table next.
PivotTableNextConfigWithConditionalFormatting	*(ALPHA)* PivotTableNextConfig extended with the conditional formatting configuration.
PivotTableNextExecutionCancellingConfig	Configuration for execution cancelling.
PivotTableNextExperimentalConfig	Configuration for pivot table experimental features.
PivotTableNextFormattingConfig	Configuration for formatting.
PivotTableNextGrandTotalsPositionConfig	Configuration for grand totals row positioning in the pivot table.
PivotTableNextLayoutConfig	Layout-related configuration for the PivotTableNext component.
PivotTableNextMenuConfig
PivotTableNextPaginationConfig	Pagination-related configuration for the PivotTableNext component.
PivotTableNextTextWrappingConfig
PivotTableNextTranspositionConfig