Overview of 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 |
|---|---|
| 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 |
| isWeakMeasureColumnWidthItem(obj) | Tests whether object is an instance of IWeakMeasureColumnWidthItem |
| newAttributeColumnLocator(attributeOrId, element) | Creates a new attribute 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. |
| pivotTableMenuForCapabilities(capabilities, desiredMenu) | Given analytical backend capabilities and the desired aggregations menu config. |
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 | |
| IPivotTableBaseProps | |
| IPivotTableBucketProps | |
| IPivotTableConfig | |
| IPivotTableProps | |
| IWeakMeasureColumnWidthItem | |
| IWeakMeasureColumnWidthItemBody | Object defining the IWeakMeasureColumnWidthItem object body. |
Variables
| Variable | Description |
|---|---|
| PivotTable | PivotTable is a component with bucket props measures, rows, columns, totals, sortBy, filters |
Type Aliases
| Type Alias | Description |
|---|---|
| ColumnLocator | |
| ColumnResizedCallback | |
| ColumnWidth | |
| ColumnWidthItem | |
| DefaultColumnWidth |