Class PivotTableModel<T>

The table model of a pivot table – a TableModel (all wrappers take it) whose columns follow the pivot: a group column, one column per column key × value, subtotal and total columns, a grouped header and a total row. Created by PivotFactory.createTableModel.

Pivot again at runtime – other fields, values or rows – with TableApi.setPivotConfig: the same model and the same table get new columns (no new model, so no rebuild in the framework wrappers).

Example

const tableModel = PivotFactory.createTableModel<Sale>({
  rows: sales, rowFields: ["region"], columnFields: ["monat"], values: ["umsatz"]
});
tableModel.getPivotBody().getResult().getValue();   // 450
tableModel.getPivotConfig().columnFields;           // ["monat"]

Since

1.1.94

Type Parameters

T = any
the row type

Hierarchy

TableModel
- PivotTableModel

Index

Constructors

constructor

Constructors

constructor

new PivotTableModel<T>(header, body, footer, leadingColumnDefs, columnDefs, fixedRightColumnCount, fixedLeftColumnCount, defaultRowHeights, getSelectionModel, valueWidth?): PivotTableModel<T>
Use PivotFactory.createTableModel.
Type Parameters
- T = any
Parameters
- header: AreaModelCellGroups
  the grouped header
- body: AreaModelPivot<T>
  the pivot body
- footer: AreaModelPivotFooter<T>
  the total row
- leadingColumnDefs: ColumnDefIf[]
  the columns in front of the values (row numbers, group column)
- columnDefs: ColumnDefIf[]
  all columns (leading columns, value columns, total columns)
- fixedRightColumnCount: number
  the fixed total columns on the right
- fixedLeftColumnCount: number
  fixed columns on the left (the leading columns)
- defaultRowHeights: DefaultRowHeightsIf
  row heights
- getSelectionModel: GetT<SelectionModelIf>
  selection model factory
- Optional valueWidth: SizeIf
  the width of new value columns
Returns PivotTableModel<T>
Overrides TableModel.constructor
- Defined in src/lib/table/pivot/pivot-table-model.ts:55

Properties

`Readonly` bodyAreaModel

bodyAreaModel: AreaModelIf

`Protected` columnCount

columnCount: number = 0

columnDefs

columnDefs: ColumnDefIf[] = []

columnSizes

columnSizes: number[] = []

`Protected` contentHeightInPx

contentHeightInPx: number = 0

`Protected` contentWidthInPx

contentWidthInPx: number = 0

`Readonly` defaultRowHeights

defaultRowHeights: DefaultRowHeightsIf = ...

`Readonly` fixedLeftColumnCount

fixedLeftColumnCount: number = 0

`Readonly` fixedRightColumnCount

fixedRightColumnCount: number = 0

`Readonly` footerAreaModel

footerAreaModel: AreaModelIf

`Protected` footerVisible

footerVisible: boolean = true

false: the footer is hidden (height 0), see setFooterVisible.

getSelectionModel

getSelectionModel: GetT<SelectionModelIf> = ...

`Readonly` headerAreaModel

headerAreaModel: AreaModelIf

`Protected` headerVisible

headerVisible: boolean = true

false: the header is hidden (height 0), see setHeaderVisible.

`Readonly` kind

kind: "PivotTableModel" = "PivotTableModel"

Marker for isPivotTableModel (works across copies of the core).

`Protected` overridingColumnWidth

overridingColumnWidth: number = -1

`Protected` padding

padding: Padding = ...

`Protected` parentSize

parentSize: number = 400

`Readonly` rowCheckboxVisible

rowCheckboxVisible: boolean = false

`Protected` rowCount

rowCount: number = 0

`Protected` xPositions

xPositions: number[] = []

Methods

changeColumnOrder

changeColumnOrder(sourceColumnIndex, targetColumnIndex): void
Moves a column in the column order.
Parameters
- sourceColumnIndex: number
  The index of the column to be moved.
- targetColumnIndex: number
  The index where the column should be moved to.
Returns void
Inherited from TableModel.changeColumnOrder
- Defined in src/lib/table/data/tablemodel/table-model.ts:616

doSort

doSort(sortItems): boolean
Sorts the items using the given sortItems array.
Parameters
- sortItems: SortItem[]
  An array of sort items to sort the items.
Returns boolean
- Returns true if the sorting is successful, otherwise false.
Inherited from TableModel.doSort
- Defined in src/lib/table/data/tablemodel/table-model.ts:546

externalFilterChanged

externalFilterChanged<T>(predictFn): void
This method is called when an external filter is changed.
Type Parameters
- T
Parameters
- predictFn: FilterFunction<T>
  The function used to predict whether an element should be filtered or not.
Returns void
Inherited from TableModel.externalFilterChanged
- Defined in src/lib/table/data/tablemodel/table-model.ts:536

getAreaHeight

getAreaHeight(areaIdent): number
Calculates the height of the area identified by the given area identifier.
Parameters
- areaIdent: AreaIdent
  The identifier of the area.
Returns number
- The height of the area.
Inherited from TableModel.getAreaHeight
- Defined in src/lib/table/data/tablemodel/table-model.ts:306

getAreaModel

getAreaModel(area): AreaModelIf
Retrieves the area model (header, body or footer) based on the area identification.
Parameters
- area: AreaIdent
  The identifier of the area.
Returns AreaModelIf
The area model corresponding to the given area identification.

Throws
If the area identification is invalid.
Inherited from TableModel.getAreaModel
- Defined in src/lib/table/data/tablemodel/table-model.ts:397

getBodyModel

getBodyModel(): AreaModelIf
Returns the body area model.

Returns AreaModelIf
The body area model.
Inherited from TableModel.getBodyModel
- Defined in src/lib/table/data/tablemodel/table-model.ts:415

getBodyRowByIndex

getBodyRowByIndex(rowIndex): any
Retrieves the row object from the body model at the specified index.
Parameters
- rowIndex: number
  The index of the row to retrieve.
Returns any
The row object at the specified index.
Inherited from TableModel.getBodyRowByIndex
- Defined in src/lib/table/data/tablemodel/table-model.ts:586

getColumnCount

getColumnCount(): number
Retrieves the count of columns in the current instance.

Returns number
The count of columns.
Inherited from TableModel.getColumnCount
- Defined in src/lib/table/data/tablemodel/table-model.ts:123

getColumnDef

getColumnDef(index): undefined | ColumnDefIf
Returns the column definition at the specified index.
Parameters
- index: number
  The index of the column definition to retrieve.
Returns undefined | ColumnDefIf
- The column definition at the specified index, or undefined if no ColumnDef is specified for the given column
Inherited from TableModel.getColumnDef
- Defined in src/lib/table/data/tablemodel/table-model.ts:365

getColumnDefs

getColumnDefs(): undefined | ColumnDefIf[]
Returns an array of ColumnDefIf objects or undefined.

Returns undefined | ColumnDefIf[]
An array of ColumnDefIf objects or undefined.
Inherited from TableModel.getColumnDefs
- Defined in src/lib/table/data/tablemodel/table-model.ts:561

getColumnProperty

getColumnProperty(columnIndex): string
Retrieves the property key of the table row business object associated with the specified column index. It's only available when columnDefs are specified.
Parameters
- columnIndex: number
  The index of the column to retrieve the property from.
Returns string
The property associated with the specified column index.
Inherited from TableModel.getColumnProperty
- Defined in src/lib/table/data/tablemodel/table-model.ts:572

getColumnWidth

getColumnWidth(columnIndex): number
Retrieves the width of a column specified by its index.
Parameters
- columnIndex: number
  The index of the desired column.
Returns number
- The width of the specified column.
Inherited from TableModel.getColumnWidth
- Defined in src/lib/table/data/tablemodel/table-model.ts:163

getContentHeightInPixel

getContentHeightInPixel(): number
Returns the height of the content in pixels.

Returns number
The height of the content in pixels.
Inherited from TableModel.getContentHeightInPixel
- Defined in src/lib/table/data/tablemodel/table-model.ts:266

getContentWidthInPixel

getContentWidthInPixel(): number
Returns the width of the content in pixels.

Returns number
The width of the content in pixels.
Inherited from TableModel.getContentWidthInPixel
- Defined in src/lib/table/data/tablemodel/table-model.ts:275

getFixedLeftColumnCount

getFixedLeftColumnCount(): number
Retrieves the count of fixed left columns.

Returns number
The count of fixed left columns.
Inherited from TableModel.getFixedLeftColumnCount
- Defined in src/lib/table/data/tablemodel/table-model.ts:377

getFixedRightColumnCount

getFixedRightColumnCount(): number
Returns the number of fixed right columns.

Returns number
The number of fixed right columns.
Overrides TableModel.getFixedRightColumnCount
- Defined in src/lib/table/pivot/pivot-table-model.ts:72

getModel

getModel(rowAreaIdent): AreaModelIf
Retrieves the model for the given row area identifier.
Parameters
- rowAreaIdent: AreaIdent
  The identifier of the row area.
Returns AreaModelIf
- The model of the specified row area.
Inherited from TableModel.getModel
- Defined in src/lib/table/data/tablemodel/table-model.ts:296

getPadding

getPadding(): Padding
Retrieves the padding value.

Returns Padding
The padding value.
Inherited from TableModel.getPadding
- Defined in src/lib/table/data/tablemodel/table-model.ts:257

getPivotBody

getPivotBody(): AreaModelPivot<T>
The body: cells, row groups, drill-down (AreaModelPivot.getCellSourceRows) and the PivotResult.

Returns AreaModelPivot<T>
the body model
Example
```
const pivotBody = pivotModel.getPivotBody();
pivotBody.getResult().columnLeaves.map(c => c.label);   // ["Feb", "Jan"]
```
- Defined in src/lib/table/pivot/pivot-table-model.ts:85

getPivotConfig

getPivotConfig(): PivotConfigIf<T>
The current configuration.

Returns PivotConfigIf<T>
a copy
Example
```
pivotModel.getPivotConfig().rowFields;   // ["region"]
```
- Defined in src/lib/table/pivot/pivot-table-model.ts:97

getRowHeight

getRowHeight(rowAreaIdent, rowIndex): number
Returns the height of the specified row in the given row area identifier.
Parameters
- rowAreaIdent: AreaIdent
  The row area identifier.
- rowIndex: number
  The index of the row.
Returns number
- The height of the specified row.
Inherited from TableModel.getRowHeight
- Defined in src/lib/table/data/tablemodel/table-model.ts:286

getSideAreaWidth

getSideAreaWidth(sideIdent): number
Returns the total width of the side area identified by sideIdent.
Parameters
- sideIdent: SideIdent
  The identifier of the side area ("west" | "center" | "east").
Returns number
- The total width in pixels of the side area.
Inherited from TableModel.getSideAreaWidth
- Defined in src/lib/table/data/tablemodel/table-model.ts:326

getSideStartAndEndColumnIndex

getSideStartAndEndColumnIndex(sideIdent): [number, number]
Retrieves the start and end column indices based on the given side identifier.
Parameters
- sideIdent: SideIdent
  The side identifier, which can be "west", "east", or "center".
Returns [number, number]
- An array containing the start and end column indices.
Inherited from TableModel.getSideStartAndEndColumnIndex
- Defined in src/lib/table/data/tablemodel/table-model.ts:341

getTableScope

getTableScope(): undefined | TableScope
Returns undefined | TableScope
Inherited from TableModel.getTableScope
- Defined in src/lib/table/data/tablemodel/table-model.ts:725

getXPosByColumnIndex

getXPosByColumnIndex(columnIndex): number
Retrieves the x position for a given column index.
Parameters
- columnIndex: number
  The index of the column.
Returns number
- The x position of the column.
Inherited from TableModel.getXPosByColumnIndex
- Defined in src/lib/table/data/tablemodel/table-model.ts:183

init

init(): void
Triggered by TableScope.firstInit() after the table tag is attached to the dom.

Returns void
Inherited from TableModel.init
- Defined in src/lib/table/data/tablemodel/table-model.ts:98

isColumnVisible

isColumnVisible(column): boolean
Whether a column is shown (ColumnDefIf.isVisible). Columns without a column definition are always shown.
Parameters
- column: string | number | ColumnDefIf
  column index, property or column definition
Returns boolean
false for hidden and for unknown columns
Example
```
const hidden = tableModel.isColumnVisible?.("category") === false;
```
Inherited from TableModel.isColumnVisible
- Defined in src/lib/table/data/tablemodel/table-model.ts:513

isFooterVisibe

isFooterVisibe(): boolean
Checks if the footer is visible: it has rows and is not hidden with setFooterVisible.

Returns boolean
True if the footer is visible, false otherwise.
Inherited from TableModel.isFooterVisibe
- Defined in src/lib/table/data/tablemodel/table-model.ts:424

isHeaderVisibe

isHeaderVisibe(): boolean
Checks if the header area is visible: it has rows and is not hidden with setHeaderVisible.

Returns boolean
Returns true if the header area is visible, otherwise false.
Inherited from TableModel.isHeaderVisibe
- Defined in src/lib/table/data/tablemodel/table-model.ts:432

isRowCheckboxVisible

isRowCheckboxVisible(): boolean
Checks whether the row checkbox is visible.

Returns boolean
True if the row checkbox is visible, otherwise false.
Inherited from TableModel.isRowCheckboxVisible
- Defined in src/lib/table/data/tablemodel/table-model.ts:526

isSortable

isSortable(columnIndex): boolean
Checks if a column at the given index is sortable.
Parameters
- columnIndex: number
  The index of the column to check.
Returns boolean
- true if the column is sortable, false otherwise.
Inherited from TableModel.isSortable
- Defined in src/lib/table/data/tablemodel/table-model.ts:597

recalcHeightAndPadding

recalcHeightAndPadding(): void
Recalculates the height and padding for the body area.

This method retrieves the area model for the "body" area, and updates the rowCount property with the row count of the model.

The contentHeightInPx property is then updated with the height of the "body" area.

The method calls the recalcContentWidthInPx() method to recalculate the content width.

Finally, the method calls the recalcPadding() method to recalculate the padding.

Returns void
Inherited from TableModel.recalcHeightAndPadding
- Defined in src/lib/table/data/tablemodel/table-model.ts:222

recalcPadding

recalcPadding(): void
Recalculates the padding of an element based on the width and height of its surrounding areas.

Returns void
Method
recalcPadding
Inherited from TableModel.recalcPadding
- Defined in src/lib/table/data/tablemodel/table-model.ts:238

recalcSize

recalcSize(clientWidth): void
Recalculates the size (width, height, padding) of the elements based on the client width.
Parameters
- clientWidth: number
  The width of the client area.
Returns void
- This method does not return a value.
Inherited from TableModel.recalcSize
- Defined in src/lib/table/data/tablemodel/table-model.ts:200

setColumnVisible

setColumnVisible(column, visible): boolean
Shows or hides a column. The column keeps its definition, position and width – a hidden column has the width 0 (getColumnWidth), is not rendered, copied or exported; showing it again restores its width.

Works through ColumnDefIf.isVisible: it is replaced by TrueFn / FalseFn (an own isVisible function of the column is replaced, too). Columns without a column definition can't be hidden. With header groups (AreaModelCellGroups) the column is shown only if neither this method nor a collapsed group hides it – expanding the group does not bring back a column hidden here, and vice versa. Weight widths (new Size(1, "weight")) are shared among the shown columns. Recalculates the content width, the padding (fixed columns) and the x positions. Only changes the model – TableApi.setColumnVisible also repaints the table.
Parameters
- column: string | number | ColumnDefIf
  column index (fixed columns included), property or column definition
- visible: boolean
  false hides the column
Returns boolean
false if there is no such column definition
Example
```
tableModel.setColumnVisible?.("category", false);
```
Inherited from TableModel.setColumnVisible
- Defined in src/lib/table/data/tablemodel/table-model.ts:484

setColumnWidth

setColumnWidth(columnIndex, width): void
Sets the width in pixel of a column (by columnIndex) in a table. The width is also stored in the column's ColumnDef (width = the new px size), so it survives a host resize (the widths are recalculated from the ColumnDefs then).
Parameters
- columnIndex: number
  The index of the column.
- width: number
  The desired width of the column.
Returns void
Inherited from TableModel.setColumnWidth
- Defined in src/lib/table/data/tablemodel/table-model.ts:136

setFooterVisible

setFooterVisible(visible): void
Shows or hides the footer. A hidden footer takes no space; its area model and rows stay unchanged. Only changes the model – TableApi.setFooterVisible also repaints the table.
Parameters
- visible: boolean
  false hides the footer
Returns void
Example
```
tableModel.setFooterVisible?.(false);
```
Inherited from TableModel.setFooterVisible
- Defined in src/lib/table/data/tablemodel/table-model.ts:460

setHeaderVisible

setHeaderVisible(visible): void
Shows or hides the header. A hidden header takes no space (the body moves up); its area model and rows stay unchanged, so showing it again restores it. Only changes the model – TableApi.setHeaderVisible also repaints the table.
Parameters
- visible: boolean
  false hides the header
Returns void
Example
```
tableModel.setHeaderVisible?.(false);
```
Inherited from TableModel.setHeaderVisible
- Defined in src/lib/table/data/tablemodel/table-model.ts:446

setParentWidth

setParentWidth(widthInPixel): void
Recalculates the column widths of the table.
Parameters
- widthInPixel: number
Returns void
Inherited from TableModel.setParentWidth
- Defined in src/lib/table/data/tablemodel/table-model.ts:114

setPivotConfig

setPivotConfig(changes, rows?): void
Pivots again with a changed configuration and/or new rows: new keys, columns, header and totals in this model. Prefer TableApi.setPivotConfig – it also lays the table out again; after this method alone the table must be laid out by you.
Parameters
- changes: Partial<PivotConfigIf<T>>
  the changed parts, e.g. { columnFields: ["jahr"] }
- Optional rows: T[]
  new source rows (default: the current ones)
Returns void
Example
```
pivotModel.setPivotConfig({ values: [{ value: "umsatz", aggregator: "avg" }] });
```
- Defined in src/lib/table/pivot/pivot-table-model.ts:112

setTableScope

setTableScope(tableScope): void
Parameters
- tableScope: TableScope
Returns void
Inherited from TableModel.setTableScope
- Defined in src/lib/table/data/tablemodel/table-model.ts:722

sort

sort(compareFn): void
Parameters
- compareFn: ((a, b) => number)
  - - (a, b): number
    - Parameters
      a: any
      b: any
      Returns number
Returns void
Inherited from TableModel.sort
- Defined in src/lib/table/data/tablemodel/table-model.ts:551

Class PivotTableModel<T>

Example

Since

Type Parameters

T = any

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T = any

Parameters

header: AreaModelCellGroups

body: AreaModelPivot<T>

footer: AreaModelPivotFooter<T>

leadingColumnDefs: ColumnDefIf[]

columnDefs: ColumnDefIf[]

fixedRightColumnCount: number

fixedLeftColumnCount: number

defaultRowHeights: DefaultRowHeightsIf

getSelectionModel: GetT<SelectionModelIf>

Optional valueWidth: SizeIf

Returns PivotTableModel<T>

Properties

Readonly bodyAreaModel

Protected columnCount

columnDefs

columnSizes

Protected contentHeightInPx

Protected contentWidthInPx

Readonly defaultRowHeights

Readonly fixedLeftColumnCount

Readonly fixedRightColumnCount

Readonly footerAreaModel

Protected footerVisible

getSelectionModel

Readonly headerAreaModel

Protected headerVisible

Readonly kind

Protected overridingColumnWidth

Protected padding

Protected parentSize

Readonly rowCheckboxVisible

Protected rowCount

Protected xPositions

Methods

changeColumnOrder

Parameters

sourceColumnIndex: number

targetColumnIndex: number

Returns void

doSort

Parameters

sortItems: SortItem[]

Returns boolean

externalFilterChanged

Type Parameters

T

Parameters

predictFn: FilterFunction<T>

Returns void

getAreaHeight

Parameters

areaIdent: AreaIdent

Returns number

getAreaModel

Parameters

area: AreaIdent

Returns AreaModelIf

Throws

getBodyModel

Returns AreaModelIf

getBodyRowByIndex

Parameters

rowIndex: number

Returns any

getColumnCount

`Optional` valueWidth: SizeIf

`Readonly` bodyAreaModel

`Protected` columnCount

`Protected` contentHeightInPx

`Protected` contentWidthInPx

`Readonly` defaultRowHeights

`Readonly` fixedLeftColumnCount

`Readonly` fixedRightColumnCount

`Readonly` footerAreaModel

`Protected` footerVisible

`Readonly` headerAreaModel

`Protected` headerVisible

`Readonly` kind

`Protected` overridingColumnWidth

`Protected` padding

`Protected` parentSize

`Readonly` rowCheckboxVisible

`Protected` rowCount

`Protected` xPositions