|
1 | | -### YamlMime:TSEnum |
2 | | -name: ExcelScript.AggregationFunction |
3 | | -uid: 'ExcelScript!ExcelScript.AggregationFunction:enum' |
4 | | -package: ExcelScript! |
5 | | -fullName: ExcelScript.AggregationFunction |
6 | | -summary: Aggregation function for the `DataPivotHierarchy`<!-- -->. |
7 | | -remarks: |- |
8 | | -
|
9 | | -
|
10 | | - #### Examples |
11 | | -
|
12 | | - ```TypeScript |
13 | | - /** |
14 | | - * This script changes how the data in a PivotTable is aggregated. |
15 | | - */ |
16 | | - function main(workbook: ExcelScript.Workbook) { |
17 | | - // Get the first PivotTable in the workbook. |
18 | | - const pivotTable = workbook.getPivotTables()[0]; |
19 | | - |
20 | | - // Set the first data hierarchy to summarize with an average value, instead of a sum. |
21 | | - const dataHierarchy = pivotTable.getDataHierarchies()[0]; |
22 | | - dataHierarchy.setSummarizeBy(ExcelScript.AggregationFunction.average); |
23 | | - } |
24 | | - ``` |
25 | | -isPreview: false |
26 | | -isDeprecated: false |
27 | | -fields: |
28 | | - - name: automatic |
29 | | - uid: 'ExcelScript!ExcelScript.AggregationFunction.automatic:member' |
30 | | - package: ExcelScript! |
31 | | - summary: Excel will automatically select the aggregation based on the data items. |
32 | | - - name: average |
33 | | - uid: 'ExcelScript!ExcelScript.AggregationFunction.average:member' |
34 | | - package: ExcelScript! |
35 | | - summary: 'Aggregate using the average of the data, equivalent to the AVERAGE function.' |
36 | | - - name: count |
37 | | - uid: 'ExcelScript!ExcelScript.AggregationFunction.count:member' |
38 | | - package: ExcelScript! |
39 | | - summary: 'Aggregate using the count of items in the data, equivalent to the COUNTA function.' |
40 | | - - name: countNumbers |
41 | | - uid: 'ExcelScript!ExcelScript.AggregationFunction.countNumbers:member' |
42 | | - package: ExcelScript! |
43 | | - summary: 'Aggregate using the count of numbers in the data, equivalent to the COUNT function.' |
44 | | - - name: max |
45 | | - uid: 'ExcelScript!ExcelScript.AggregationFunction.max:member' |
46 | | - package: ExcelScript! |
47 | | - summary: 'Aggregate using the maximum value of the data, equivalent to the MAX function.' |
48 | | - - name: min |
49 | | - uid: 'ExcelScript!ExcelScript.AggregationFunction.min:member' |
50 | | - package: ExcelScript! |
51 | | - summary: 'Aggregate using the minimum value of the data, equivalent to the MIN function.' |
52 | | - - name: product |
53 | | - uid: 'ExcelScript!ExcelScript.AggregationFunction.product:member' |
54 | | - package: ExcelScript! |
55 | | - summary: 'Aggregate using the product of the data, equivalent to the PRODUCT function.' |
56 | | - - name: standardDeviation |
57 | | - uid: 'ExcelScript!ExcelScript.AggregationFunction.standardDeviation:member' |
58 | | - package: ExcelScript! |
59 | | - summary: 'Aggregate using the standard deviation of the data, equivalent to the STDEV function.' |
60 | | - - name: standardDeviationP |
61 | | - uid: 'ExcelScript!ExcelScript.AggregationFunction.standardDeviationP:member' |
62 | | - package: ExcelScript! |
63 | | - summary: 'Aggregate using the standard deviation of the data, equivalent to the STDEVP function.' |
64 | | - - name: sum |
65 | | - uid: 'ExcelScript!ExcelScript.AggregationFunction.sum:member' |
66 | | - package: ExcelScript! |
67 | | - summary: 'Aggregate using the sum of the data, equivalent to the SUM function.' |
68 | | - - name: unknown |
69 | | - uid: 'ExcelScript!ExcelScript.AggregationFunction.unknown:member' |
70 | | - package: ExcelScript! |
71 | | - summary: Aggregation function is unknown or unsupported. |
72 | | - - name: variance |
73 | | - uid: 'ExcelScript!ExcelScript.AggregationFunction.variance:member' |
74 | | - package: ExcelScript! |
75 | | - summary: 'Aggregate using the variance of the data, equivalent to the VAR function.' |
76 | | - - name: varianceP |
77 | | - uid: 'ExcelScript!ExcelScript.AggregationFunction.varianceP:member' |
78 | | - package: ExcelScript! |
79 | | - summary: 'Aggregate using the variance of the data, equivalent to the VARP function.' |
| 1 | +### YamlMime:TSEnum |
| 2 | +name: ExcelScript.AggregationFunction |
| 3 | +uid: 'ExcelScript!ExcelScript.AggregationFunction:enum' |
| 4 | +package: ExcelScript! |
| 5 | +fullName: ExcelScript.AggregationFunction |
| 6 | +summary: Aggregation function for the `DataPivotHierarchy`<!-- -->. |
| 7 | +remarks: |- |
| 8 | +
|
| 9 | +
|
| 10 | + #### Examples |
| 11 | +
|
| 12 | + ```TypeScript |
| 13 | + /** |
| 14 | + * This script changes how the data in a PivotTable is aggregated. |
| 15 | + */ |
| 16 | + function main(workbook: ExcelScript.Workbook) { |
| 17 | + // Get the first PivotTable in the workbook. |
| 18 | + const pivotTable = workbook.getPivotTables()[0]; |
| 19 | + |
| 20 | + // Set the first data hierarchy to summarize with an average value, instead of a sum. |
| 21 | + const dataHierarchy = pivotTable.getDataHierarchies()[0]; |
| 22 | + dataHierarchy.setSummarizeBy(ExcelScript.AggregationFunction.average); |
| 23 | + } |
| 24 | + ``` |
| 25 | +isPreview: false |
| 26 | +isDeprecated: false |
| 27 | +fields: |
| 28 | + - name: automatic |
| 29 | + uid: 'ExcelScript!ExcelScript.AggregationFunction.automatic:member' |
| 30 | + package: ExcelScript! |
| 31 | + summary: Excel will automatically select the aggregation based on the data items. |
| 32 | + - name: average |
| 33 | + uid: 'ExcelScript!ExcelScript.AggregationFunction.average:member' |
| 34 | + package: ExcelScript! |
| 35 | + summary: 'Aggregate using the average of the data, equivalent to the AVERAGE function.' |
| 36 | + - name: count |
| 37 | + uid: 'ExcelScript!ExcelScript.AggregationFunction.count:member' |
| 38 | + package: ExcelScript! |
| 39 | + summary: 'Aggregate using the count of items in the data, equivalent to the COUNTA function.' |
| 40 | + - name: countNumbers |
| 41 | + uid: 'ExcelScript!ExcelScript.AggregationFunction.countNumbers:member' |
| 42 | + package: ExcelScript! |
| 43 | + summary: 'Aggregate using the count of numbers in the data, equivalent to the COUNT function.' |
| 44 | + - name: max |
| 45 | + uid: 'ExcelScript!ExcelScript.AggregationFunction.max:member' |
| 46 | + package: ExcelScript! |
| 47 | + summary: 'Aggregate using the maximum value of the data, equivalent to the MAX function.' |
| 48 | + - name: min |
| 49 | + uid: 'ExcelScript!ExcelScript.AggregationFunction.min:member' |
| 50 | + package: ExcelScript! |
| 51 | + summary: 'Aggregate using the minimum value of the data, equivalent to the MIN function.' |
| 52 | + - name: product |
| 53 | + uid: 'ExcelScript!ExcelScript.AggregationFunction.product:member' |
| 54 | + package: ExcelScript! |
| 55 | + summary: 'Aggregate using the product of the data, equivalent to the PRODUCT function.' |
| 56 | + - name: standardDeviation |
| 57 | + uid: 'ExcelScript!ExcelScript.AggregationFunction.standardDeviation:member' |
| 58 | + package: ExcelScript! |
| 59 | + summary: 'Aggregate using the standard deviation of the data, equivalent to the STDEV function.' |
| 60 | + - name: standardDeviationP |
| 61 | + uid: 'ExcelScript!ExcelScript.AggregationFunction.standardDeviationP:member' |
| 62 | + package: ExcelScript! |
| 63 | + summary: 'Aggregate using the standard deviation of the data, equivalent to the STDEVP function.' |
| 64 | + - name: sum |
| 65 | + uid: 'ExcelScript!ExcelScript.AggregationFunction.sum:member' |
| 66 | + package: ExcelScript! |
| 67 | + summary: 'Aggregate using the sum of the data, equivalent to the SUM function.' |
| 68 | + - name: unknown |
| 69 | + uid: 'ExcelScript!ExcelScript.AggregationFunction.unknown:member' |
| 70 | + package: ExcelScript! |
| 71 | + summary: Aggregation function is unknown or unsupported. |
| 72 | + - name: variance |
| 73 | + uid: 'ExcelScript!ExcelScript.AggregationFunction.variance:member' |
| 74 | + package: ExcelScript! |
| 75 | + summary: 'Aggregate using the variance of the data, equivalent to the VAR function.' |
| 76 | + - name: varianceP |
| 77 | + uid: 'ExcelScript!ExcelScript.AggregationFunction.varianceP:member' |
| 78 | + package: ExcelScript! |
| 79 | + summary: 'Aggregate using the variance of the data, equivalent to the VARP function.' |
0 commit comments