Overview of sdk-ui-pivot

Home > @gooddata/sdk-ui-pivot

sdk-ui-pivot package

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.
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
IAllMeasureColumnWidthItem
IAllMeasureColumnWidthItemBody	Object defining IAllMeasureColumnWidthItem object body.
IAttributeColumnLocator	Locates all columns for an attribute or columns for particular attribute element.
IAttributeColumnLocatorBody	Object defining the IAttributeColumnLocator object body.
IAttributeColumnWidthItem
IAttributeColumnWidthItemBody	Object defining the IAttributeColumnWidthItem object body.
IAutoColumnWidth
IColumnSizing
IMeasureColumnLocator	Locates table column by column measure's localId.
IMeasureColumnLocatorBody	Object defining the IMeasureColumnLocator object body.
IMeasureColumnWidthItem
IMeasureColumnWidthItemBody	Object defining the IMeasureColumnWidthItem object body.
IMenu
IMixedValuesColumnWidthItem
IMixedValuesColumnWidthItemBody	Object defining the IMixedValuesColumnWidthItemBody object body.
IPivotTableBaseProps
IPivotTableBucketProps
IPivotTableConfig
IPivotTableProps
ISliceMeasureColumnWidthItem
ISliceMeasureColumnWidthItemBody	Object defining the ISliceMeasureColumnWidthItem object body.
ITotalColumnLocator	Locates all columns for a columns for particular total.
ITotalColumnLocatorBody	Object defining the ITotalColumnLocator object body.
IWeakMeasureColumnWidthItem
IWeakMeasureColumnWidthItemBody	Object defining the IWeakMeasureColumnWidthItem object body.

Type Aliases

Type Alias	Description
ColumnHeadersPosition
ColumnLocator
ColumnResizedCallback
ColumnWidth
ColumnWidthItem
DefaultColumnWidth
MeasureGroupDimension