Skip to content

Updated documentation about aggregate-function input #704

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
patricia-martinez-imatia merged 2 commits into from
Nov 12, 2025
Merged

Updated documentation about aggregate-function input #704

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ad86f7
Updated documentation about aggregate-function input
patricia-martinez-imatia Nov 11, 2025
b07655a
Fixed typo
patricia-martinez-imatia Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _data/components/otableData/05tableColumnAggregate.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ attributes: [{
required : "",
description : "Default functions aggregate"
},{
name: "function-aggregate",
type: "(value:any[]) => number ",
name: "aggregate-function",
type: "(value: any[], columnAttr?: string, table?: OTableComponent) => number | Promise<number>",
default : "",
required : "",
description : "Custom function aggregate"
Expand Down
2 changes: 1 addition & 1 deletion _data/components/otableData/15tableColumnsGroupingColumn.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ attributes: [{
description : "Default functions aggregate"
},{
name: "aggregate-function",
type: " (value: any[]) => number",
type: "(value: any[], columnAttr?: string, table?: OTableComponent) => number | Promise<number>",
default: "",
required: "",
description: "Function that calculates a value on the values of the column 'attr'"
Expand Down
6 changes: 3 additions & 3 deletions docs/components/data/35-o-table.component.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -914,7 +914,7 @@ The `o-table` component supports *fixed header* and *footer* setting `fixed-head

### Aggregates

Oftentimes, when displaying numbers in the table, users would like to be able to see the results from aggregate calculations at the bottom of the table columns. The `o-table` component has support for the mostly used aggregate functions (count,sum,avg,min,max).
Often when displaying numbers in a table, users want to show summary results of aggregate calculations at the bottom of the table columns. The `o‑table` component supports commonly used aggregation functions (**count**, **sum**, **avg**, **min**, **max**) using `aggregate` input and also allows specifying a **custom aggregation function** using the `aggregate-function` input, which may return either a **synchronous number** or a **Promise<number>** (for asynchronous operations).

<h3 class="grey-color">Example</h3>

Expand All @@ -928,7 +928,7 @@ Oftentimes, when displaying numbers in the table, users would like to be able to
<o-table-column attr="BALANCE" title="BALANCE" type="currency" currency-symbol="€" thousand-separator=","></o-table-column>
<o-table-column attr="INTERESRATE" title="INTERESRATE" type="real" ></o-table-column>
<o-table-column-aggregate attr="BALANCE" title="sum">
<o-table-column-aggregate attr="INTERESRATE" [function-aggregate]="custom"></o-table-column-aggregate>
<o-table-column-aggregate attr="INTERESRATE" [aggregate-function]="custom"></o-table-column-aggregate>
</o-table>
```

Expand Down Expand Up @@ -1458,7 +1458,7 @@ By default, the table is *groupable* and for grouping/ungrouping by one o more c
If there is at least one grouping, the table automatically applies the *sum function* on those of type `currency`, `integer` and `real` and whose value will be displayed in the grouped row.
If you want to exclude this function from being performed, you must add this column in the `excluded-aggregate-columns` attribute in `o-table-columns-grouping` component.

You can configure the *aggregate functions* (count,sum,avg,min,max) in the `o-table-columns-grouping` component. Additionally, you can specify aggregate function to be applied with `function-aggregate` attribute.
You can configure the *aggregate functions* (count,sum,avg,min,max) in the `o-table-columns-grouping` component. Additionally, you can specify aggregate function to be applied with `aggregate-function` attribute.

By default, when you change the aggregate function in a column, it will change in all grouped rows of the same level, if you want to avoid this behavior you must add `change-aggregate-same-level="no"`.

Expand Down