PivotLayout
Defines a Pivot-based Layout
export interface PivotLayout extendsExtends
Properties
| Property | Description |
|---|---|
| PivotAggregationColumns | Columns showing aggregated values in Group Rows; 1st value in record is Column name, 2nd is either aggfunc (e.g. sum, avg etc.) or 'true' (to use default aggfunc) |
| PivotColumns | Mandatory list of Columns to pivot (provide empty array if just displaying Aggregations) |
| PivotColumnTotal | Display automatically calculated Totals within EACH Pivot Column Group, in the position specified |
| PivotExpandLevel | How deep to expand Pivot Columns (0 for none, 1 for 1st level only etc, -1 to expand all) |
| PivotGrandTotal | Display automatically calculated Totals of all Pivot Columns, in the position specified |
| PivotGroupedColumns | Columns which are row-grouped when the Layout is applied |
| PivotResultColumnsOrder | Ordered list of Pivot Result Columns; set to true to track current display order, or provide custom list |
| IsReadOnly | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
Property Details
PivotAggregationColumns
Columns showing aggregated values in Group Rows; 1st value in record is Column name, 2nd is either aggfunc (e.g. sum, avg etc.) or 'true' (to use default aggfunc)
PivotAggregationColumns?: PivotAggregationColumns;Property Value
PivotColumns
Mandatory list of Columns to pivot (provide empty array if just displaying Aggregations)
PivotColumns: string[];Property Value
string[]
PivotColumnTotal
Display automatically calculated Totals within EACH Pivot Column Group, in the position specified
PivotColumnTotal?: PivotTotalPosition;Property Value
PivotExpandLevel
How deep to expand Pivot Columns (0 for none, 1 for 1st level only etc, -1 to expand all)
PivotExpandLevel?: number;Property Value
number
PivotGrandTotal
Display automatically calculated Totals of all Pivot Columns, in the position specified
PivotGrandTotal?: PivotTotalPosition;Property Value
PivotGroupedColumns
Columns which are row-grouped when the Layout is applied
PivotGroupedColumns?: string[];Property Value
string[]
PivotResultColumnsOrder
Ordered list of Pivot Result Columns; set to true to track current display order, or provide custom list
PivotResultColumnsOrder?: string[] | boolean;Property Value
string[] | boolean
IsReadOnly
Inherited from AdaptableObject
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsReadOnly?: boolean;Property Value
boolean