Interface RowGroupTableModelParaIf<T>

Parameters of RowGroupFactory.createTableModel.

Example

const para: RowGroupTableModelParaIf<Sale> = {
  rows: sales,
  columnDefs,
  groupBy: ["region", "produkt"],
  aggregations: { umsatz: "sum" },
  expanded: 1                      // regions open, products closed
};
const tableModel = RowGroupFactory.createTableModel(para);

Since

1.1.94

Type Parameters

  • T = any

    the row type

Hierarchy

  • RowGroupTableModelParaIf

Properties

aggregations? columnDefs? defaultRowHeights? emptyLabel? expanded? fixedLeftColumnCount? fixedRightColumnCount? footerAggregates? getSelectionModel? groupBy groupColumn? hideGroupedColumns? rowCheckboxVisible? rowNumbersVisible? rows tableOptions?

Properties

Optional aggregations

aggregations?: AggregateSpecMap<T>

Aggregates in the group rows; the key is the property of the column ({ umsatz: "sum" }, see AggregateSpecMap).

Optional columnDefs

columnDefs?: ColumnDefIf[]

The columns. Default: one per key of the first row. The group column is added in front of them.

Optional defaultRowHeights

defaultRowHeights?: DefaultRowHeightsIf

Row heights of header, body and footer. Default: tableOptions.defaultRowHeights.

Optional emptyLabel

emptyLabel?: string

The label of the group of empty keys (null, undefined, ""). Default "(empty)".

Optional expanded

expanded?: RowGroupExpanded<T>

Expanded groups: true (default), false, open levels as a number (0 = all closed) or a function per group.

Optional fixedLeftColumnCount

fixedLeftColumnCount?: number

Columns fixed on the left besides the group column (which is fixed by itself). Default 0.

Optional fixedRightColumnCount

fixedRightColumnCount?: number

Columns fixed on the right. Default 0.

Optional footerAggregates

footerAggregates?: boolean | AggregateFooterConfig<T>

The total row: true = the aggregations, false = none, or an own configuration (AggregateFooterConfig). Default: true if there are aggregations.

Optional getSelectionModel

getSelectionModel?: GetT<SelectionModelIf>

Selection model factory. Default: tableOptions.getSelectionModel.

groupBy

groupBy: RowGroupField<T>[]

The levels, top first: property paths ("region"), functions (o => o.date.getFullYear()) or RowGroupFieldIf.

Optional groupColumn

groupColumn?: Partial<RowGroupColumnOptionsIf<T>>

The group column: header, width, count, own label, fixed.

Optional hideGroupedColumns

hideGroupedColumns?: boolean

Hide the columns of the grouped properties. Default true.

Optional rowCheckboxVisible

rowCheckboxVisible?: boolean

Set with a CheckboxColumnDef in columnDefs (default: detected).

Optional rowNumbersVisible

rowNumbersVisible?: boolean | Partial<RowNumberOptionsIf>

Row numbers in front of all columns (counted per displayed row, group rows included).

rows

rows: T[]

The flat rows (not changed).

Optional tableOptions

tableOptions?: TableOptionsIf

Options of the table (row heights, selection model, filter …).

Settings

Member Visibility

Theme

On This Page