Skip to content
REFERENCE

U.VAGGREGATE

Summary

Dynamically aggregates rows of data (Descriptions use "column" and "row" consistent with the vertical flavor of the function; flip these terms to describe the horizontal flavor)

Syntax

=U.VAGGREGATE(data, [key_columns], [columns_to_sum], [columns_to_avg], [ignore_errors], [drop_columns], [add_count])

Parameters

Parameter Required Description
data Yes The rows of data to be aggregated. If only a valid topic is provided, the first page of that report will be used unless there is a spaced pipe and page indicator following the topic (e.g.
[key_columns] No The labels or indexes of columns to use as the basis for aggregation. Rows containing identical values in key_columns are aggregated. Set to FALSE to indicate no key columns exist so all rows should be aggregated. If not set, the leftmost non-numeric columns are used as key columns
[columns_to_sum] No The labels or indexes of columns whose values should be summed in aggregations. If the 2nd parameter is FALSE, set to "*" to always treat the 1st row as values instead of labels. If not set then any all-numeric columns are summed in aggregations
[columns_to_avg] No The labels or indexes of columns whose values should be averaged in aggregations, optionally with the labels or indexes of columns whose values should be used as averaging weights. If the 2nd parameter is FALSE, set to "*" to always treat the 1st row as values instead of labels.
[ignore_errors] No If set to TRUE then non-numeric values will be ignored when aggregating values. By default non-numeric values in aggregated columns result in an error
[drop_columns] No If set to TRUE then only columns explicitly specified as a key column, a column to sum, or a column to average By default all columns in the data range are returned
[add_count] No If set to TRUE then a column labeled "Num Aggregated" is appended to the result that indicates how many rows were aggregated into that result row

Behavior

The documented public interface is supported by the current U Add-in source signature and the maintained Usage Examples workbook. Optional parameters are shown in square brackets in the syntax above; omit the brackets when entering a formula.

Return Value

Returns the function result or action status described by the formula and parameters above. The maintained sources do not define a narrower, stable return contract for this function.

Examples

=U.VAGGREGATE(B7:I20,V8:V12,W8:W12,X8:Y12,,,TRUE)

=U.VAGGREGATE(B7:I20,V22:V26,W22:W26,X22:Y26,,,TRUE)

=U.VAGGREGATE(B7:I20,,,X36:Y40)

Notes

  • Formula examples are preserved from maintained workbook usage and normalized to the current U. prefix.
  • Complete formulas demonstrate working patterns; they do not imply that undocumented option values are supported.
  • Where maintained sources do not specify every accepted value, default, or error message, this page does not infer one.
  • For functions that perform actions, use a visible trigger or supported block/throttle parameter to avoid unintended repetition during recalculation.