此服务允许脚本创建、访问和修改 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 | 添加参数;如果存在具有该名称的参数,则更新类型为 DataSourceType.BIGQUERY 的数据源规范构建器的来源单元格。 |
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) | PivotValue | 基于指定的数据源列添加新的透视值,而无需任何汇总函数。 |
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 数据源的规范。 |
asLooker() | LookerDataSourceSpec | 获取 Looker 数据源的规范。 |
copy() | DataSourceSpecBuilder | 根据此数据源的设置创建 DataSourceSpecBuilder 。 |
getParameters() | DataSourceParameter[] | 获取数据源的参数。 |
getType() | DataSourceType | 获取数据源的类型。 |
DataSourceSpecBuilder
方法
方法 | 返回类型 | 简介 |
---|---|---|
asBigQuery() | BigQueryDataSourceSpecBuilder | 获取 BigQuery 数据源的构建器。 |
asLooker() | LookerDataSourceSpecBuilder | 获取 Looker 数据源的构建器。 |
build() | DataSourceSpec | 根据此构建器中的设置构建数据源规范。 |
copy() | DataSourceSpecBuilder | 根据此数据源的设置创建 DataSourceSpecBuilder 。 |
getParameters() | DataSourceParameter[] | 获取数据源的参数。 |
getType() | DataSourceType | 获取数据源的类型。 |
removeAllParameters() | DataSourceSpecBuilder | 移除所有参数。 |
removeParameter(parameterName) | DataSourceSpecBuilder | 移除指定的参数。 |
setParameterFromCell(parameterName, sourceCell) | DataSourceSpecBuilder | 添加参数;如果存在具有该名称的参数,则更新类型为 DataSourceType.BIGQUERY 的数据源规范构建器的来源单元格。 |
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 数据源。 |
LOOKER | Enum | Looker 数据源。 |
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 | 按季度对日期时间进行分组,例如第 1 季度(表示 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 轴索引。 |
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 | 将最大值推断为梯度条件的特定插值点。 |
LookerDataSourceSpec
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | DataSourceSpecBuilder | 根据此数据源的设置创建 DataSourceSpecBuilder 。 |
getExploreName() | String | 获取模型中的 Looker 探索的名称。 |
getInstanceUrl() | String | 获取 Looker 实例的网址。 |
getModelName() | String | 获取实例中 Looker 模型的名称。 |
getParameters() | DataSourceParameter[] | 获取数据源的参数。 |
getType() | DataSourceType | 获取数据源的类型。 |
LookerDataSourceSpecBuilder
方法
方法 | 返回类型 | 简介 |
---|---|---|
build() | DataSourceSpec | 根据此构建器中的设置构建数据源规范。 |
copy() | DataSourceSpecBuilder | 根据此数据源的设置创建 DataSourceSpecBuilder 。 |
getExploreName() | String | 获取模型中 Looker 探索的名称。 |
getInstanceUrl() | String | 获取 Looker 实例的网址。 |
getModelName() | String | 获取实例中 Looker 模型的名称。 |
getParameters() | DataSourceParameter[] | 获取数据源的参数。 |
getType() | DataSourceType | 获取数据源的类型。 |
removeAllParameters() | LookerDataSourceSpecBuilder | 移除所有参数。 |
removeParameter(parameterName) | LookerDataSourceSpecBuilder | 移除指定的参数。 |
setExploreName(exploreName) | LookerDataSourceSpecBuilder | 设置 Looker 模型中的探索名称。 |
setInstanceUrl(instanceUrl) | LookerDataSourceSpecBuilder | 设置 Looker 的实例网址。 |
setModelName(modelName) | LookerDataSourceSpecBuilder | 在 Looker 实例中设置 Looker 模型名称。 |
setParameterFromCell(parameterName, sourceCell) | LookerDataSourceSpecBuilder | 添加参数;如果存在具有该名称的参数,则更新类型为 DataSourceType.BIGQUERY 的数据源规范构建器的来源单元格。 |
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
方法
PivotGroupLimit
方法
方法 | 返回类型 | 简介 |
---|---|---|
getCountLimit() | Integer | 获取数据透视组中行或列的计数限制。 |
getPivotGroup() | PivotGroup | 返回限制所属的数据透视表组。 |
remove() | void | 移除了数据透视表元素组限制。 |
setCountLimit(countLimit) | PivotGroupLimit | 为数据透视组中的行或列设置计数限制。 |
PivotTable
方法
方法 | 返回类型 | 简介 |
---|---|---|
addCalculatedPivotValue(name, formula) | PivotValue | 在数据透视表中创建一个新的透视值,该值是使用指定的 name 从指定的 formula 计算得出的。 |
addColumnGroup(sourceDataColumn) | PivotGroup | 定义数据透视表中新的数据透视表列分组。 |
addFilter(sourceDataColumn, filterCriteria) | PivotFilter | 为数据透视表创建新的数据透视表过滤器。 |
addPivotValue(sourceDataColumn, summarizeFunction) | PivotValue | 使用指定的 summarizeFunction 在数据透视表中定义新的透视值。 |
addRowGroup(sourceDataColumn) | PivotGroup | 在数据透视表中定义新的透视表行分组。 |
asDataSourcePivotTable() | DataSourcePivotTable | 如果数据透视表已关联到 DataSource ,则将其作为数据源数据透视表返回;否则,返回 null 。 |
getAnchorCell() | Range | 返回表示此数据透视表锚定的单元格的 Range 。 |
getColumnGroups() | PivotGroup[] | 返回此数据透视表中列组的有序列表。 |
getFilters() | PivotFilter[] | 返回此数据透视表中过滤器的有序列表。 |
getPivotValues() | PivotValue[] | 返回此数据透视表中数据透视值的有序列表。 |
getRowGroups() | PivotGroup[] | 返回此数据透视表中行组的有序列表。 |
getSourceDataRange() | Range | 返回用于构建数据透视表的源数据范围。 |
getValuesDisplayOrientation() | Dimension | 返回值是显示为行还是列。 |
remove() | void | 删除此数据透视表。 |
setValuesDisplayOrientation(dimension) | PivotTable | 设置此数据透视表的布局,以将值显示为列或行。 |
PivotTableSummarizeFunction
属性
属性 | 类型 | 说明 |
---|---|---|
CUSTOM | Enum | 自定义函数,此值仅适用于计算字段。 |
SUM | Enum | SUM 函数 |
COUNTA | Enum | COUNTA 函数 |
COUNT | Enum | COUNT 函数 |
COUNTUNIQUE | Enum | COUNTUNIQUE 函数 |
AVERAGE | Enum | AVERAGE 函数 |
MAX | Enum | MAX 函数 |
MIN | Enum | MIN 函数 |
MEDIAN | Enum | MEDIAN 函数 |
PRODUCT | Enum | PRODUCT 函数 |
STDEV | Enum | STDEV 函数 |
STDEVP | Enum | STDEVP 函数 |
VAR | Enum | VAR 函数 |
VARP | Enum | VARP 函数 |
PivotValue
方法
方法 | 返回类型 | 简介 |
---|---|---|
getDisplayType() | PivotValueDisplayType | 返回描述此数据透视值当前在表格中的显示方式的显示类型。 |
getFormula() | String | 返回用于计算此值的公式。 |
getPivotTable() | PivotTable | 返回此值所属的 PivotTable 。 |
getSourceDataColumn() | Integer | 返回透视值汇总的源数据列数。 |
getSourceDataSourceColumn() | DataSourceColumn | 返回数据透视值汇总的数据源列。 |
getSummarizedBy() | PivotTableSummarizeFunction | 返回此组的汇总函数。 |
remove() | void | 从数据透视表中移除此值。 |
setDisplayName(name) | PivotValue | 在数据透视表中设置此值的显示名称。 |
setFormula(formula) | PivotValue | 设置用于计算此值的公式。 |
showAs(displayType) | PivotValue | 在数据透视表中将此值显示为另一个值的函数。 |
summarizeBy(summarizeFunction) | PivotValue | 设置汇总函数。 |
PivotValueDisplayType
属性
属性 | 类型 | 说明 |
---|---|---|
DEFAULT | Enum | 默认。 |
PERCENT_OF_ROW_TOTAL | Enum | 以该行总数的百分比形式显示数据透视值。 |
PERCENT_OF_COLUMN_TOTAL | Enum | 将透视值显示为相应列总计值的百分比。 |
PERCENT_OF_GRAND_TOTAL | Enum | 将数据透视表值显示为占总计的百分比。 |
Protection
方法
ProtectionType
属性
属性 | 类型 | 说明 |
---|---|---|
RANGE | Enum | 对某个范围的保护。 |
SHEET | Enum | 对工作表的保护。 |
Range
方法
RangeList
方法
RecalculationInterval
属性
属性 | 类型 | 说明 |
---|---|---|
ON_CHANGE | Enum | 仅在值发生变化时重新计算。 |
MINUTE | Enum | 在值发生更改时以及每分钟重新计算。 |
HOUR | Enum | 在值发生变化时以及每小时重新计算。 |
RelativeDate
属性
属性 | 类型 | 说明 |
---|---|---|
TODAY | Enum | 与当前日期进行比较的日期。 |
TOMORROW | Enum | 与当前日期之后的日期进行比较的日期。 |
YESTERDAY | Enum | 与当前日期之前的日期进行比较的日期。 |
PAST_WEEK | Enum | 过去一周内的日期。 |
PAST_MONTH | Enum | 过去一个月内的日期。 |
PAST_YEAR | Enum | 过去一年内的日期。 |
RichTextValue
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | RichTextValueBuilder | 返回一个富文本值的构建器,该构建器使用此富文本值的值进行初始化。 |
getEndIndex() | Integer | 获取此值在单元格中的结束索引。 |
getLinkUrl() | String | 返回此值的链接网址。 |
getLinkUrl(startOffset, endOffset) | String | 返回从 startOffset 到 endOffset 的文本的链接网址。 |
getRuns() | RichTextValue[] | 返回拆分为一系列文本行的富文本字符串,其中每个文本行都是具有一致文本样式的尽可能长的子字符串。 |
getStartIndex() | Integer | 获取此值在单元格中的起始索引。 |
getText() | String | 返回此值的文本。 |
getTextStyle() | TextStyle | 返回此值的文本样式。 |
getTextStyle(startOffset, endOffset) | TextStyle | 将文本的文本样式从 startOffset 返回至 endOffset 。 |
RichTextValueBuilder
方法
方法 | 返回类型 | 简介 |
---|---|---|
build() | RichTextValue | 使用此构建器创建富文本值。 |
setLinkUrl(startOffset, endOffset, linkUrl) | RichTextValueBuilder | 为此值的给定子字符串设置链接网址,如果 linkUrl 为 null ,则清除该子字符串的链接网址。 |
setLinkUrl(linkUrl) | RichTextValueBuilder | 设置整个值的链接网址,如果 linkUrl 为 null ,则清除该值。 |
setText(text) | RichTextValueBuilder | 为此值设置文本,并清除所有现有文本样式。 |
setTextStyle(startOffset, endOffset, textStyle) | RichTextValueBuilder | 将文本样式应用于此值的指定子字符串。 |
setTextStyle(textStyle) | RichTextValueBuilder | 将文本样式应用于整个值。 |
Selection
方法
方法 | 返回类型 | 简介 |
---|---|---|
getActiveRange() | Range | 返回活动工作表中的选定范围,如果没有活动范围,则返回 null 。 |
getActiveRangeList() | RangeList | 返回活动工作表中的有效范围列表,如果没有有效范围,则返回 null 。 |
getActiveSheet() | Sheet | 返回电子表格中的活动工作表。 |
getCurrentCell() | Range | 返回在某个活动范围中选定的当前(突出显示的)单元格;如果没有当前单元格,则返回 null 。 |
getNextDataRange(direction) | Range | 从 current cell 和 active range 开始,沿给定方向移动,返回经过调整的范围,其中范围的适当边缘已移位以覆盖 next data cell ,同时仍覆盖当前单元格。 |
Sheet
方法
SheetType
属性
属性 | 类型 | 说明 |
---|---|---|
GRID | Enum | 包含网格的工作表。 |
OBJECT | Enum | 包含单个嵌入对象(例如 EmbeddedChart )的工作表。 |
DATASOURCE | Enum | 包含 DataSource 的工作表。 |
Slicer
方法
方法 | 返回类型 | 简介 |
---|---|---|
getBackgroundColorObject() | Color | 返回 Slicer 的背景 Color 。 |
getColumnPosition() | Integer | 返回在切片器中应用过滤器的列位置(相对于切片器的数据范围),如果未设置列位置,则返回 null 。 |
getContainerInfo() | ContainerInfo | 获取有关截剪器在工作表中位置的信息。 |
getFilterCriteria() | FilterCriteria | 返回切片器的过滤条件;如果未设置过滤条件,则返回 null 。 |
getRange() | Range | 获取应用切片器的数据范围。 |
getTitle() | String | 返回分屏标题。 |
getTitleHorizontalAlignment() | String | 获取标题的水平对齐方式。 |
getTitleTextStyle() | TextStyle | 返回截剪器标题的文本样式。 |
isAppliedToPivotTables() | Boolean | 返回是否将指定截剪器应用于数据透视表。 |
remove() | void | 删除分屏。 |
setApplyToPivotTables(applyToPivotTables) | Slicer | 设置是否应将指定截剪器应用于工作表中的数据透视表。 |
setBackgroundColor(color) | Slicer | 设置分屏的背景颜色。 |
setBackgroundColorObject(color) | Slicer | 设置截剪器的背景 Color 。 |
setColumnFilterCriteria(columnPosition, filterCriteria) | Slicer | 设置截剪器的列索引和过滤条件。 |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | Slicer | 设置分屏器在工作表中的显示位置。 |
setRange(rangeApi) | Slicer | 设置应用截剪器的数据范围。 |
setTitle(title) | Slicer | 设置截剪器的标题。 |
setTitleHorizontalAlignment(horizontalAlignment) | Slicer | 设置标题在截剪器中的水平对齐方式。 |
setTitleTextStyle(textStyle) | Slicer | 设置分屏的文字样式。 |
SortOrder
属性
属性 | 类型 | 说明 |
---|---|---|
ASCENDING | Enum | 升序排列顺序。 |
DESCENDING | Enum | 降序排序顺序。 |
SortSpec
方法
方法 | 返回类型 | 简介 |
---|---|---|
getBackgroundColor() | Color | 返回用于排序的背景颜色,如果不存在,则返回 null 。 |
getDataSourceColumn() | DataSourceColumn | 获取排序规范作用的数据源列。 |
getDimensionIndex() | Integer | 返回维度索引,如果未关联到本地过滤器,则返回 null 。 |
getForegroundColor() | Color | 返回用于排序的前景颜色,如果不存在,则返回 null 。 |
getSortOrder() | SortOrder | 返回排序顺序。 |
isAscending() | Boolean | 返回排序顺序是否升序。 |
Spreadsheet
方法
SpreadsheetApp
属性
属性 | 类型 | 说明 |
---|---|---|
AutoFillSeries | AutoFillSeries | 用于计算自动填充值的系列类型的枚举。 |
BandingTheme | BandingTheme | 枚举可能的条纹主题。 |
BooleanCriteria | BooleanCriteria | 条件格式布尔值条件的枚举。 |
BorderStyle | BorderStyle | 用于在 Range 上设置边框的有效样式的枚举。 |
ColorType | ColorType | 枚举可能的颜色类型。 |
CopyPasteType | CopyPasteType | 可能的粘贴类型的枚举。 |
DataExecutionErrorCode | DataExecutionErrorCode | 可能的数据执行错误代码的枚举。 |
DataExecutionState | DataExecutionState | 枚举可能的数据执行状态。 |
DataSourceParameterType | DataSourceParameterType | 可能的数据源参数类型的枚举。 |
DataSourceRefreshScope | DataSourceRefreshScope | 枚举了可能的数据源刷新范围。 |
DataSourceType | DataSourceType | 枚举可能的数据源类型。 |
DataValidationCriteria | DataValidationCriteria | 表示可对范围设置的数据验证条件的枚举。 |
DateTimeGroupingRuleType | DateTimeGroupingRuleType | 日期时间分组规则的枚举。 |
DeveloperMetadataLocationType | DeveloperMetadataLocationType | 枚举的开发者元数据位置类型。 |
DeveloperMetadataVisibility | DeveloperMetadataVisibility | 枚举可能的开发者元数据公开范围。 |
Dimension | Dimension | 枚举电子表格的可能维度。 |
Direction | Direction | 使用箭头键在电子表格中移动的可能方向的枚举。 |
FrequencyType | FrequencyType | 可能的频率类型的枚举。 |
GroupControlTogglePosition | GroupControlTogglePosition | 枚举了组控件切换开关可以处于的位置。 |
InterpolationType | InterpolationType | 条件格式渐变插值类型的枚举。 |
PivotTableSummarizeFunction | PivotTableSummarizeFunction | 可用于汇总数据透视表中值的函数的枚举。 |
PivotValueDisplayType | PivotValueDisplayType | 枚举了可显示数据透视值的方式。 |
ProtectionType | ProtectionType | 一个枚举,表示电子表格中可以保护其免遭编辑的部分。 |
RecalculationInterval | RecalculationInterval | 枚举可用于重新计算电子表格的可能区间。 |
RelativeDate | RelativeDate | 一个相对日期选项的枚举,用于计算要在基于日期的 BooleanCriteria 中使用的值。 |
SheetType | SheetType | 一个枚举,用于枚举电子表格中可以包含的不同类型的工作表。 |
SortOrder | SortOrder | 排序顺序的枚举。 |
TextDirection | TextDirection | 有效文本路线的枚举。 |
TextToColumnsDelimiter | TextToColumnsDelimiter | 用于将文本分列的预设分隔符的枚举。 |
ThemeColorType | ThemeColorType | 可能的主题颜色类型的枚举。 |
ValueType | ValueType | Range.getValue() 和 Range.getValues() 从 Google 表格服务的 Range 类返回的值类型的枚举。 |
WrapStrategy | WrapStrategy | 用于换行单元格的策略的枚举。 |
方法
SpreadsheetTheme
方法
方法 | 返回类型 | 简介 |
---|---|---|
getConcreteColor(themeColorType) | Color | 返回有效主题颜色类型的具体 Color 。 |
getFontFamily() | String | 返回主题的字体系列;如果是 null 主题,则返回 null 。 |
getThemeColors() | ThemeColorType[] | 返回当前主题的所有可能主题颜色类型的列表。 |
setConcreteColor(themeColorType, color) | SpreadsheetTheme | 将此配色方案中与 ThemeColorType 关联的具体颜色设为指定颜色。 |
setConcreteColor(themeColorType, red, green, blue) | SpreadsheetTheme | 将此配色方案中与 ThemeColorType 关联的具体颜色设置为 RGB 格式的指定颜色。 |
setFontFamily(fontFamily) | SpreadsheetTheme | 设置主题的字体系列。 |
TextDirection
属性
属性 | 类型 | 说明 |
---|---|---|
LEFT_TO_RIGHT | Enum | 文本方向为从左至右。 |
RIGHT_TO_LEFT | Enum | 文本方向为从右至左。 |
TextFinder
方法
方法 | 返回类型 | 简介 |
---|---|---|
findAll() | Range[] | 返回与搜索条件匹配的所有单元格。 |
findNext() | Range | 返回与搜索条件匹配的下一个单元格。 |
findPrevious() | Range | 返回与搜索条件匹配的上一个单元格。 |
getCurrentMatch() | Range | 返回与搜索条件匹配的当前单元格。 |
ignoreDiacritics(ignoreDiacritics) | TextFinder | 如果为 true ,则将搜索配置为在匹配时忽略变音符号;否则,搜索匹配变音符号。 |
matchCase(matchCase) | TextFinder | 如果为 true ,则将搜索配置为与搜索文本的大小写完全匹配,否则搜索默认不区分大小写。 |
matchEntireCell(matchEntireCell) | TextFinder | 如果为 true ,则将搜索配置为匹配单元格的全部内容;否则,搜索将默认采用部分匹配。 |
matchFormulaText(matchFormulaText) | TextFinder | 如果为 true ,则配置搜索以返回公式文本中显示的匹配项;否则,系统会根据包含公式的单元格显示的值来进行考虑。 |
replaceAllWith(replaceText) | Integer | 使用指定文本替换所有匹配项。 |
replaceWith(replaceText) | Integer | 将当前匹配单元格中的搜索文本替换为指定文本,并返回替换的出现次数。 |
startFrom(startRange) | TextFinder | 将搜索配置为在指定单元格范围之后立即开始搜索。 |
useRegularExpression(useRegEx) | TextFinder | 如果为 true ,则将搜索配置为将搜索字符串解释为正则表达式;否则,搜索会将搜索字符串解释为普通文本。 |
TextRotation
方法
方法 | 返回类型 | 简介 |
---|---|---|
getDegrees() | Integer | 获取标准文本方向与当前文本方向之间的角度。 |
isVertical() | Boolean | 如果文本垂直堆叠,则返回 true ;否则返回 false 。 |
TextStyle
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | TextStyleBuilder | 创建一个使用此文本样式的值初始化的文本样式构建器。 |
getFontFamily() | String | 获取文本的字体系列。 |
getFontSize() | Integer | 获取文本的字体大小(以磅为单位)。 |
getForegroundColorObject() | Color | 获取文本的字体颜色。 |
isBold() | Boolean | 获取文本是否为粗体。 |
isItalic() | Boolean | 获取单元格是否为斜体。 |
isStrikethrough() | Boolean | 获取单元格是否带删除线。 |
isUnderline() | Boolean | 获取单元格是否带下划线。 |
TextStyleBuilder
方法
方法 | 返回类型 | 简介 |
---|---|---|
build() | TextStyle | 使用此构建器创建文本样式。 |
setBold(bold) | TextStyleBuilder | 设置文本是否加粗。 |
setFontFamily(fontFamily) | TextStyleBuilder | 设置文本字体系列,例如“Arial”。 |
setFontSize(fontSize) | TextStyleBuilder | 设置文本字体大小(以点为单位)。 |
setForegroundColor(cssString) | TextStyleBuilder | 设置文本字体颜色。 |
setForegroundColorObject(color) | TextStyleBuilder | 设置文本字体颜色。 |
setItalic(italic) | TextStyleBuilder | 设置文本是否为斜体。 |
setStrikethrough(strikethrough) | TextStyleBuilder | 设置文本是否带有删除线。 |
setUnderline(underline) | TextStyleBuilder | 设置文本是否带下划线。 |
TextToColumnsDelimiter
属性
属性 | 类型 | 说明 |
---|---|---|
COMMA | Enum | "," 分隔符。 |
SEMICOLON | Enum | ";" 分隔符。 |
PERIOD | Enum | "." 分隔符。 |
SPACE | Enum | " " 分隔符。 |
ThemeColor
方法
方法 | 返回类型 | 简介 |
---|---|---|
getColorType() | ColorType | 获取此颜色的类型。 |
getThemeColorType() | ThemeColorType | 获取此颜色的主题颜色类型。 |
ThemeColorType
属性
属性 | 类型 | 说明 |
---|---|---|
UNSUPPORTED | Enum | 表示不受支持的主题颜色。 |
TEXT | Enum | 表示文本颜色。 |
BACKGROUND | Enum | 表示要用于图表背景的颜色。 |
ACCENT1 | Enum | 表示第一个强调色。 |
ACCENT2 | Enum | 表示第二种强调色。 |
ACCENT3 | Enum | 表示第三种强调色。 |
ACCENT4 | Enum | 表示第四种强调色。 |
ACCENT5 | Enum | 表示第五个强调色。 |
ACCENT6 | Enum | 表示第六种强调色。 |
HYPERLINK | Enum | 表示要用于超链接的颜色。 |
ValueType
属性
属性 | 类型 | 说明 |
---|---|---|
IMAGE | Enum | 单元格包含图片时的值类型。 |
WrapStrategy
属性
属性 | 类型 | 说明 |
---|---|---|
WRAP | Enum | 将超出单元格宽度的行换行到新行。 |
OVERFLOW | Enum | 让行溢出到下一个单元格中,只要该单元格为空即可。 |
CLIP | Enum | 剪裁超出单元格宽度的线条。 |