Class DataSourceSheet

DataSourceSheet

访问和修改现有数据源工作表。如需创建新的数据源表格,请使用 Spreadsheet.insertDataSourceSheet(spec)

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

方法

方法返回类型简介
addFilter(columnName, filterCriteria)DataSourceSheet添加应用于数据源工作表的过滤条件。
asSheet()Sheet将数据源工作表作为常规工作表对象返回。
autoResizeColumn(columnName)DataSourceSheet自动调整指定列的宽度。
autoResizeColumns(columnNames)DataSourceSheet自动调整指定列的宽度。
forceRefreshData()DataSourceSheet刷新此对象的数据,而不考虑当前状态。
getColumnWidth(columnName)Integer返回指定列的宽度。
getDataSource()DataSource获取对象关联的数据源。
getFilters()DataSourceSheetFilter[]返回应用于数据源工作表的所有过滤器。
getSheetValues(columnName)Object[]返回数据源表格中指定列名称的所有值。
getSheetValues(columnName, startRow, numRows)Object[]返回所提供列名称的数据源工作表中从提供的起始行(基于 1)到提供的 numRows 的所有值。
getSortSpecs()SortSpec[]获取数据源工作表中的所有排序规范。
getStatus()DataExecutionStatus获取对象的数据执行状态。
refreshData()DataSourceSheet刷新对象的数据。
removeFilters(columnName)DataSourceSheet移除应用于数据源工作表列的所有过滤条件。
removeSortSpec(columnName)DataSourceSheet移除数据源工作表中列的排序规范。
setColumnWidth(columnName, width)DataSourceSheet设置指定列的宽度。
setColumnWidths(columnNames, width)DataSourceSheet设置指定列的宽度。
setSortSpec(columnName, ascending)DataSourceSheet为数据源工作表中的列设置排序规范。
setSortSpec(columnName, sortOrder)DataSourceSheet为数据源工作表中的列设置排序规范。
waitForCompletion(timeoutInSeconds)DataExecutionStatus等待当前执行完成,在提供的秒数后超时。

详细文档

addFilter(columnName, filterCriteria)

添加应用于数据源工作表的过滤条件。

参数

名称类型说明
columnNameString要应用此过滤条件的列的名称。
filterCriteriaFilterCriteria要应用的过滤条件。

弃踢回攻

DataSourceSheet - 数据源工作表,用于方法链接。

授权

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

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

asSheet()

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

弃踢回攻

Sheet - 常规工作表。

授权

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

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

autoResizeColumn(columnName)

自动调整指定列的宽度。

参数

名称类型说明
columnNameString列名称。

弃踢回攻

DataSourceSheet - 此数据源工作表,用于链接。

授权

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

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

autoResizeColumns(columnNames)

自动调整指定列的宽度。

参数

名称类型说明
columnNamesString[]要更新的列名称的列表。

弃踢回攻

DataSourceSheet - 此数据源工作表,用于链接。

授权

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

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

forceRefreshData()

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

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

弃踢回攻

DataSourceSheet - 数据对象。

授权

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

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

getColumnWidth(columnName)

返回指定列的宽度。

参数

名称类型说明
columnNameString列名称。

弃踢回攻

Integer - 列的宽度,如果列使用默认宽度,则为 null

授权

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

  • 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

getFilters()

返回应用于数据源工作表的所有过滤器。

弃踢回攻

DataSourceSheetFilter[] - 应用于数据源工作表的所有过滤器的数组。

授权

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

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

getSheetValues(columnName)

返回数据源表格中指定列名称的所有值。

参数

名称类型说明
columnNameString要获取其值的数据源列名称。

弃踢回攻

Object[] - 一维值的数组。

授权

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

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

getSheetValues(columnName, startRow, numRows)

返回所提供列名称的数据源工作表中从提供的起始行(基于 1)到提供的 numRows 的所有值。

参数

名称类型说明
columnNameString要获取其值的数据源列名称。
startRowInteger要从中提取值的行位置。
numRowsInteger要获取的行数。

弃踢回攻

Object[] - 一维值的数组。

授权

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

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

getSortSpecs()

获取数据源工作表中的所有排序规范。

弃踢回攻

SortSpec[] - 排序规范列表。

授权

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

  • 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() 方法可针对特定数据源类型启用数据执行。

弃踢回攻

DataSourceSheet - 数据对象。

授权

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

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

removeFilters(columnName)

移除应用于数据源工作表列的所有过滤条件。

参数

名称类型说明
columnNameString要从中移除过滤条件的列的名称。

弃踢回攻

DataSourceSheet - 数据源工作表,用于方法链接。

授权

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

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

removeSortSpec(columnName)

移除数据源工作表中列的排序规范。

参数

名称类型说明
columnNameString列的名称。

弃踢回攻

DataSourceSheet - 用于链接的数据源工作表。

授权

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

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

setColumnWidth(columnName, width)

设置指定列的宽度。

参数

名称类型说明
columnNameString列名称。
widthInteger列的新宽度。

弃踢回攻

DataSourceSheet - 此数据源工作表,用于链接。

授权

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

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

setColumnWidths(columnNames, width)

设置指定列的宽度。

参数

名称类型说明
columnNamesString[]要更新的列名称的列表。
widthInteger列的新宽度。

弃踢回攻

DataSourceSheet - 此数据源工作表,用于链接。

授权

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

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

setSortSpec(columnName, ascending)

为数据源工作表中的列设置排序规范。

参数

名称类型说明
columnNameString要排序的列的名称。
ascendingBoolean如果为 true,则按升序对列排序;如果为 false,则按降序对列排序。

弃踢回攻

DataSourceSheet - 用于链接的数据源工作表。

授权

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

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

setSortSpec(columnName, sortOrder)

为数据源工作表中的列设置排序规范。

参数

名称类型说明
columnNameString要排序的列的名称。
sortOrderSortOrder排序顺序。

弃踢回攻

DataSourceSheet - 用于链接的数据源工作表。

授权

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

  • 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