访问和修改现有数据源图表。
此类只能用于处理连接到数据库的数据。
方法
方法 | 返回类型 | 简介 |
---|---|---|
cancelDataRefresh() | DataSourceChart | 取消与此对象关联的数据刷新(如果此对象当前正在运行)。 |
forceRefreshData() | DataSourceChart | 无论当前状态如何,都刷新此对象的数据。 |
getDataSource() | DataSource | 获取对象链接到的数据源。 |
getStatus() | DataExecutionStatus | 获取对象的数据执行状态。 |
refreshData() | DataSourceChart | 刷新对象数据。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 等待当前执行完成,在提供的秒数后超时。 |
详细文档
cancelDataRefresh()
取消与此对象关联的数据刷新(如果此对象当前正在运行)。
以下示例展示了如何取消公式刷新。
const spreadsheet = SpreadsheetApp.getActive(); const formula = spreadsheet.getDataSourceFormulas()[0]; // Cancel the ongoing refresh on the formula. formula.cancelDataRefresh();
如果数据源类型未启用,则会抛出异常。使用
SpreadsheetApp#enable...Execution()
方法为特定数据源启用数据执行
类型。
返回
DataSourceChart
- 数据对象。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
无论当前状态如何,都刷新此对象的数据。查看refreshData()
。如果您想取消此对象当前正在运行的刷新,请参阅 cancelDataRefresh()
。
如果数据源类型未启用,则会抛出异常。使用 SpreadsheetApp#enable...Execution()
方法为特定数据源启用数据执行
类型。
返回
DataSourceChart
- 数据对象。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
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()
方法为特定数据源启用数据执行
类型。
返回
DataSourceChart
- 数据对象。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
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