Skip to content

[Admin] Publish #381

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
merged 1 commit into from
Jun 6, 2025
Merged

[Admin] Publish #381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
719 changes: 407 additions & 312 deletions docs/docs-ref-autogen/excel/excelscript.yml
View file
Open in desktop

Large diffs are not rendered by default.

158 changes: 79 additions & 79 deletions docs/docs-ref-autogen/excel/excelscript/excelscript.aggregationfunction.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,79 +1,79 @@
### YamlMime:TSEnum
name: ExcelScript.AggregationFunction
uid: 'ExcelScript!ExcelScript.AggregationFunction:enum'
package: ExcelScript!
fullName: ExcelScript.AggregationFunction
summary: Aggregation function for the `DataPivotHierarchy`<!-- -->.
remarks: |-


#### Examples

```TypeScript
/**
* This script changes how the data in a PivotTable is aggregated.
*/
function main(workbook: ExcelScript.Workbook) {
// Get the first PivotTable in the workbook.
const pivotTable = workbook.getPivotTables()[0];

// Set the first data hierarchy to summarize with an average value, instead of a sum.
const dataHierarchy = pivotTable.getDataHierarchies()[0];
dataHierarchy.setSummarizeBy(ExcelScript.AggregationFunction.average);
}
```
isPreview: false
isDeprecated: false
fields:
- name: automatic
uid: 'ExcelScript!ExcelScript.AggregationFunction.automatic:member'
package: ExcelScript!
summary: Excel will automatically select the aggregation based on the data items.
- name: average
uid: 'ExcelScript!ExcelScript.AggregationFunction.average:member'
package: ExcelScript!
summary: 'Aggregate using the average of the data, equivalent to the AVERAGE function.'
- name: count
uid: 'ExcelScript!ExcelScript.AggregationFunction.count:member'
package: ExcelScript!
summary: 'Aggregate using the count of items in the data, equivalent to the COUNTA function.'
- name: countNumbers
uid: 'ExcelScript!ExcelScript.AggregationFunction.countNumbers:member'
package: ExcelScript!
summary: 'Aggregate using the count of numbers in the data, equivalent to the COUNT function.'
- name: max
uid: 'ExcelScript!ExcelScript.AggregationFunction.max:member'
package: ExcelScript!
summary: 'Aggregate using the maximum value of the data, equivalent to the MAX function.'
- name: min
uid: 'ExcelScript!ExcelScript.AggregationFunction.min:member'
package: ExcelScript!
summary: 'Aggregate using the minimum value of the data, equivalent to the MIN function.'
- name: product
uid: 'ExcelScript!ExcelScript.AggregationFunction.product:member'
package: ExcelScript!
summary: 'Aggregate using the product of the data, equivalent to the PRODUCT function.'
- name: standardDeviation
uid: 'ExcelScript!ExcelScript.AggregationFunction.standardDeviation:member'
package: ExcelScript!
summary: 'Aggregate using the standard deviation of the data, equivalent to the STDEV function.'
- name: standardDeviationP
uid: 'ExcelScript!ExcelScript.AggregationFunction.standardDeviationP:member'
package: ExcelScript!
summary: 'Aggregate using the standard deviation of the data, equivalent to the STDEVP function.'
- name: sum
uid: 'ExcelScript!ExcelScript.AggregationFunction.sum:member'
package: ExcelScript!
summary: 'Aggregate using the sum of the data, equivalent to the SUM function.'
- name: unknown
uid: 'ExcelScript!ExcelScript.AggregationFunction.unknown:member'
package: ExcelScript!
summary: Aggregation function is unknown or unsupported.
- name: variance
uid: 'ExcelScript!ExcelScript.AggregationFunction.variance:member'
package: ExcelScript!
summary: 'Aggregate using the variance of the data, equivalent to the VAR function.'
- name: varianceP
uid: 'ExcelScript!ExcelScript.AggregationFunction.varianceP:member'
package: ExcelScript!
summary: 'Aggregate using the variance of the data, equivalent to the VARP function.'
### YamlMime:TSEnum
name: ExcelScript.AggregationFunction
uid: 'ExcelScript!ExcelScript.AggregationFunction:enum'
package: ExcelScript!
fullName: ExcelScript.AggregationFunction
summary: Aggregation function for the `DataPivotHierarchy`<!-- -->.
remarks: |-
#### Examples
```TypeScript
/**
* This script changes how the data in a PivotTable is aggregated.
*/
function main(workbook: ExcelScript.Workbook) {
// Get the first PivotTable in the workbook.
const pivotTable = workbook.getPivotTables()[0];
// Set the first data hierarchy to summarize with an average value, instead of a sum.
const dataHierarchy = pivotTable.getDataHierarchies()[0];
dataHierarchy.setSummarizeBy(ExcelScript.AggregationFunction.average);
}
```
isPreview: false
isDeprecated: false
fields:
- name: automatic
uid: 'ExcelScript!ExcelScript.AggregationFunction.automatic:member'
package: ExcelScript!
summary: Excel will automatically select the aggregation based on the data items.
- name: average
uid: 'ExcelScript!ExcelScript.AggregationFunction.average:member'
package: ExcelScript!
summary: 'Aggregate using the average of the data, equivalent to the AVERAGE function.'
- name: count
uid: 'ExcelScript!ExcelScript.AggregationFunction.count:member'
package: ExcelScript!
summary: 'Aggregate using the count of items in the data, equivalent to the COUNTA function.'
- name: countNumbers
uid: 'ExcelScript!ExcelScript.AggregationFunction.countNumbers:member'
package: ExcelScript!
summary: 'Aggregate using the count of numbers in the data, equivalent to the COUNT function.'
- name: max
uid: 'ExcelScript!ExcelScript.AggregationFunction.max:member'
package: ExcelScript!
summary: 'Aggregate using the maximum value of the data, equivalent to the MAX function.'
- name: min
uid: 'ExcelScript!ExcelScript.AggregationFunction.min:member'
package: ExcelScript!
summary: 'Aggregate using the minimum value of the data, equivalent to the MIN function.'
- name: product
uid: 'ExcelScript!ExcelScript.AggregationFunction.product:member'
package: ExcelScript!
summary: 'Aggregate using the product of the data, equivalent to the PRODUCT function.'
- name: standardDeviation
uid: 'ExcelScript!ExcelScript.AggregationFunction.standardDeviation:member'
package: ExcelScript!
summary: 'Aggregate using the standard deviation of the data, equivalent to the STDEV function.'
- name: standardDeviationP
uid: 'ExcelScript!ExcelScript.AggregationFunction.standardDeviationP:member'
package: ExcelScript!
summary: 'Aggregate using the standard deviation of the data, equivalent to the STDEVP function.'
- name: sum
uid: 'ExcelScript!ExcelScript.AggregationFunction.sum:member'
package: ExcelScript!
summary: 'Aggregate using the sum of the data, equivalent to the SUM function.'
- name: unknown
uid: 'ExcelScript!ExcelScript.AggregationFunction.unknown:member'
package: ExcelScript!
summary: Aggregation function is unknown or unsupported.
- name: variance
uid: 'ExcelScript!ExcelScript.AggregationFunction.variance:member'
package: ExcelScript!
summary: 'Aggregate using the variance of the data, equivalent to the VAR function.'
- name: varianceP
uid: 'ExcelScript!ExcelScript.AggregationFunction.varianceP:member'
package: ExcelScript!
summary: 'Aggregate using the variance of the data, equivalent to the VARP function.'
Loading
Loading