Class DataSourcePivotTable

DataSourcePivotTable

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

该类仅适用于连接到数据库的数据。

方法

方法返回类型简介
addColumnGroup(columnName)PivotGroup根据指定的数据源列添加新的数据透视列组。
addFilter(columnName, filterCriteria)PivotFilter根据指定的数据源列和指定的过滤条件添加一个新的过滤器。
addPivotValue(columnName, summarizeFunction)PivotValue使用指定的汇总函数，根据指定的数据源列添加新的数据透视值。
addRowGroup(columnName)PivotGroup根据指定的数据源列添加新的数据透视行组。
asPivotTable()PivotTable将数据源数据透视表对象作为常规数据透视表对象返回。
forceRefreshData()DataSourcePivotTable刷新此对象的数据，而不考虑当前状态。
getDataSource()DataSource获取对象关联的数据源。
getStatus()DataExecutionStatus获取对象的数据执行状态。
refreshData()DataSourcePivotTable刷新对象的数据。
waitForCompletion(timeoutInSeconds)DataExecutionStatus等待当前执行完成，在提供的秒数后超时。

详细文档

addColumnGroup(columnName)

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

参数

名称类型说明
columnNameString数据透视组所基于的数据源列名称。

弃踢回攻

PivotGroup - 新的数据透视组。

授权

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

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

addFilter(columnName, filterCriteria)

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

参数

名称类型说明
columnNameString过滤器所依据的数据源列名称。
filterCriteriaFilterCriteria过滤器使用的条件。

弃踢回攻

PivotFilter - 新过滤器。

授权

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

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

addPivotValue(columnName, summarizeFunction)

使用指定的汇总函数，根据指定的数据源列添加新的数据透视值。

参数

名称类型说明
columnNameString数据透视值所基于的数据源列名称。
summarizeFunctionPivotTableSummarizeFunction数据透视值使用的汇总函数。

弃踢回攻

PivotValue - 新的数据透视值。

授权

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

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

addRowGroup(columnName)

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

参数

名称类型说明
columnNameString数据透视组所基于的数据源列名称。

弃踢回攻

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

forceRefreshData()

刷新此对象的数据，而不考虑当前状态。如需了解详情，请参阅 refreshData()。

如果数据源类型未启用，则会抛出异常。使用 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()，可防止对数据源进行意外修改。

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

弃踢回攻

DataSourcePivotTable - 数据对象。

授权

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

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

waitForCompletion(timeoutInSeconds)

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

参数

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

弃踢回攻

DataExecutionStatus - 数据执行状态。

授权

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

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