Class DataSourcePivotTable

DataSourcePivotTable

访问和修改现有数据源数据透视表。要创建新的数据源数据透视表，请使用 Range.createDataSourcePivotTable(dataSource)。

此类只能用于处理连接到数据库的数据。

方法

方法	返回类型	简介
addColumnGroup(columnName)	PivotGroup	根据指定的数据源列添加新的数据透视列组。
addFilter(columnName, filterCriteria)	PivotFilter	根据指定的数据源列和指定的过滤条件添加新过滤器。
addPivotValue(columnName, summarizeFunction)	PivotValue	根据具有指定摘要的指定数据源列添加新的数据透视值 函数。
addRowGroup(columnName)	PivotGroup	根据指定的数据源列添加新的数据透视表行组。
asPivotTable()	PivotTable	将数据源数据透视表作为常规数据透视表对象返回。
cancelDataRefresh()	DataSourcePivotTable	取消与此对象关联的数据刷新（如果此对象当前正在运行）。
forceRefreshData()	DataSourcePivotTable	无论当前状态如何，都刷新此对象的数据。
getDataSource()	DataSource	获取对象链接到的数据源。
getStatus()	DataExecutionStatus	获取对象的数据执行状态。
refreshData()	DataSourcePivotTable	刷新对象数据。
waitForCompletion(timeoutInSeconds)	DataExecutionStatus	等待当前执行完成，在提供的秒数后超时。

详细文档

addColumnGroup(columnName)

根据指定的数据源列添加新的数据透视列组。

参数

名称	类型	说明
columnName	String	数据透视表元素组所依据的数据源列名称。

返回

PivotGroup - 新的数据透视表元素组。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

addFilter(columnName, filterCriteria)

根据指定的数据源列和指定的过滤条件添加新过滤器。

参数

名称	类型	说明
columnName	String	过滤器所依据的数据源列名称。
filterCriteria	FilterCriteria	过滤器使用的条件。

返回

PivotFilter - 新过滤器。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

addPivotValue(columnName, summarizeFunction)

根据具有指定摘要的指定数据源列添加新的数据透视值 函数。

参数

名称	类型	说明
columnName	String	数据透视值所依据的数据源列名称。
summarizeFunction	PivotTableSummarizeFunction	透视值使用的汇总函数。

返回

PivotValue - 新的数据透视值。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

addRowGroup(columnName)

根据指定的数据源列添加新的数据透视表行组。

参数

名称	类型	说明
columnName	String	数据透视表元素组所依据的数据源列名称。

返回

PivotGroup - 新的数据透视表元素组。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

asPivotTable()

将数据源数据透视表作为常规数据透视表对象返回。

返回

PivotTable - 数据透视表。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

cancelDataRefresh()

取消与此对象关联的数据刷新（如果此对象当前正在运行）。

以下示例展示了如何取消公式刷新。

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

如果数据源类型未启用，则会抛出异常。使用 SpreadsheetApp#enable...Execution() 方法为特定数据源启用数据执行 类型。

返回

DataSourcePivotTable - 数据对象。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

forceRefreshData()

无论当前状态如何，都刷新此对象的数据。查看refreshData() 。如果您想取消此对象当前正在运行的刷新，请参阅 cancelDataRefresh()。

如果数据源类型未启用，则会抛出异常。使用 SpreadsheetApp#enable...Execution() 方法为特定数据源启用数据执行 类型。

返回

DataSourcePivotTable - 数据对象。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getDataSource()

获取对象链接到的数据源。

返回

DataSource - 数据源。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getStatus()

获取对象的数据执行状态。

返回

DataExecutionStatus - 数据执行状态。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

refreshData()

刷新对象数据。

如果当前处于 error 状态，则会抛出异常。使用 DataSource#updateSpec() 更新规范。方法为 与 forceRefreshData() 相比，建议使用 forceRefreshData()，以防止对数据源进行意外修改。

如果数据源类型未启用，则会抛出异常。使用 SpreadsheetApp#enable...Execution() 方法为特定数据源启用数据执行 类型。

返回

DataSourcePivotTable - 数据对象。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

waitForCompletion(timeoutInSeconds)

等待当前执行完成，在提供的秒数后超时。 如果在超时时未完成执行，则会抛出异常，但不会取消 数据执行。

参数

名称	类型	说明
timeoutInSeconds	Integer	等待数据执行的时间，以秒为单位。最大值为 300 。

返回

DataExecutionStatus - 数据执行状态。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets