此服务允许脚本创建、访问和修改 Google 表格文件。另请参阅有关在电子表格中存储数据的指南。
有时,为了提高性能,系统会将电子表格操作捆绑在一起,例如在对一个方法进行多次调用时。如果您想确保立即进行所有待更改项(例如,在脚本执行时向用户显示信息),请调用 SpreadsheetApp.flush()
。
类
AutoFillSeries
属性
媒体资源 | 类型 | 说明 |
---|---|---|
DEFAULT_SERIES | Enum | 默认此值。 |
ALTERNATE_SERIES | Enum | 使用此设置自动填充会导致扩展范围内的空白单元格中填充现有值的副本。 |
Banding
方法
BandingTheme
属性
媒体资源 | 类型 | 说明 |
---|---|---|
LIGHT_GREY | Enum | 浅灰色条带主题。 |
CYAN | Enum | 青色条带主题。 |
GREEN | Enum | 绿色条纹主题。 |
YELLOW | Enum | 黄色条纹主题。 |
ORANGE | Enum | 橙色条带主题。 |
BLUE | Enum | 蓝色条带主题。 |
TEAL | Enum | 蓝青色条纹主题。 |
GREY | Enum | 灰色条带主题。 |
BROWN | Enum | 棕色条带主题。 |
LIGHT_GREEN | Enum | 浅绿色条带主题。 |
INDIGO | Enum | 靛蓝色表带主题。 |
PINK | Enum | 粉色条纹主题。 |
BigQueryDataSourceSpec
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | DataSourceSpecBuilder | 根据此数据源的设置创建 DataSourceSpecBuilder 。 |
getDatasetId() | String | 获取 BigQuery 数据集 ID。 |
getParameters() | DataSourceParameter[] | 获取数据源的参数。 |
getProjectId() | String | 获取结算项目 ID。 |
getRawQuery() | String | 获取原始查询字符串。 |
getTableId() | String | 获取 BigQuery 表 ID。 |
getTableProjectId() | String | 获取表的 BigQuery 项目 ID。 |
getType() | DataSourceType | 获取数据源的类型。 |
BigQueryDataSourceSpecBuilder
方法
方法 | 返回类型 | 简介 |
---|---|---|
build() | DataSourceSpec | 根据此构建器中的设置构建数据源规范。 |
copy() | DataSourceSpecBuilder | 根据此数据源的设置创建 DataSourceSpecBuilder 。 |
getDatasetId() | String | 获取 BigQuery 数据集 ID。 |
getParameters() | DataSourceParameter[] | 获取数据源的参数。 |
getProjectId() | String | 获取结算项目 ID。 |
getRawQuery() | String | 获取原始查询字符串。 |
getTableId() | String | 获取 BigQuery 表 ID。 |
getTableProjectId() | String | 获取表的 BigQuery 项目 ID。 |
getType() | DataSourceType | 获取数据源的类型。 |
removeAllParameters() | BigQueryDataSourceSpecBuilder | 移除所有参数。 |
removeParameter(parameterName) | BigQueryDataSourceSpecBuilder | 移除指定的参数。 |
setDatasetId(datasetId) | BigQueryDataSourceSpecBuilder | 设置 BigQuery 数据集 ID。 |
setParameterFromCell(parameterName, sourceCell) | BigQueryDataSourceSpecBuilder | 添加参数,或者,如果具有名称的参数存在,则更新其源单元格。 |
setProjectId(projectId) | BigQueryDataSourceSpecBuilder | 设置结算 BigQuery 项目 ID。 |
setRawQuery(rawQuery) | BigQueryDataSourceSpecBuilder | 设置原始查询字符串。 |
setTableId(tableId) | BigQueryDataSourceSpecBuilder | 设置 BigQuery 表 ID。 |
setTableProjectId(projectId) | BigQueryDataSourceSpecBuilder | 设置表的 BigQuery 项目 ID。 |
BooleanCondition
方法
方法 | 返回类型 | 简介 |
---|---|---|
getBackgroundObject() | Color | 获取此布尔条件的背景颜色。 |
getBold() | Boolean | 如果此布尔条件加粗文本,则返回 true ;如果此布尔条件从文本中移除粗体,则返回 false 。 |
getCriteriaType() | BooleanCriteria | 获取 BooleanCriteria 枚举中定义的规则的条件类型。 |
getCriteriaValues() | Object[] | 获取规则条件的参数数组。 |
getFontColorObject() | Color | 获取此布尔条件的字体颜色。 |
getItalic() | Boolean | 如果此布尔条件将文本设为斜体,则返回 true ;如果此布尔条件从文本中移除斜体,则返回 false 。 |
getStrikethrough() | Boolean | 如果此布尔条件删除文本中,则返回 true ;如果此布尔条件从文本中移除删除线,则返回 false 。 |
getUnderline() | Boolean | 如果此布尔条件为文本添加下划线,则返回 true ;如果此布尔条件从文本中移除下划线,则返回 false 。 |
BooleanCriteria
属性
媒体资源 | 类型 | 说明 |
---|---|---|
CELL_EMPTY | Enum | 当单元格为空时,满足条件。 |
CELL_NOT_EMPTY | Enum | 如果单元格不为空,则满足条件。 |
DATE_AFTER | Enum | 如果日期晚于指定值,则满足条件。 |
DATE_BEFORE | Enum | 如果日期早于指定值,则满足条件。 |
DATE_EQUAL_TO | Enum | 当日期与指定值相等时,满足条件。 |
DATE_NOT_EQUAL_TO | Enum | 如果日期不等于指定值,则满足条件。 |
DATE_AFTER_RELATIVE | Enum | 如果日期晚于相对日期值,则满足条件。 |
DATE_BEFORE_RELATIVE | Enum | 若某个日期早于相对日期值,则满足条件。 |
DATE_EQUAL_TO_RELATIVE | Enum | 当某个日期等于相对日期值时,则满足条件。 |
NUMBER_BETWEEN | Enum | 当某个数字介于指定值之间时,就满足条件。 |
NUMBER_EQUAL_TO | Enum | 当数字等于指定值时,满足条件。 |
NUMBER_GREATER_THAN | Enum | 当某个数字大于指定值时,就满足条件。 |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | 当数字大于或等于指定值时,就满足条件。 |
NUMBER_LESS_THAN | Enum | 当某个数字小于指定值时,就满足条件。 |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | 当数字小于或等于指定值时,就满足条件。 |
NUMBER_NOT_BETWEEN | Enum | 当有数字不在指定值之间时,就满足条件。 |
NUMBER_NOT_EQUAL_TO | Enum | 当数字不等于指定值时,就满足条件。 |
TEXT_CONTAINS | Enum | 如果输入包含给定值,则满足条件。 |
TEXT_DOES_NOT_CONTAIN | Enum | 如果输入值不包含给定值,则满足条件。 |
TEXT_EQUAL_TO | Enum | 当输入值等于指定值时,满足条件。 |
TEXT_NOT_EQUAL_TO | Enum | 当输入不等于指定值时,满足条件。 |
TEXT_STARTS_WITH | Enum | 如果输入开头为指定值,就满足条件。 |
TEXT_ENDS_WITH | Enum | 如果输入内容结尾为指定值,就满足条件。 |
CUSTOM_FORMULA | Enum | 当输入使指定公式的求值结果为 true 时,就满足条件。 |
BorderStyle
属性
媒体资源 | 类型 | 说明 |
---|---|---|
DOTTED | Enum | 虚线边框。 |
DASHED | Enum | 虚线边框。 |
SOLID | Enum | 细实线边框。 |
SOLID_MEDIUM | Enum | 中等实线边框。 |
SOLID_THICK | Enum | 粗实线边框。 |
DOUBLE | Enum | 两条实线边框。 |
CellImage
属性
媒体资源 | 类型 | 说明 |
---|---|---|
valueType | ValueType | 设置为 ValueType.IMAGE 的字段,表示图片值类型。 |
方法
方法 | 返回类型 | 简介 |
---|---|---|
getAltTextDescription() | String | 返回该图片的替代文本说明。 |
getAltTextTitle() | String | 返回该图片的替代文本标题。 |
getContentUrl() | String | 返回图片由 Google 托管的网址。 |
getUrl() | String | 获取图片的来源网址;如果该网址不可用,则返回 null 。 |
toBuilder() | CellImageBuilder | 创建一个构建器,用于将图片转换为图片值类型,以便您可以将其放入单元格。 |
CellImageBuilder
属性
媒体资源 | 类型 | 说明 |
---|---|---|
valueType | ValueType | 设置为 ValueType.IMAGE 的字段,表示图片值类型。 |
方法
方法 | 返回类型 | 简介 |
---|---|---|
build() | CellImage | 创建在单元格中添加图片所需的图片值类型。 |
getAltTextDescription() | String | 返回该图片的替代文本说明。 |
getAltTextTitle() | String | 返回该图片的替代文本标题。 |
getContentUrl() | String | 返回图片由 Google 托管的网址。 |
getUrl() | String | 获取图片的来源网址;如果该网址不可用,则返回 null 。 |
setAltTextDescription(description) | CellImage | 设置此图片的替代文本说明。 |
setAltTextTitle(title) | CellImage | 设置此图片的替代文本标题。 |
setSourceUrl(url) | CellImageBuilder | 设置图片来源网址。 |
toBuilder() | CellImageBuilder | 创建一个构建器,用于将图片转换为图片值类型,以便您可以将其放入单元格。 |
Color
方法
方法 | 返回类型 | 简介 |
---|---|---|
asRgbColor() | RgbColor | 将此颜色转换为 RgbColor 。 |
asThemeColor() | ThemeColor | 将此颜色转换为 ThemeColor 。 |
getColorType() | ColorType | 获取此颜色的类型。 |
ColorBuilder
方法
方法 | 返回类型 | 简介 |
---|---|---|
asRgbColor() | RgbColor | 将此颜色转换为 RgbColor 。 |
asThemeColor() | ThemeColor | 将此颜色转换为 ThemeColor 。 |
build() | Color | 根据提供给构建器的设置创建颜色对象。 |
getColorType() | ColorType | 获取此颜色的类型。 |
setRgbColor(cssString) | ColorBuilder | 设为 RGB 颜色。 |
setThemeColor(themeColorType) | ColorBuilder | 设为主题颜色。 |
ConditionalFormatRule
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | ConditionalFormatRuleBuilder | 返回包含此规则设置的规则生成器预设。 |
getBooleanCondition() | BooleanCondition | 如果此规则使用布尔值条件条件,则检索规则的 BooleanCondition 信息。 |
getGradientCondition() | GradientCondition | 如果此规则使用梯度条件条件,则检索规则的 GradientCondition 信息。 |
getRanges() | Range[] | 检索要应用此条件格式规则的范围。 |
ConditionalFormatRuleBuilder
方法
ContainerInfo
方法
方法 | 返回类型 | 简介 |
---|---|---|
getAnchorColumn() | Integer | 图表的左侧固定在此列中。 |
getAnchorRow() | Integer | 图表的顶部固定在此行中。 |
getOffsetX() | Integer | 图表的左上角相对于锚点列偏移的像素数即为图表的左上角。 |
getOffsetY() | Integer | 图表的左上角相对于锚点行偏移的像素数即为图表的左上角。 |
CopyPasteType
属性
媒体资源 | 类型 | 说明 |
---|---|---|
PASTE_NORMAL | Enum | 粘贴值、公式、格式和合并内容。 |
PASTE_NO_BORDERS | Enum | 粘贴值、公式、格式和合并单元格,但不添加边框。 |
PASTE_FORMAT | Enum | 请仅粘贴格式。 |
PASTE_FORMULA | Enum | 仅粘贴公式。 |
PASTE_DATA_VALIDATION | Enum | 仅粘贴数据验证。 |
PASTE_VALUES | Enum | 仅粘贴值,不要粘贴格式、公式或合并单元格。 |
PASTE_CONDITIONAL_FORMATTING | Enum | 仅粘贴颜色规则。 |
PASTE_COLUMN_WIDTHS | Enum | 仅粘贴列宽。 |
DataExecutionErrorCode
属性
媒体资源 | 类型 | 说明 |
---|---|---|
DATA_EXECUTION_ERROR_CODE_UNSUPPORTED | Enum | Apps 脚本不支持数据执行错误代码。 |
NONE | Enum | 数据执行没有错误。 |
TIME_OUT | Enum | 数据执行超时。 |
TOO_MANY_ROWS | Enum | 数据执行返回的行数超出上限。 |
TOO_MANY_COLUMNS | Enum | 数据执行返回的列数超出上限。 |
TOO_MANY_CELLS | Enum | 数据执行返回的单元数超出上限。 |
ENGINE | Enum | 数据执行引擎错误。 |
PARAMETER_INVALID | Enum | 数据执行参数无效。 |
UNSUPPORTED_DATA_TYPE | Enum | 数据执行返回的数据类型不受支持。 |
DUPLICATE_COLUMN_NAMES | Enum | 数据执行会返回重复的列名称。 |
INTERRUPTED | Enum | 数据执行中断。 |
OTHER | Enum | 其他错误。 |
TOO_MANY_CHARS_PER_CELL | Enum | 数据执行返回的值超出了单个单元格所允许的字符数上限。 |
DATA_NOT_FOUND | Enum | 未找到数据源引用的数据库。 |
PERMISSION_DENIED | Enum | 该用户无权访问数据源引用的数据库。 |
DataExecutionState
属性
媒体资源 | 类型 | 说明 |
---|---|---|
DATA_EXECUTION_STATE_UNSUPPORTED | Enum | Apps 脚本不支持数据执行状态。 |
RUNNING | Enum | 数据执行已开始,正在运行。 |
SUCCESS | Enum | 数据执行已完成并成功。 |
ERROR | Enum | 数据执行已完成,但存在错误。 |
NOT_STARTED | Enum | 数据执行尚未开始。 |
DataExecutionStatus
方法
方法 | 返回类型 | 简介 |
---|---|---|
getErrorCode() | DataExecutionErrorCode | 获取数据执行的错误代码。 |
getErrorMessage() | String | 获取数据执行的错误消息。 |
getExecutionState() | DataExecutionState | 获取数据执行的状态。 |
getLastExecutionTime() | Date | 获取上次数据执行完成的时间,无论执行状态如何。 |
getLastRefreshedTime() | Date | 获取上次成功刷新数据的时间。 |
isTruncated() | Boolean | 如果上次成功执行的数据被截断,则返回 true ,否则返回 false 。 |
DataSource
方法
方法 | 返回类型 | 简介 |
---|---|---|
cancelAllLinkedDataSourceObjectRefreshes() | void | 取消与此数据源关联的数据源对象当前进行的所有刷新操作。 |
createCalculatedColumn(name, formula) | DataSourceColumn | 创建计算列。 |
createDataSourcePivotTableOnNewSheet() | DataSourcePivotTable | 在新工作表的第一个单元格中根据此数据源创建数据源数据透视表。 |
createDataSourceTableOnNewSheet() | DataSourceTable | 在新工作表的第一个单元格中根据此数据源创建数据源表。 |
getCalculatedColumnByName(columnName) | DataSourceColumn | 返回数据源中与列名称匹配的计算列。 |
getCalculatedColumns() | DataSourceColumn[] | 返回数据源中的所有计算列。 |
getColumns() | DataSourceColumn[] | 返回数据源中的所有列。 |
getDataSourceSheets() | DataSourceSheet[] | 返回与此数据源关联的数据源工作表。 |
getSpec() | DataSourceSpec | 获取数据源规范。 |
refreshAllLinkedDataSourceObjects() | void | 刷新与数据源关联的所有数据源对象。 |
updateSpec(spec) | DataSource | 更新数据源规范,并使用新规范刷新与此数据源关联的数据源对象。 |
updateSpec(spec, refreshAllLinkedObjects) | DataSource | 更新数据源规范,并使用新规范刷新关联的 data
source sheets 。 |
waitForAllDataExecutionsCompletion(timeoutInSeconds) | void | 等待关联的数据源对象的所有当前执行都完成,在提供的秒数过后超时。 |
DataSourceChart
方法
方法 | 返回类型 | 简介 |
---|---|---|
cancelDataRefresh() | DataSourceChart | 取消与此对象关联的数据刷新(如果它当前正在运行)。 |
forceRefreshData() | DataSourceChart | 刷新此对象的数据,而不考虑当前状态。 |
getDataSource() | DataSource | 获取对象链接到的数据源。 |
getStatus() | DataExecutionStatus | 获取对象的数据执行状态。 |
refreshData() | DataSourceChart | 刷新对象的数据。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 等待当前执行完成,在提供的秒数后超时。 |
DataSourceColumn
方法
方法 | 返回类型 | 简介 |
---|---|---|
getDataSource() | DataSource | 获取与数据源列关联的数据源。 |
getFormula() | String | 获取数据源列的公式。 |
getName() | String | 获取数据源列的名称。 |
hasArrayDependency() | Boolean | 返回相应列是否具有数组依赖关系。 |
isCalculatedColumn() | Boolean | 返回相应列是否为计算列。 |
remove() | void | 移除数据源列。 |
setFormula(formula) | DataSourceColumn | 设置数据源列的公式。 |
setName(name) | DataSourceColumn | 设置数据源列的名称。 |
DataSourceFormula
方法
方法 | 返回类型 | 简介 |
---|---|---|
cancelDataRefresh() | DataSourceFormula | 取消与此对象关联的数据刷新(如果它当前正在运行)。 |
forceRefreshData() | DataSourceFormula | 刷新此对象的数据,而不考虑当前状态。 |
getAnchorCell() | Range | 返回 Range ,它表示此数据源公式锚定到的单元格。 |
getDataSource() | DataSource | 获取对象链接到的数据源。 |
getDisplayValue() | String | 返回数据源公式的显示值。 |
getFormula() | String | 返回此数据源公式的公式。 |
getStatus() | DataExecutionStatus | 获取对象的数据执行状态。 |
refreshData() | DataSourceFormula | 刷新对象的数据。 |
setFormula(formula) | DataSourceFormula | 更新公式。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 等待当前执行完成,在提供的秒数后超时。 |
DataSourceParameter
方法
方法 | 返回类型 | 简介 |
---|---|---|
getName() | String | 获取参数名称。 |
getSourceCell() | String | 获取评估参数所依据的源单元格,如果参数类型不是 DataSourceParameterType.CELL ,则获取 null 。 |
getType() | DataSourceParameterType | 获取参数类型。 |
DataSourceParameterType
属性
媒体资源 | 类型 | 说明 |
---|---|---|
DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTED | Enum | Apps 脚本不支持数据源参数类型。 |
CELL | Enum | 数据源参数根据单元格赋值。 |
DataSourcePivotTable
方法
方法 | 返回类型 | 简介 |
---|---|---|
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 | 等待当前执行完成,在提供的秒数后超时。 |
DataSourceRefreshSchedule
方法
方法 | 返回类型 | 简介 |
---|---|---|
getFrequency() | DataSourceRefreshScheduleFrequency | 获取刷新时间表频率,该频率指定了刷新的频率和时间。 |
getScope() | DataSourceRefreshScope | 获取此刷新时间表的范围。 |
getTimeIntervalOfNextRun() | TimeInterval | 获取此刷新时间表下次运行的时间范围。 |
isEnabled() | Boolean | 确定是否启用此刷新时间表。 |
DataSourceRefreshScheduleFrequency
方法
方法 | 返回类型 | 简介 |
---|---|---|
getDaysOfTheMonth() | Integer[] | 获取以数字 (1-28) 表示的一个月中的第几天,作为刷新数据源的依据。 |
getDaysOfTheWeek() | Weekday[] | 获取在一周中刷新数据源的天数。 |
getFrequencyType() | FrequencyType | 获取频率类型。 |
getStartHour() | Integer | 获取运行刷新时间表的时间间隔的起始小时(数字 0-23)。 |
DataSourceRefreshScope
属性
媒体资源 | 类型 | 说明 |
---|---|---|
DATA_SOURCE_REFRESH_SCOPE_UNSUPPORTED | Enum | 数据源刷新范围不受支持。 |
ALL_DATA_SOURCES | Enum | 刷新会应用于电子表格中的所有数据源。 |
DataSourceSheet
方法
DataSourceSheetFilter
方法
方法 | 返回类型 | 简介 |
---|---|---|
getDataSourceColumn() | DataSourceColumn | 返回此过滤条件所适用的数据源列。 |
getDataSourceSheet() | DataSourceSheet | 返回此过滤器所属的 DataSourceSheet 。 |
getFilterCriteria() | FilterCriteria | 返回此过滤器的过滤条件。 |
remove() | void | 从数据源对象中移除此过滤条件。 |
setFilterCriteria(filterCriteria) | DataSourceSheetFilter | 设置此过滤器的过滤条件。 |
DataSourceSpec
方法
方法 | 返回类型 | 简介 |
---|---|---|
asBigQuery() | BigQueryDataSourceSpec | 获取 BigQuery 数据源的规范。 |
copy() | DataSourceSpecBuilder | 根据此数据源的设置创建 DataSourceSpecBuilder 。 |
getParameters() | DataSourceParameter[] | 获取数据源的参数。 |
getType() | DataSourceType | 获取数据源的类型。 |
DataSourceSpecBuilder
方法
方法 | 返回类型 | 简介 |
---|---|---|
asBigQuery() | BigQueryDataSourceSpecBuilder | 获取 BigQuery 数据源的构建器。 |
build() | DataSourceSpec | 根据此构建器中的设置构建数据源规范。 |
copy() | DataSourceSpecBuilder | 根据此数据源的设置创建 DataSourceSpecBuilder 。 |
getParameters() | DataSourceParameter[] | 获取数据源的参数。 |
getType() | DataSourceType | 获取数据源的类型。 |
removeAllParameters() | DataSourceSpecBuilder | 移除所有参数。 |
removeParameter(parameterName) | DataSourceSpecBuilder | 移除指定的参数。 |
setParameterFromCell(parameterName, sourceCell) | DataSourceSpecBuilder | 添加参数,或者,如果具有名称的参数存在,则更新其源单元格。 |
DataSourceTable
方法
DataSourceTableColumn
方法
方法 | 返回类型 | 简介 |
---|---|---|
getDataSourceColumn() | DataSourceColumn | 获取数据源列。 |
remove() | void | 从 DataSourceTable 中移除此列。 |
DataSourceTableFilter
方法
方法 | 返回类型 | 简介 |
---|---|---|
getDataSourceColumn() | DataSourceColumn | 返回此过滤条件所适用的数据源列。 |
getDataSourceTable() | DataSourceTable | 返回此过滤器所属的 DataSourceTable 。 |
getFilterCriteria() | FilterCriteria | 返回此过滤器的过滤条件。 |
remove() | void | 从数据源对象中移除此过滤条件。 |
setFilterCriteria(filterCriteria) | DataSourceTableFilter | 设置此过滤器的过滤条件。 |
DataSourceType
属性
媒体资源 | 类型 | 说明 |
---|---|---|
DATA_SOURCE_TYPE_UNSUPPORTED | Enum | Apps 脚本不支持的数据源类型。 |
BIGQUERY | Enum | BigQuery 数据源。 |
DataValidation
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | DataValidationBuilder | 根据此规则的设置,为数据验证规则创建构建器。 |
getAllowInvalid() | Boolean | 如果规则在输入数据验证失败时显示警告,则返回 true ;如果规则完全拒绝输入,则返回 false 。 |
getCriteriaType() | DataValidationCriteria | 获取 DataValidationCriteria 枚举中定义的规则的条件类型。 |
getCriteriaValues() | Object[] | 获取规则条件的参数数组。 |
getHelpText() | String | 获取规则的帮助文本,如果未设置帮助文本,则为 null 。 |
DataValidationBuilder
方法
DataValidationCriteria
属性
媒体资源 | 类型 | 说明 |
---|---|---|
DATE_AFTER | Enum | 要求的日期晚于指定值。 |
DATE_BEFORE | Enum | 要求的日期早于指定值。 |
DATE_BETWEEN | Enum | 要求提供介于指定值之间的日期。 |
DATE_EQUAL_TO | Enum | 要求日期等于指定值。 |
DATE_IS_VALID_DATE | Enum | 需要日期。 |
DATE_NOT_BETWEEN | Enum | 要求的日期不在指定值之间。 |
DATE_ON_OR_AFTER | Enum | 要求的日期不得早于指定值。 |
DATE_ON_OR_BEFORE | Enum | 要求的日期不得晚于指定值。 |
NUMBER_BETWEEN | Enum | 需要介于指定值之间的数字。 |
NUMBER_EQUAL_TO | Enum | 要求一个等于指定值的数字。 |
NUMBER_GREATER_THAN | Enum | 要求输入大于指定值的数字。 |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | 要求输入大于或等于指定值的数字。 |
NUMBER_LESS_THAN | Enum | 要求小于指定值的数字。 |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | 要求小于或等于指定值的数字。 |
NUMBER_NOT_BETWEEN | Enum | 需要一个不介于指定值之间的数字。 |
NUMBER_NOT_EQUAL_TO | Enum | 要求输入不等于指定值的数字。 |
TEXT_CONTAINS | Enum | 要求输入中包含指定值。 |
TEXT_DOES_NOT_CONTAIN | Enum | 要求输入值不包含指定值。 |
TEXT_EQUAL_TO | Enum | 要求输入等于指定值。 |
TEXT_IS_VALID_EMAIL | Enum | 要求以电子邮件地址的形式输入内容。 |
TEXT_IS_VALID_URL | Enum | 要求以网址的形式输入。 |
VALUE_IN_LIST | Enum | 要求输入值等于某个指定值。 |
VALUE_IN_RANGE | Enum | 要求输入值等于指定范围内的值。 |
CUSTOM_FORMULA | Enum | 要求输入使给定公式的计算结果为 true 。 |
CHECKBOX | Enum | 要求输入是自定义值或布尔值;呈现为复选框。 |
DateTimeGroupingRule
方法
方法 | 返回类型 | 简介 |
---|---|---|
getRuleType() | DateTimeGroupingRuleType | 获取日期时间分组规则的类型。 |
DateTimeGroupingRuleType
属性
媒体资源 | 类型 | 说明 |
---|---|---|
UNSUPPORTED | Enum | 不支持的日期时间分组规则类型。 |
SECOND | Enum | 按秒对日期时间进行分组,范围为 0 到 59。 |
MINUTE | Enum | 按分钟对日期时间进行分组,范围为 0 到 59。 |
HOUR | Enum | 使用 24 小时制,按小时对日期时间进行分组,范围为 0 到 23。 |
HOUR_MINUTE | Enum | 使用 24 小时制按小时和分钟对日期时间进行分组,例如 19:45 。 |
HOUR_MINUTE_AMPM | Enum | 使用 12 小时制按小时和分钟对日期时间进行分组,例如 7:45 PM 。 |
DAY_OF_WEEK | Enum | 按星期几对日期时间进行分组,例如 Sunday 。 |
DAY_OF_YEAR | Enum | 按一年中的第几天对日期时间进行分组,范围为 1 到 366。 |
DAY_OF_MONTH | Enum | 按一个月中的第几天对日期时间进行分组,范围为 1 到 31。 |
DAY_MONTH | Enum | 按日和月对日期时间进行分组,例如 22-Nov 。 |
MONTH | Enum | 按月对日期时间进行分组,例如 Nov 。 |
QUARTER | Enum | 按季度对日期时间进行分组,例如 Q1(表示 1 月到 3 月)。 |
YEAR | Enum | 按年份对日期时间进行分组,例如 2008。 |
YEAR_MONTH | Enum | 按年和月对日期时间进行分组,例如 2008-Nov 。 |
YEAR_QUARTER | Enum | 按年份和季度对日期时间进行分组,例如 2008 Q4 。 |
YEAR_MONTH_DAY | Enum | 按年、月、日对日期时间进行分组,例如 2008-11-22 。 |
DeveloperMetadata
方法
方法 | 返回类型 | 简介 |
---|---|---|
getId() | Integer | 返回与此开发者元数据关联的唯一 ID。 |
getKey() | String | 返回与此开发者元数据关联的密钥。 |
getLocation() | DeveloperMetadataLocation | 返回此开发者元数据的位置。 |
getValue() | String | 返回与此开发者元数据关联的值,如果此元数据没有值,则返回 null 。 |
getVisibility() | DeveloperMetadataVisibility | 返回此开发者元数据的可见性。 |
moveToColumn(column) | DeveloperMetadata | 将此开发者元数据移至指定列。 |
moveToRow(row) | DeveloperMetadata | 将此开发者元数据移至指定行。 |
moveToSheet(sheet) | DeveloperMetadata | 将此开发者元数据移动到指定的工作表。 |
moveToSpreadsheet() | DeveloperMetadata | 将此开发者元数据移至顶级电子表格。 |
remove() | void | 用于删除此元数据。 |
setKey(key) | DeveloperMetadata | 将此开发者元数据的键设为指定值。 |
setValue(value) | DeveloperMetadata | 将与此开发者元数据关联的值设置为指定值。 |
setVisibility(visibility) | DeveloperMetadata | 将此开发者元数据的可见性设置为指定的可见性。 |
DeveloperMetadataFinder
方法
方法 | 返回类型 | 简介 |
---|---|---|
find() | DeveloperMetadata[] | 执行此搜索并返回匹配的元数据。 |
onIntersectingLocations() | DeveloperMetadataFinder | 将搜索配置为考虑与具有元数据的位置相交。 |
withId(id) | DeveloperMetadataFinder | 限制此搜索仅考虑与指定 ID 匹配的元数据。 |
withKey(key) | DeveloperMetadataFinder | 限制此搜索仅考虑与指定键匹配的元数据。 |
withLocationType(locationType) | DeveloperMetadataFinder | 限制此搜索仅考虑与指定位置类型匹配的元数据。 |
withValue(value) | DeveloperMetadataFinder | 限制此搜索仅考虑与指定值匹配的元数据。 |
withVisibility(visibility) | DeveloperMetadataFinder | 限制此搜索仅考虑与指定的可见性匹配的元数据。 |
DeveloperMetadataLocation
方法
方法 | 返回类型 | 简介 |
---|---|---|
getColumn() | Range | 返回此元数据列位置的 Range ,如果位置类型不是 DeveloperMetadataLocationType.COLUMN ,则返回 null 。 |
getLocationType() | DeveloperMetadataLocationType | 获取位置类型。 |
getRow() | Range | 返回此元数据行位置的 Range ,如果位置类型不是 DeveloperMetadataLocationType.ROW ,则返回 null 。 |
getSheet() | Sheet | 返回此元数据的 Sheet 位置,如果位置类型不是 DeveloperMetadataLocationType.SHEET ,则返回 null 。 |
getSpreadsheet() | Spreadsheet | 返回此元数据的 Spreadsheet 位置,如果位置类型不是 DeveloperMetadataLocationType.SPREADSHEET ,则返回 null 。 |
DeveloperMetadataLocationType
属性
媒体资源 | 类型 | 说明 |
---|---|---|
SPREADSHEET | Enum | 与顶级电子表格关联的开发者元数据的位置类型。 |
SHEET | Enum | 与整个工作表关联的开发者元数据的位置类型。 |
ROW | Enum | 与行关联的开发者元数据的位置类型。 |
COLUMN | Enum | 与列关联的开发者元数据的位置类型。 |
DeveloperMetadataVisibility
属性
媒体资源 | 类型 | 说明 |
---|---|---|
DOCUMENT | Enum | 任何有权访问文档的开发者项目都可以访问文档可见的元数据。 |
PROJECT | Enum | 项目可见的元数据仅对创建该元数据的开发者项目可见,并且可供其访问。 |
Dimension
属性
媒体资源 | 类型 | 说明 |
---|---|---|
COLUMNS | Enum | “列”(行业)维度。 |
ROWS | Enum | 行(水平)维度。 |
Direction
属性
媒体资源 | 类型 | 说明 |
---|---|---|
UP | Enum | 行索引降序的方向。 |
DOWN | Enum | 行索引递增的方向。 |
PREVIOUS | Enum | 列索引降序的方向。 |
NEXT | Enum | 列索引增加的方向。 |
Drawing
方法
方法 | 返回类型 | 简介 |
---|---|---|
getContainerInfo() | ContainerInfo | 获取关于绘图在工作表中位置的信息。 |
getHeight() | Integer | 返回此绘图的实际高度(以像素为单位)。 |
getOnAction() | String | 返回附加到此绘图的宏的名称。 |
getSheet() | Sheet | 返回显示此绘图的工作表。 |
getWidth() | Integer | 返回此绘图的实际宽度(以像素为单位)。 |
getZIndex() | Number | 返回该绘图的 Z-index。 |
remove() | void | 从电子表格中删除此绘图。 |
setHeight(height) | Drawing | 设置此绘图的实际高度(以像素为单位)。 |
setOnAction(macroName) | Drawing | 用于为此绘图分配一个宏函数。 |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | Drawing | 设置绘图在工作表中的显示位置。 |
setWidth(width) | Drawing | 设置此绘图的实际宽度(以像素为单位)。 |
setZIndex(zIndex) | Drawing | 设置此绘图的 Z-index。 |
EmbeddedAreaChartBuilder
方法
EmbeddedBarChartBuilder
方法
EmbeddedChart
方法
方法 | 返回类型 | 简介 |
---|---|---|
asDataSourceChart() | DataSourceChart | 如果图表是数据源图表,则转换为数据源图表实例,否则转换为 null 。 |
getAs(contentType) | Blob | 返回此对象内的数据,作为转换为指定内容类型的 blob 类型。 |
getBlob() | Blob | 将此对象内的数据作为 blob 返回。 |
getChartId() | Integer | 返回图表的稳定标识符,该标识符在包含该图表的电子表格中具有唯一性;如果图表不在电子表格中,则返回 null 。 |
getContainerInfo() | ContainerInfo | 返回有关图表在工作表中的位置的信息。 |
getHiddenDimensionStrategy() | ChartHiddenDimensionStrategy | 返回用于处理隐藏行和列的策略。 |
getMergeStrategy() | ChartMergeStrategy | 返回在多个范围存在时使用的合并策略。 |
getNumHeaders() | Integer | 返回范围内被视为标题的行数或列数。 |
getOptions() | ChartOptions | 返回此图表的选项,例如高度、颜色和轴。 |
getRanges() | Range[] | 返回此图表用作数据源的范围。 |
getTransposeRowsAndColumns() | Boolean | 如果为 true ,系统会切换用于填充图表的行和列。 |
modify() | EmbeddedChartBuilder | 返回可用于修改此图表的 EmbeddedChartBuilder 。 |
EmbeddedChartBuilder
方法
EmbeddedColumnChartBuilder
方法
EmbeddedComboChartBuilder
方法
EmbeddedHistogramChartBuilder
方法
EmbeddedLineChartBuilder
方法
EmbeddedPieChartBuilder
方法
EmbeddedScatterChartBuilder
方法
EmbeddedTableChartBuilder
方法
Filter
方法
方法 | 返回类型 | 简介 |
---|---|---|
getColumnFilterCriteria(columnPosition) | FilterCriteria | 获取指定列的过滤条件;如果此列没有应用过滤条件,则为 null 。 |
getRange() | Range | 获取此过滤条件适用的范围。 |
remove() | void | 移除此过滤器。 |
removeColumnFilterCriteria(columnPosition) | Filter | 从指定列中移除过滤条件。 |
setColumnFilterCriteria(columnPosition, filterCriteria) | Filter | 设置指定列的过滤条件。 |
sort(columnPosition, ascending) | Filter | 按指定列对过滤范围进行排序,但不包括此过滤器适用的范围内的第一行(标题行)。 |
FilterCriteria
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | FilterCriteriaBuilder | 复制此过滤条件并创建可应用于其他过滤条件的条件构建器。 |
getCriteriaType() | BooleanCriteria | 返回条件的布尔值类型,例如 CELL_EMPTY 。 |
getCriteriaValues() | Object[] | 返回布尔值条件的一个参数数组。 |
getHiddenValues() | String[] | 返回过滤条件隐藏的值。 |
getVisibleBackgroundColor() | Color | 返回用作过滤条件的背景颜色。 |
getVisibleForegroundColor() | Color | 返回用作过滤条件的前景色。 |
getVisibleValues() | String[] | 返回数据透视表过滤器显示的值。 |
FilterCriteriaBuilder
方法
FrequencyType
属性
媒体资源 | 类型 | 说明 |
---|---|---|
FREQUENCY_TYPE_UNSUPPORTED | Enum | 频率类型不受支持。 |
DAILY | Enum | 每天刷新。 |
WEEKLY | Enum | 每周刷新(每周的指定日期)。 |
MONTHLY | Enum | 每月在特定日期刷新一次。 |
GradientCondition
方法
方法 | 返回类型 | 简介 |
---|---|---|
getMaxColorObject() | Color | 获取为此渐变条件的最大值设置的颜色。 |
getMaxType() | InterpolationType | 获取此渐变条件最大值的插值类型。 |
getMaxValue() | String | 获取此梯度条件的最大值。 |
getMidColorObject() | Color | 获取为此渐变条件的中点值设置的颜色。 |
getMidType() | InterpolationType | 获取此梯度条件的中点值的插值类型。 |
getMidValue() | String | 获取此梯度条件的中点值。 |
getMinColorObject() | Color | 获取为此渐变条件的最小值设置的颜色。 |
getMinType() | InterpolationType | 获取此梯度条件的最小值的插值类型。 |
getMinValue() | String | 获取此梯度条件的最小值。 |
Group
方法
方法 | 返回类型 | 简介 |
---|---|---|
collapse() | Group | 收起此群组。 |
expand() | Group | 展开此组。 |
getControlIndex() | Integer | 返回该组的控件切换索引。 |
getDepth() | Integer | 返回该组的深度。 |
getRange() | Range | 返回此组所在的范围。 |
isCollapsed() | Boolean | 如果此群组已收起,则返回 true 。 |
remove() | void | 从工作表中移除该组,从而将 range 的组深度减少 1。 |
GroupControlTogglePosition
属性
媒体资源 | 类型 | 说明 |
---|---|---|
BEFORE | Enum | 控件切换开关在群组之前的位置(索引位置较低)。 |
AFTER | Enum | 控件切换开关在组之后的位置(索引处较高的位置)。 |
InterpolationType
属性
媒体资源 | 类型 | 说明 |
---|---|---|
NUMBER | Enum | 将该数字用作梯度条件的具体插值点。 |
PERCENT | Enum | 将数字用作梯度条件的百分比插值点。 |
PERCENTILE | Enum | 将数字用作梯度条件的百分位插值点。 |
MIN | Enum | 将最小值推断为梯度条件的特定插值。 |
MAX | Enum | 将最大值推断为梯度条件的特定插值。 |
NamedRange
方法
方法 | 返回类型 | 简介 |
---|---|---|
getName() | String | 获取此命名范围的名称。 |
getRange() | Range | 获取此命名范围引用的范围。 |
remove() | void | 删除此命名范围。 |
setName(name) | NamedRange | 设置/更新命名范围的名称。 |
setRange(range) | NamedRange | 设置/更新此命名范围的范围。 |
OverGridImage
方法
PageProtection
PivotFilter
方法
方法 | 返回类型 | 简介 |
---|---|---|
getFilterCriteria() | FilterCriteria | 返回此数据透视过滤器的过滤条件。 |
getPivotTable() | PivotTable | 返回此过滤器所属的 PivotTable 。 |
getSourceDataColumn() | Integer | 返回执行此过滤条件的源数据列的数量。 |
getSourceDataSourceColumn() | DataSourceColumn | 返回执行过滤条件的数据源列。 |
remove() | void | 从数据透视表中移除此数据透视表过滤器。 |
setFilterCriteria(filterCriteria) | PivotFilter | 设置此数据透视过滤器的过滤条件。 |
PivotGroup
方法
方法 | 返回类型 | 简介 |
---|---|---|
addManualGroupingRule(groupName, groupMembers) | PivotGroup | 为此数据透视组添加手动分组规则。 |
areLabelsRepeated() | Boolean | 返回标签是否显示为重复项。 |
clearGroupingRule() | PivotGroup | 从此数据透视组中移除任何分组规则。 |
clearSort() | PivotGroup | 移除对此群组应用的任何排序。 |
getDateTimeGroupingRule() | DateTimeGroupingRule | 返回数据透视组的日期时间分组规则或 null (如果未设置日期时间分组规则)。 |
getDimension() | Dimension | 返回指定的是行组还是列组。 |
getGroupLimit() | PivotGroupLimit | 返 |