Interface AggregateFooterOptionsIf<T>

The options of an AreaModelAggregateFooter (and of TableFactory.createTableModel({ footerAggregates })).

Example

const options: AggregateFooterOptionsIf<Order> = {
  rows: [
    { label: "Sum", aggregates: { quantity: "sum", total: "sum" } },
    { label: "Average", aggregates: { quantity: "avg", total: "avg" } }
  ],
  labelProperty: "customer",   // the labels go into the customer column
  rowHeight: 36
};

Since

1.1.94

Type Parameters

  • T = any

Hierarchy

  • AggregateFooterOptionsIf

Properties

getRows? labelProperty? rowHeight? rows source?

Properties

Optional getRows

getRows?: ((bodyModel) => ArrayLike<T>)

Type declaration

    • (bodyModel): ArrayLike<T>

    • An own source of rows (instead of the body model's rows), e.g. the data of a server response.

      Parameters

      Returns ArrayLike<T>

Optional labelProperty

labelProperty?: string

The column of the labels (property). Default: the first data column without an aggregate in that row.

Optional rowHeight

rowHeight?: number

Height of the footer rows in px. Default 34 (the factory uses defaultRowHeights.footer).

rows

rows: AggregateFooterRowIf<T>[]

One footer row per entry.

Optional source

source?: "all" | "filtered"

Which rows are aggregated: "filtered" (default) – the rows the body shows (after externalFilterFunction; in a tree all leaves that pass the filter, expanded or not); "all" – all rows, the filter is ignored.

Settings

Member Visibility

Theme

On This Page