Spreadsheet Service

电子表格

此服务允许脚本创建、访问和修改 Google 表格文件。另请参阅有关在电子表格中存储数据的指南。

有时，为了提高性能，系统会将电子表格操作捆绑在一起，例如对某个方法进行多次调用时。如果您想确保立即进行所有待处理更改（例如，在脚本执行时显示用户信息），请调用 SpreadsheetApp.flush()。

类

名称	简介
AutoFillSeries	用于计算自动填充值的系列类型的枚举。
Banding	访问和修改条纹，即应用于范围的行或列的颜色模式。
BandingTheme	对分屏主题的枚举。
BigQueryDataSourceSpec	访问现有的 BigQuery 数据源规范。
BigQueryDataSourceSpecBuilder	BigQueryDataSourceSpecBuilder 的构建器。
BooleanCondition	访问 ConditionalFormatRules 中的布尔值条件。
BooleanCriteria	表示可在条件格式或过滤条件中使用的布尔条件的枚举。
BorderStyle	可使用 Range.setBorder(top, left, bottom, right, vertical, horizontal, color, style) 在范围上设置的样式。
CellImage	表示要添加到单元格的图片。
CellImageBuilder	CellImage 的构建器。
Color	颜色的表示法。
ColorBuilder	ColorBuilder 的构建器。
ConditionalFormatRule	访问条件格式规则。
ConditionalFormatRuleBuilder	用于构建条件格式规则的构建器。
ContainerInfo	访问图表在工作表中的位置。
CopyPasteType	枚举可能的特殊粘贴类型。
DataExecutionErrorCode	数据执行错误代码的枚举。
DataExecutionState	数据执行状态的枚举。
DataExecutionStatus	数据执行状态。
DataSource	访问和修改现有数据源。
DataSourceChart	访问和修改现有数据源图表。
DataSourceColumn	访问和修改数据源列。
DataSourceFormula	访问和修改现有数据源公式。
DataSourceParameter	访问现有数据源参数。
DataSourceParameterType	数据源参数类型的枚举。
DataSourcePivotTable	访问和修改现有的数据源数据透视表。
DataSourceRefreshSchedule	访问和修改现有的刷新时间安排。
DataSourceRefreshScheduleFrequency	查看刷新时间表的频率，该频率用于指定刷新的频率和时间。
DataSourceRefreshScope	刷新的范围枚举。
DataSourceSheet	访问和修改现有数据源工作表。
DataSourceSheetFilter	访问和修改现有的数据源工作表过滤条件。
DataSourceSpec	访问现有数据源规范的常规设置。
DataSourceSpecBuilder	DataSourceSpec 的构建器。
DataSourceTable	访问和修改现有数据源表。
DataSourceTableColumn	访问和修改 DataSourceTable 中的现有列。
DataSourceTableFilter	访问和修改现有的数据源表过滤条件。
DataSourceType	数据源类型的枚举。
DataValidation	访问数据验证规则。
DataValidationBuilder	数据验证规则的构建器。
DataValidationCriteria	表示可对范围设置的数据验证条件的枚举。
DateTimeGroupingRule	访问现有日期时间分组规则。
DateTimeGroupingRuleType	日期时间分组规则的类型。
DeveloperMetadata	访问和修改开发者元数据。
DeveloperMetadataFinder	在电子表格中搜索开发者元数据。
DeveloperMetadataLocation	访问开发者元数据位置信息。
DeveloperMetadataLocationType	开发者元数据位置类型的枚举。
DeveloperMetadataVisibility	开发者元数据公开范围类型的枚举。
Dimension	枚举了数据在电子表格中可以沿着的可能方向。
Direction	一个枚举，表示用户可以使用箭头键在电子表格中移动的可能方向。
Drawing	表示在电子表格中的工作表上绘制的图形。
EmbeddedAreaChartBuilder	面积图的构建器。
EmbeddedBarChartBuilder	条形图的构建器。
EmbeddedChart	表示嵌入电子表格中的图表。
EmbeddedChartBuilder	用于修改 EmbeddedChart 的构建器。
EmbeddedColumnChartBuilder	柱形图的构建器。
EmbeddedComboChartBuilder	组合图表的构建器。
EmbeddedHistogramChartBuilder	直方图的构建器。
EmbeddedLineChartBuilder	折线图的构建器。
EmbeddedPieChartBuilder	饼图的构建器。
EmbeddedScatterChartBuilder	散点图的构建器。
EmbeddedTableChartBuilder	表格图表的构建器。
Filter	使用此类可修改 Grid 工作表（默认的工作表类型）上的现有过滤条件。
FilterCriteria	您可以使用此类获取现有过滤条件的相关信息或复制其条件。
FilterCriteriaBuilder	如需向过滤条件添加条件，您必须执行以下操作： 使用 SpreadsheetApp.newFilterCriteria() 创建条件构建器。 使用此类中的方法向构建器添加设置。 使用 build() 将条件与您指定的设置组合起来。
FrequencyType	频次类型的枚举。
GradientCondition	访问 ConditionalFormatRuleApis 中的渐变（颜色）条件。
Group	访问和修改电子表格组。
GroupControlTogglePosition	一个枚举，表示组控件切换开关可能的状态。
InterpolationType	一个枚举，表示用于计算要在 ConditionalFormatRule 中的 GradientCondition 中使用的值的插值选项。
LookerDataSourceSpec	DataSourceSpec，用于专门访问现有 Looker 数据源规范。
LookerDataSourceSpecBuilder	LookerDataSourceSpecBuilder 的构建器。
NamedRange	在电子表格中创建、访问和修改命名范围。
OverGridImage	表示电子表格中网格上方的图片。
PageProtection	在旧版 Google 表格中访问和修改受保护的工作表。
PivotFilter	访问和修改数据透视表过滤条件。
PivotGroup	访问和修改数据透视表细分组。
PivotGroupLimit	访问和修改数据透视表组限制。
PivotTable	访问和修改数据透视表。
PivotTableSummarizeFunction	用于汇总数据透视表数据的函数的枚举。
PivotValue	访问和修改数据透视表中的值组。
PivotValueDisplayType	枚举，用于将某个值作为另一个值的函数来显示某个数据透视值的方式。
Protection	访问和修改受保护的范围和工作表。
ProtectionType	一个枚举，表示可以防止被修改的电子表格部分。
Range	访问和修改电子表格范围。
RangeList	同一工作表中的一个或多个 Range 实例的集合。
RecalculationInterval	一个枚举，表示电子表格重新计算中可能使用的间隔。
RelativeDate	一个枚举，表示用于计算要在基于日期的 BooleanCriteria 中使用的值的相对日期选项。
RichTextValue	用于表示单元格文本的样式化文本字符串。
RichTextValueBuilder	富文本值的构建器。
Selection	访问活动工作表中的当前活动选择。
Sheet	访问和修改电子表格工作表。
SheetType	电子表格中可以存在的不同类型的页面。
Slicer	表示切片器，用于以非协作方式过滤范围、图表和数据透视表。
SortOrder	表示排序顺序的枚举。
SortSpec	排序规范。
Spreadsheet	访问和修改 Google 表格文件。
SpreadsheetApp	访问和创建 Google 表格文件。
SpreadsheetTheme	访问和修改现有主题。
TextDirection	文本路线的枚举。
TextFinder	在范围、工作表或电子表格中查找或替换文本。
TextRotation	访问单元格的文本旋转设置。
TextStyle	单元格中文本的呈现样式。
TextStyleBuilder	文本样式的构建器。
TextToColumnsDelimiter	一个枚举，包含可将一列文本拆分为多列的预设分隔符类型。
ThemeColor	主题颜色的表示法。
ThemeColorType	一个枚举，用于描述主题中支持的各种颜色条目。
ValueType	Range.getValue() 和 Range.getValues() 从 Google 表格服务的 Range 类返回的值类型的枚举。
WrapStrategy	用于处理单元格文本换行策略的枚举。

AutoFillSeries

属性

属性	类型	说明
DEFAULT_SERIES	Enum	默认。
ALTERNATE_SERIES	Enum	使用此设置进行自动填充会导致展开的范围中的空单元格填充现有值的副本。

Banding

方法

方法	返回类型	简介
copyTo(range)	Banding	将此分段复制到另一个范围。
getFirstColumnColorObject()	Color	返回条纹中的第一个交替列颜色；如果未设置颜色，则返回 null。
getFirstRowColorObject()	Color	返回第一个交替行颜色，如果未设置颜色，则返回 null。
getFooterColumnColorObject()	Color	返回条纹中最后一列的颜色，如果未设置颜色，则返回 null。
getFooterRowColorObject()	Color	返回条纹中的最后一行颜色，如果未设置颜色，则返回 null。
getHeaderColumnColorObject()	Color	返回条纹中第一列的颜色；如果未设置颜色，则返回 null。
getHeaderRowColorObject()	Color	返回标题行的颜色，如果未设置颜色，则返回 null。
getRange()	Range	返回此分屏的范围。
getSecondColumnColorObject()	Color	返回分组中的第二个交替列颜色；如果未设置颜色，则返回 null。
getSecondRowColorObject()	Color	返回第二种交替行颜色，如果未设置颜色，则返回 null。
remove()	void	移除此条带。
setFirstColumnColor(color)	Banding	设置第一列的颜色（交替）。
setFirstColumnColorObject(color)	Banding	设置条纹中第一个交替列的颜色。
setFirstRowColor(color)	Banding	设置第一行的交替颜色。
setFirstRowColorObject(color)	Banding	设置条纹中第一行交替颜色。
setFooterColumnColor(color)	Banding	设置最后一列的颜色。
setFooterColumnColorObject(color)	Banding	设置条纹中最后一列的颜色。
setFooterRowColor(color)	Banding	设置最后一行的颜色。
setFooterRowColorObject(color)	Banding	设置分组中的页脚行的颜色。
setHeaderColumnColor(color)	Banding	设置标题列的颜色。
setHeaderColumnColorObject(color)	Banding	设置标题列的颜色。
setHeaderRowColor(color)	Banding	设置标题行的颜色。
setHeaderRowColorObject(color)	Banding	设置标题行的颜色。
setRange(range)	Banding	设置此分段的范围。
setSecondColumnColor(color)	Banding	设置交替的第二列颜色。
setSecondColumnColorObject(color)	Banding	设置条纹中的第二个交替列颜色。
setSecondRowColor(color)	Banding	设置交替的第二行颜色。
setSecondRowColorObject(color)	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

方法

方法	返回类型	简介
build()	ConditionalFormatRule	根据应用于构建器的设置构建条件格式规则。
copy()	ConditionalFormatRuleBuilder	返回包含此规则设置的规则构建器预设。
getBooleanCondition()	BooleanCondition	如果此规则使用布尔值条件条件，则检索规则的 BooleanCondition 信息。
getGradientCondition()	GradientCondition	检索规则的 GradientCondition 信息（如果此规则使用渐变条件条件）。
getRanges()	Range[]	检索要应用此条件格式规则的范围。
setBackground(color)	ConditionalFormatRuleBuilder	设置条件格式规则格式的背景颜色。
setBackgroundObject(color)	ConditionalFormatRuleBuilder	设置条件格式规则格式的背景颜色。
setBold(bold)	ConditionalFormatRuleBuilder	为条件格式规则的格式设置文本粗体。
setFontColor(color)	ConditionalFormatRuleBuilder	设置条件格式规则格式的字体颜色。
setFontColorObject(color)	ConditionalFormatRuleBuilder	设置条件格式规则格式的字体颜色。
setGradientMaxpoint(color)	ConditionalFormatRuleBuilder	清除条件格式规则的渐变 maxpoint 值，改为使用规则范围中的最大值。
setGradientMaxpointObject(color)	ConditionalFormatRuleBuilder	清除条件格式规则的渐变 maxpoint 值，改为使用规则范围中的最大值。
setGradientMaxpointObjectWithValue(color, type, value)	ConditionalFormatRuleBuilder	设置条件格式规则的渐变 maxpoint 字段。
setGradientMaxpointWithValue(color, type, value)	ConditionalFormatRuleBuilder	设置条件格式规则的渐变 maxpoint 字段。
setGradientMidpointObjectWithValue(color, type, value)	ConditionalFormatRuleBuilder	设置条件格式规则的渐变中点字段。
setGradientMidpointWithValue(color, type, value)	ConditionalFormatRuleBuilder	设置条件格式规则的渐变中点字段。
setGradientMinpoint(color)	ConditionalFormatRuleBuilder	清除条件格式规则的渐变 minpoint 值，改为使用规则范围中的最小值。
setGradientMinpointObject(color)	ConditionalFormatRuleBuilder	清除条件格式规则的渐变 minpoint 值，改为使用规则范围中的最小值。
setGradientMinpointObjectWithValue(color, type, value)	ConditionalFormatRuleBuilder	设置条件格式规则的渐变 minpoint 字段。
setGradientMinpointWithValue(color, type, value)	ConditionalFormatRuleBuilder	设置条件格式规则的渐变 minpoint 字段。
setItalic(italic)	ConditionalFormatRuleBuilder	为条件格式规则的格式设置文本斜体。
setRanges(ranges)	ConditionalFormatRuleBuilder	设置要应用此条件格式规则的一个或多个范围。
setStrikethrough(strikethrough)	ConditionalFormatRuleBuilder	设置条件格式规则格式的文本删除线。
setUnderline(underline)	ConditionalFormatRuleBuilder	设置条件格式规则格式的文本下划线。
whenCellEmpty()	ConditionalFormatRuleBuilder	将条件格式规则设置为在单元格为空时触发。
whenCellNotEmpty()	ConditionalFormatRuleBuilder	将条件格式规则设置为在单元格不为空时触发。
whenDateAfter(date)	ConditionalFormatRuleBuilder	设置条件格式规则，以便在日期大于给定值时触发。
whenDateAfter(date)	ConditionalFormatRuleBuilder	设置条件格式规则，以便在日期晚于给定相对日期时触发。
whenDateBefore(date)	ConditionalFormatRuleBuilder	将条件格式规则设置为在日期早于给定日期时触发。
whenDateBefore(date)	ConditionalFormatRuleBuilder	将条件格式规则设置为在日期早于给定相对日期时触发。
whenDateEqualTo(date)	ConditionalFormatRuleBuilder	将条件格式规则设置为在日期等于给定日期时触发。
whenDateEqualTo(date)	ConditionalFormatRuleBuilder	将条件格式规则设置为在日期等于给定相对日期时触发。
whenFormulaSatisfied(formula)	ConditionalFormatRuleBuilder	设置条件格式规则，以便在给定公式的计算结果为 true 时触发该规则。
whenNumberBetween(start, end)	ConditionalFormatRuleBuilder	将条件格式规则设置为在数字介于两个指定值之间或等于其中一个值时触发。
whenNumberEqualTo(number)	ConditionalFormatRuleBuilder	将条件格式规则设置为在数字等于给定值时触发。
whenNumberGreaterThan(number)	ConditionalFormatRuleBuilder	设置条件格式规则，以便在数字大于给定值时触发。
whenNumberGreaterThanOrEqualTo(number)	ConditionalFormatRuleBuilder	设置条件格式规则，以便在数字大于或等于给定值时触发。
whenNumberLessThan(number)	ConditionalFormatRuleBuilder	设置条件格式规则，以便在数字小于给定值时触发。
whenNumberLessThanOrEqualTo(number)	ConditionalFormatRuleBuilder	将条件格式规则设置为在数值小于或等于给定值时触发。
whenNumberNotBetween(start, end)	ConditionalFormatRuleBuilder	设置条件格式规则，以便在数字不介于两个指定值之间且不等于这两个值时触发。
whenNumberNotEqualTo(number)	ConditionalFormatRuleBuilder	将条件格式规则设置为在数字不等于给定值时触发。
whenTextContains(text)	ConditionalFormatRuleBuilder	将条件格式规则设置为在输入包含给定值时触发。
whenTextDoesNotContain(text)	ConditionalFormatRuleBuilder	设置条件格式规则，以便在输入不包含给定值时触发。
whenTextEndsWith(text)	ConditionalFormatRuleBuilder	设置条件格式规则，以便在输入内容以指定值结尾时触发。
whenTextEqualTo(text)	ConditionalFormatRuleBuilder	将条件格式规则设置为在输入值等于给定值时触发。
whenTextStartsWith(text)	ConditionalFormatRuleBuilder	将条件格式规则设置为在输入值以给定值开头时触发。
withCriteria(criteria, args)	ConditionalFormatRuleBuilder	将条件格式规则设置为由 BooleanCriteria 值定义的条件，这些值通常取自现有规则的 criteria 和 arguments。

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 Script 不支持的数据执行错误代码。
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

方法

方法	返回类型	简介
addFilter(columnName, filterCriteria)	DataSourceSheet	添加应用于数据源工作表的过滤条件。
asSheet()	Sheet	将数据源工作表作为常规工作表对象返回。
autoResizeColumn(columnName)	DataSourceSheet	自动调整指定列的宽度。
autoResizeColumns(columnNames)	DataSourceSheet	自动调整指定列的宽度。
cancelDataRefresh()	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	等待当前执行操作完成，并在提供的秒数后超时。

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

方法

方法	返回类型	简介
addColumns(columnNames)	DataSourceTable	向数据源表添加列。
addFilter(columnName, filterCriteria)	DataSourceTable	添加要应用于数据源表的过滤条件。
addSortSpec(columnName, ascending)	DataSourceTable	在数据源表中的列上添加排序规范。
addSortSpec(columnName, sortOrder)	DataSourceTable	在数据源表中的列上添加排序规范。
cancelDataRefresh()	DataSourceTable	取消与此对象关联的数据刷新（如果当前正在运行）。
forceRefreshData()	DataSourceTable	刷新此对象的数据，无论当前状态如何。
getColumns()	DataSourceTableColumn[]	获取添加到数据源表中的所有数据源列。
getDataSource()	DataSource	获取对象关联的数据源。
getFilters()	DataSourceTableFilter[]	返回应用于数据源表的所有过滤条件。
getRange()	Range	获取此数据源表跨越的 Range。
getRowLimit()	Integer	返回数据源表的行数上限。
getSortSpecs()	SortSpec[]	获取数据源表中的所有排序规范。
getStatus()	DataExecutionStatus	获取对象的数据执行状态。
isSyncingAllColumns()	Boolean	返回数据源表是否正在同步关联数据源中的所有列。
refreshData()	DataSourceTable	刷新对象的数据。
removeAllColumns()	DataSourceTable	移除数据源表中的所有列。
removeAllSortSpecs()	DataSourceTable	移除数据源表中的所有排序规范。
setRowLimit(rowLimit)	DataSourceTable	更新数据源表的行数上限。
syncAllColumns()	DataSourceTable	将关联数据源中的所有现有列和日后增加的列同步到数据源表。
waitForCompletion(timeoutInSeconds)	DataExecutionStatus	等待当前执行操作完成，并在提供的秒数后超时。

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

方法

方法	返回类型	简介
build()	DataValidation	根据应用于构建器的设置构建数据验证规则。
copy()	DataValidationBuilder	根据此规则的设置为数据验证规则创建构建器。
getAllowInvalid()	Boolean	如果规则在输入数据验证失败时显示警告，则返回 true；如果完全拒绝输入，则返回 false。
getCriteriaType()	DataValidationCriteria	获取规则的条件类型（如 DataValidationCriteria 枚举中所定义）。
getCriteriaValues()	Object[]	获取规则条件的参数数组。
getHelpText()	String	获取规则的帮助文本，如果未设置帮助文本，则返回 null。
requireCheckbox()	DataValidationBuilder	将数据验证规则设置为要求输入值为布尔值；此值将呈现为复选框。
requireCheckbox(checkedValue)	DataValidationBuilder	设置数据验证规则，要求输入值为指定值或为空。
requireCheckbox(checkedValue, uncheckedValue)	DataValidationBuilder	设置数据验证规则，要求输入值为指定值之一。
requireDate()	DataValidationBuilder	将数据验证规则设置为要求输入日期。
requireDateAfter(date)	DataValidationBuilder	将数据验证规则设置为要求日期晚于给定值。
requireDateBefore(date)	DataValidationBuilder	将数据验证规则设置为要求日期早于给定值。
requireDateBetween(start, end)	DataValidationBuilder	将数据验证规则设置为要求日期介于两个指定日期之间或为其中一个日期。
requireDateEqualTo(date)	DataValidationBuilder	将数据验证规则设置为要求日期等于给定值。
requireDateNotBetween(start, end)	DataValidationBuilder	设置数据验证规则，要求日期不介于两个指定日期之间，也不是这两个日期。
requireDateOnOrAfter(date)	DataValidationBuilder	将数据验证规则设置为要求日期不低于指定值。
requireDateOnOrBefore(date)	DataValidationBuilder	将数据验证规则设置为要求日期不晚于给定值。
requireFormulaSatisfied(formula)	DataValidationBuilder	设置数据验证规则，要求给定公式的求值结果为 true。
requireNumberBetween(start, end)	DataValidationBuilder	将数据验证规则设置为要求输入的数字介于两个指定数字之间或等于其中一个数字。
requireNumberEqualTo(number)	DataValidationBuilder	将数据验证规则设置为要求输入的数字等于给定值。
requireNumberGreaterThan(number)	DataValidationBuilder	将数据验证规则设置为要求输入的数字大于给定值。
requireNumberGreaterThanOrEqualTo(number)	DataValidationBuilder	将数据验证规则设置为要求输入的数字大于或等于给定值。
requireNumberLessThan(number)	DataValidationBuilder	将数据验证规则设置为要求输入的数字小于给定值。
requireNumberLessThanOrEqualTo(number)	DataValidationBuilder	将数据验证规则设置为要求输入的数字小于或等于给定值。
requireNumberNotBetween(start, end)	DataValidationBuilder	设置数据验证规则，要求输入的数字不介于两个指定数字之间，也不等于这两个数字。
requireNumberNotEqualTo(number)	DataValidationBuilder	将数据验证规则设置为要求输入的数字不等于给定值。
requireTextContains(text)	DataValidationBuilder	设置数据验证规则，要求输入包含给定值。
requireTextDoesNotContain(text)	DataValidationBuilder	设置数据验证规则，要求输入不包含给定值。
requireTextEqualTo(text)	DataValidationBuilder	设置数据验证规则，要求输入值等于给定值。
requireTextIsEmail()	DataValidationBuilder	设置数据验证规则，要求输入内容采用电子邮件地址的形式。
requireTextIsUrl()	DataValidationBuilder	设置数据验证规则，要求输入内容采用网址格式。
requireValueInList(values)	DataValidationBuilder	将数据验证规则设置为要求输入值等于给定值之一。
requireValueInList(values, showDropdown)	DataValidationBuilder	设置数据验证规则，要求输入值等于给定值之一，并提供一个用于隐藏下拉菜单的选项。
requireValueInRange(range)	DataValidationBuilder	设置数据验证规则，要求输入值等于给定范围内的值。
requireValueInRange(range, showDropdown)	DataValidationBuilder	设置数据验证规则，要求输入值等于给定范围内的值，并提供一个用于隐藏下拉菜单的选项。
setAllowInvalid(allowInvalidData)	DataValidationBuilder	设置在输入数据验证失败时是否显示警告，或是否完全拒绝输入。
setHelpText(helpText)	DataValidationBuilder	设置当用户将光标悬停在设置了数据验证的单元格上时显示的帮助文本。
withCriteria(criteria, args)	DataValidationBuilder	将数据验证规则设置为由 DataValidationCriteria 值定义的条件，这些值通常取自现有规则的 criteria 和 arguments。

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

方法

方法	返回类型	简介
addRange(range)	EmbeddedChartBuilder	向此构建器修改的图表添加范围。
asAreaChart()	EmbeddedAreaChartBuilder	将图表类型设置为“AreaChart”，并返回 EmbeddedAreaChartBuilder。
asBarChart()	EmbeddedBarChartBuilder	将图表类型设置为 BarChart，并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为 HistogramChart，并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为 LineChart，并返回 EmbeddedLineChartBuilder。
asPieChart()	EmbeddedPieChartBuilder	将图表类型设置为 PieChart，并返回 EmbeddedPieChartBuilder。
asScatterChart()	EmbeddedScatterChartBuilder	将图表类型设置为 ScatterChart，并返回 EmbeddedScatterChartBuilder。
asTableChart()	EmbeddedTableChartBuilder	将图表类型设置为 TableChart，并返回 EmbeddedTableChartBuilder。
build()	EmbeddedChart	构建图表，以反映对其所做的所有更改。
clearRanges()	EmbeddedChartBuilder	从此构建器修改的图表中移除所有范围。
getChartType()	ChartType	返回当前图表类型。
getContainer()	ContainerInfo	返回图表 ContainerInfo，该图表封装了图表在工作表中显示的位置。
getRanges()	Range[]	返回当前为此图表提供数据的范围列表的副本。
removeRange(range)	EmbeddedChartBuilder	从此构建器修改的图表中移除指定范围。
reverseCategories()	EmbeddedAreaChartBuilder	反转领域轴中系列图表的绘制方向。
setBackgroundColor(cssValue)	EmbeddedAreaChartBuilder	设置图表的背景颜色。
setChartType(type)	EmbeddedChartBuilder	更改图表类型。
setColors(cssValues)	EmbeddedAreaChartBuilder	设置图表中线条的颜色。
setHiddenDimensionStrategy(strategy)	EmbeddedChartBuilder	设置要对隐藏的行和列使用的策略。
setLegendPosition(position)	EmbeddedAreaChartBuilder	设置图例相对于图表的位置。
setLegendTextStyle(textStyle)	EmbeddedAreaChartBuilder	设置图表图例的文本样式。
setMergeStrategy(mergeStrategy)	EmbeddedChartBuilder	设置在存在多个范围时要使用的合并策略。
setNumHeaders(headers)	EmbeddedChartBuilder	设置应被视为标题的范围的行数或列数。
setOption(option, value)	EmbeddedChartBuilder	设置此图表的高级选项。
setPointStyle(style)	EmbeddedAreaChartBuilder	设置线条中点的样式。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)	EmbeddedChartBuilder	设置位置，更改图表在工作表中的显示位置。
setRange(start, end)	EmbeddedAreaChartBuilder	设置图表的范围。
setStacked()	EmbeddedAreaChartBuilder	使用堆叠折线，即折线和条形值会堆叠（累加）。
setTitle(chartTitle)	EmbeddedAreaChartBuilder	设置图表的标题。
setTitleTextStyle(textStyle)	EmbeddedAreaChartBuilder	设置图表标题的文本样式。
setTransposeRowsAndColumns(transpose)	EmbeddedChartBuilder	设置图表的行和列是否要转置。
setXAxisTextStyle(textStyle)	EmbeddedAreaChartBuilder	设置横轴文本样式。
setXAxisTitle(title)	EmbeddedAreaChartBuilder	为横轴添加标题。
setXAxisTitleTextStyle(textStyle)	EmbeddedAreaChartBuilder	设置横轴标题文本样式。
setYAxisTextStyle(textStyle)	EmbeddedAreaChartBuilder	设置纵轴文本样式。
setYAxisTitle(title)	EmbeddedAreaChartBuilder	为纵轴添加标题。
setYAxisTitleTextStyle(textStyle)	EmbeddedAreaChartBuilder	设置纵轴标题文本样式。
useLogScale()	EmbeddedAreaChartBuilder	将范围轴设为对数刻度（要求所有值均为正数）。

EmbeddedBarChartBuilder

方法

方法	返回类型	简介
addRange(range)	EmbeddedChartBuilder	向此构建器修改的图表添加范围。
asAreaChart()	EmbeddedAreaChartBuilder	将图表类型设置为“AreaChart”，并返回 EmbeddedAreaChartBuilder。
asBarChart()	EmbeddedBarChartBuilder	将图表类型设置为 BarChart，并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为 HistogramChart，并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为 LineChart，并返回 EmbeddedLineChartBuilder。
asPieChart()	EmbeddedPieChartBuilder	将图表类型设置为 PieChart，并返回 EmbeddedPieChartBuilder。
asScatterChart()	EmbeddedScatterChartBuilder	将图表类型设置为 ScatterChart，并返回 EmbeddedScatterChartBuilder。
asTableChart()	EmbeddedTableChartBuilder	将图表类型设置为 TableChart，并返回 EmbeddedTableChartBuilder。
build()	EmbeddedChart	构建图表，以反映对其所做的所有更改。
clearRanges()	EmbeddedChartBuilder	从此构建器修改的图表中移除所有范围。
getChartType()	ChartType	返回当前图表类型。
getContainer()	ContainerInfo	返回图表 ContainerInfo，该图表封装了图表在工作表中显示的位置。
getRanges()	Range[]	返回当前为此图表提供数据的范围列表的副本。
removeRange(range)	EmbeddedChartBuilder	从此构建器修改的图表中移除指定范围。
reverseCategories()	EmbeddedBarChartBuilder	反转领域轴中系列图表的绘制方向。
reverseDirection()	EmbeddedBarChartBuilder	将条形沿水平轴的增长方向反转。
setBackgroundColor(cssValue)	EmbeddedBarChartBuilder	设置图表的背景颜色。
setChartType(type)	EmbeddedChartBuilder	更改图表类型。
setColors(cssValues)	EmbeddedBarChartBuilder	设置图表中线条的颜色。
setHiddenDimensionStrategy(strategy)	EmbeddedChartBuilder	设置要对隐藏的行和列使用的策略。
setLegendPosition(position)	EmbeddedBarChartBuilder	设置图例相对于图表的位置。
setLegendTextStyle(textStyle)	EmbeddedBarChartBuilder	设置图表图例的文本样式。
setMergeStrategy(mergeStrategy)	EmbeddedChartBuilder	设置在存在多个范围时要使用的合并策略。
setNumHeaders(headers)	EmbeddedChartBuilder	设置应被视为标题的范围的行数或列数。
setOption(option, value)	EmbeddedChartBuilder	设置此图表的高级选项。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)	EmbeddedChartBuilder	设置位置，更改图表在工作表中的显示位置。
setRange(start, end)	EmbeddedBarChartBuilder	设置图表的范围。
setStacked()	EmbeddedBarChartBuilder	使用堆叠折线，即折线和条形值会堆叠（累加）。
setTitle(chartTitle)	EmbeddedBarChartBuilder	设置图表的标题。
setTitleTextStyle(textStyle)	EmbeddedBarChartBuilder	设置图表标题的文本样式。
setTransposeRowsAndColumns(transpose)	EmbeddedChartBuilder	设置图表的行和列是否要转置。
setXAxisTextStyle(textStyle)	EmbeddedBarChartBuilder	设置横轴文本样式。
setXAxisTitle(title)	EmbeddedBarChartBuilder	为横轴添加标题。
setXAxisTitleTextStyle(textStyle)	EmbeddedBarChartBuilder	设置横轴标题文本样式。
setYAxisTextStyle(textStyle)	EmbeddedBarChartBuilder	设置纵轴文本样式。
setYAxisTitle(title)	EmbeddedBarChartBuilder	为纵轴添加标题。
setYAxisTitleTextStyle(textStyle)	EmbeddedBarChartBuilder	设置纵轴标题文本样式。
useLogScale()	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

方法

方法	返回类型	简介
addRange(range)	EmbeddedChartBuilder	向此构建器修改的图表添加范围。
asAreaChart()	EmbeddedAreaChartBuilder	将图表类型设置为“AreaChart”，并返回 EmbeddedAreaChartBuilder。
asBarChart()	EmbeddedBarChartBuilder	将图表类型设置为 BarChart，并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为 HistogramChart，并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为 LineChart，并返回 EmbeddedLineChartBuilder。
asPieChart()	EmbeddedPieChartBuilder	将图表类型设置为 PieChart，并返回 EmbeddedPieChartBuilder。
asScatterChart()	EmbeddedScatterChartBuilder	将图表类型设置为 ScatterChart，并返回 EmbeddedScatterChartBuilder。
asTableChart()	EmbeddedTableChartBuilder	将图表类型设置为 TableChart，并返回 EmbeddedTableChartBuilder。
build()	EmbeddedChart	构建图表，以反映对其所做的所有更改。
clearRanges()	EmbeddedChartBuilder	从此构建器修改的图表中移除所有范围。
getChartType()	ChartType	返回当前图表类型。
getContainer()	ContainerInfo	返回图表 ContainerInfo，该图表封装了图表在工作表中显示的位置。
getRanges()	Range[]	返回当前为此图表提供数据的范围列表的副本。
removeRange(range)	EmbeddedChartBuilder	从此构建器修改的图表中移除指定范围。
setChartType(type)	EmbeddedChartBuilder	更改图表类型。
setHiddenDimensionStrategy(strategy)	EmbeddedChartBuilder	设置要对隐藏的行和列使用的策略。
setMergeStrategy(mergeStrategy)	EmbeddedChartBuilder	设置在存在多个范围时要使用的合并策略。
setNumHeaders(headers)	EmbeddedChartBuilder	设置应被视为标题的范围的行数或列数。
setOption(option, value)	EmbeddedChartBuilder	设置此图表的高级选项。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)	EmbeddedChartBuilder	设置位置，更改图表在工作表中的显示位置。
setTransposeRowsAndColumns(transpose)	EmbeddedChartBuilder	设置图表的行和列是否要转置。

EmbeddedColumnChartBuilder

方法

方法	返回类型	简介
addRange(range)	EmbeddedChartBuilder	向此构建器修改的图表添加范围。
asAreaChart()	EmbeddedAreaChartBuilder	将图表类型设置为“AreaChart”，并返回 EmbeddedAreaChartBuilder。
asBarChart()	EmbeddedBarChartBuilder	将图表类型设置为 BarChart，并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为 HistogramChart，并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为 LineChart，并返回 EmbeddedLineChartBuilder。
asPieChart()	EmbeddedPieChartBuilder	将图表类型设置为 PieChart，并返回 EmbeddedPieChartBuilder。
asScatterChart()	EmbeddedScatterChartBuilder	将图表类型设置为 ScatterChart，并返回 EmbeddedScatterChartBuilder。
asTableChart()	EmbeddedTableChartBuilder	将图表类型设置为 TableChart，并返回 EmbeddedTableChartBuilder。
build()	EmbeddedChart	构建图表，以反映对其所做的所有更改。
clearRanges()	EmbeddedChartBuilder	从此构建器修改的图表中移除所有范围。
getChartType()	ChartType	返回当前图表类型。
getContainer()	ContainerInfo	返回图表 ContainerInfo，该图表封装了图表在工作表中显示的位置。
getRanges()	Range[]	返回当前为此图表提供数据的范围列表的副本。
removeRange(range)	EmbeddedChartBuilder	从此构建器修改的图表中移除指定范围。
reverseCategories()	EmbeddedColumnChartBuilder	反转领域轴中系列图表的绘制方向。
setBackgroundColor(cssValue)	EmbeddedColumnChartBuilder	设置图表的背景颜色。
setChartType(type)	EmbeddedChartBuilder	更改图表类型。
setColors(cssValues)	EmbeddedColumnChartBuilder	设置图表中线条的颜色。
setHiddenDimensionStrategy(strategy)	EmbeddedChartBuilder	设置要对隐藏的行和列使用的策略。
setLegendPosition(position)	EmbeddedColumnChartBuilder	设置图例相对于图表的位置。
setLegendTextStyle(textStyle)	EmbeddedColumnChartBuilder	设置图表图例的文本样式。
setMergeStrategy(mergeStrategy)	EmbeddedChartBuilder	设置在存在多个范围时要使用的合并策略。
setNumHeaders(headers)	EmbeddedChartBuilder	设置应被视为标题的范围的行数或列数。
setOption(option, value)	EmbeddedChartBuilder	设置此图表的高级选项。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)	EmbeddedChartBuilder	设置位置，更改图表在工作表中的显示位置。
setRange(start, end)	EmbeddedColumnChartBuilder	设置图表的范围。
setStacked()	EmbeddedColumnChartBuilder	使用堆叠折线，即折线和条形值会堆叠（累加）。
setTitle(chartTitle)	EmbeddedColumnChartBuilder	设置图表的标题。
setTitleTextStyle(textStyle)	EmbeddedColumnChartBuilder	设置图表标题的文本样式。
setTransposeRowsAndColumns(transpose)	EmbeddedChartBuilder	设置图表的行和列是否要转置。
setXAxisTextStyle(textStyle)	EmbeddedColumnChartBuilder	设置横轴文本样式。
setXAxisTitle(title)	EmbeddedColumnChartBuilder	为横轴添加标题。
setXAxisTitleTextStyle(textStyle)	EmbeddedColumnChartBuilder	设置横轴标题文本样式。
setYAxisTextStyle(textStyle)	EmbeddedColumnChartBuilder	设置纵轴文本样式。
setYAxisTitle(title)	EmbeddedColumnChartBuilder	为纵轴添加标题。
setYAxisTitleTextStyle(textStyle)	EmbeddedColumnChartBuilder	设置纵轴标题文本样式。
useLogScale()	EmbeddedColumnChartBuilder	将范围轴设为对数刻度（要求所有值均为正数）。

EmbeddedComboChartBuilder

方法

方法	返回类型	简介
addRange(range)	EmbeddedChartBuilder	向此构建器修改的图表添加范围。
asAreaChart()	EmbeddedAreaChartBuilder	将图表类型设置为“AreaChart”，并返回 EmbeddedAreaChartBuilder。
asBarChart()	EmbeddedBarChartBuilder	将图表类型设置为 BarChart，并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为 HistogramChart，并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为 LineChart，并返回 EmbeddedLineChartBuilder。
asPieChart()	EmbeddedPieChartBuilder	将图表类型设置为 PieChart，并返回 EmbeddedPieChartBuilder。
asScatterChart()	EmbeddedScatterChartBuilder	将图表类型设置为 ScatterChart，并返回 EmbeddedScatterChartBuilder。
asTableChart()	EmbeddedTableChartBuilder	将图表类型设置为 TableChart，并返回 EmbeddedTableChartBuilder。
build()	EmbeddedChart	构建图表，以反映对其所做的所有更改。
clearRanges()	EmbeddedChartBuilder	从此构建器修改的图表中移除所有范围。
getChartType()	ChartType	返回当前图表类型。
getContainer()	ContainerInfo	返回图表 ContainerInfo，该图表封装了图表在工作表中显示的位置。
getRanges()	Range[]	返回当前为此图表提供数据的范围列表的副本。
removeRange(range)	EmbeddedChartBuilder	从此构建器修改的图表中移除指定范围。
reverseCategories()	EmbeddedComboChartBuilder	反转领域轴中系列图表的绘制方向。
setBackgroundColor(cssValue)	EmbeddedComboChartBuilder	设置图表的背景颜色。
setChartType(type)	EmbeddedChartBuilder	更改图表类型。
setColors(cssValues)	EmbeddedComboChartBuilder	设置图表中线条的颜色。
setHiddenDimensionStrategy(strategy)	EmbeddedChartBuilder	设置要对隐藏的行和列使用的策略。
setLegendPosition(position)	EmbeddedComboChartBuilder	设置图例相对于图表的位置。
setLegendTextStyle(textStyle)	EmbeddedComboChartBuilder	设置图表图例的文本样式。
setMergeStrategy(mergeStrategy)	EmbeddedChartBuilder	设置在存在多个范围时要使用的合并策略。
setNumHeaders(headers)	EmbeddedChartBuilder	设置应被视为标题的范围的行数或列数。
setOption(option, value)	EmbeddedChartBuilder	设置此图表的高级选项。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)	EmbeddedChartBuilder	设置位置，更改图表在工作表中的显示位置。
setRange(start, end)	EmbeddedComboChartBuilder	设置图表的范围。
setStacked()	EmbeddedComboChartBuilder	使用堆叠折线，即折线和条形值会堆叠（累加）。
setTitle(chartTitle)	EmbeddedComboChartBuilder	设置图表的标题。
setTitleTextStyle(textStyle)	EmbeddedComboChartBuilder	设置图表标题的文本样式。
setTransposeRowsAndColumns(transpose)	EmbeddedChartBuilder	设置图表的行和列是否要转置。
setXAxisTextStyle(textStyle)	EmbeddedComboChartBuilder	设置横轴文本样式。
setXAxisTitle(title)	EmbeddedComboChartBuilder	为横轴添加标题。
setXAxisTitleTextStyle(textStyle)	EmbeddedComboChartBuilder	设置横轴标题文本样式。
setYAxisTextStyle(textStyle)	EmbeddedComboChartBuilder	设置纵轴文本样式。
setYAxisTitle(title)	EmbeddedComboChartBuilder	为纵轴添加标题。
setYAxisTitleTextStyle(textStyle)	EmbeddedComboChartBuilder	设置纵轴标题文本样式。
useLogScale()	EmbeddedComboChartBuilder	将范围轴设为对数刻度（要求所有值均为正数）。

EmbeddedHistogramChartBuilder

方法

方法	返回类型	简介
addRange(range)	EmbeddedChartBuilder	向此构建器修改的图表添加范围。
asAreaChart()	EmbeddedAreaChartBuilder	将图表类型设置为“AreaChart”，并返回 EmbeddedAreaChartBuilder。
asBarChart()	EmbeddedBarChartBuilder	将图表类型设置为 BarChart，并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为 HistogramChart，并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为 LineChart，并返回 EmbeddedLineChartBuilder。
asPieChart()	EmbeddedPieChartBuilder	将图表类型设置为 PieChart，并返回 EmbeddedPieChartBuilder。
asScatterChart()	EmbeddedScatterChartBuilder	将图表类型设置为 ScatterChart，并返回 EmbeddedScatterChartBuilder。
asTableChart()	EmbeddedTableChartBuilder	将图表类型设置为 TableChart，并返回 EmbeddedTableChartBuilder。
build()	EmbeddedChart	构建图表，以反映对其所做的所有更改。
clearRanges()	EmbeddedChartBuilder	从此构建器修改的图表中移除所有范围。
getChartType()	ChartType	返回当前图表类型。
getContainer()	ContainerInfo	返回图表 ContainerInfo，该图表封装了图表在工作表中显示的位置。
getRanges()	Range[]	返回当前为此图表提供数据的范围列表的副本。
removeRange(range)	EmbeddedChartBuilder	从此构建器修改的图表中移除指定范围。
reverseCategories()	EmbeddedHistogramChartBuilder	反转领域轴中系列图表的绘制方向。
setBackgroundColor(cssValue)	EmbeddedHistogramChartBuilder	设置图表的背景颜色。
setChartType(type)	EmbeddedChartBuilder	更改图表类型。
setColors(cssValues)	EmbeddedHistogramChartBuilder	设置图表中线条的颜色。
setHiddenDimensionStrategy(strategy)	EmbeddedChartBuilder	设置要对隐藏的行和列使用的策略。
setLegendPosition(position)	EmbeddedHistogramChartBuilder	设置图例相对于图表的位置。
setLegendTextStyle(textStyle)	EmbeddedHistogramChartBuilder	设置图表图例的文本样式。
setMergeStrategy(mergeStrategy)	EmbeddedChartBuilder	设置在存在多个范围时要使用的合并策略。
setNumHeaders(headers)	EmbeddedChartBuilder	设置应被视为标题的范围的行数或列数。
setOption(option, value)	EmbeddedChartBuilder	设置此图表的高级选项。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)	EmbeddedChartBuilder	设置位置，更改图表在工作表中的显示位置。
setRange(start, end)	EmbeddedHistogramChartBuilder	设置图表的范围。
setStacked()	EmbeddedHistogramChartBuilder	使用堆叠折线，即折线和条形值会堆叠（累加）。
setTitle(chartTitle)	EmbeddedHistogramChartBuilder	设置图表的标题。
setTitleTextStyle(textStyle)	EmbeddedHistogramChartBuilder	设置图表标题的文本样式。
setTransposeRowsAndColumns(transpose)	EmbeddedChartBuilder	设置图表的行和列是否要转置。
setXAxisTextStyle(textStyle)	EmbeddedHistogramChartBuilder	设置横轴文本样式。
setXAxisTitle(title)	EmbeddedHistogramChartBuilder	为横轴添加标题。
setXAxisTitleTextStyle(textStyle)	EmbeddedHistogramChartBuilder	设置横轴标题文本样式。
setYAxisTextStyle(textStyle)	EmbeddedHistogramChartBuilder	设置纵轴文本样式。
setYAxisTitle(title)	EmbeddedHistogramChartBuilder	为纵轴添加标题。
setYAxisTitleTextStyle(textStyle)	EmbeddedHistogramChartBuilder	设置纵轴标题文本样式。
useLogScale()	EmbeddedHistogramChartBuilder	将范围轴设为对数刻度（要求所有值均为正数）。

EmbeddedLineChartBuilder

方法

方法	返回类型	简介
addRange(range)	EmbeddedChartBuilder	向此构建器修改的图表添加范围。
asAreaChart()	EmbeddedAreaChartBuilder	将图表类型设置为“AreaChart”，并返回 EmbeddedAreaChartBuilder。
asBarChart()	EmbeddedBarChartBuilder	将图表类型设置为 BarChart，并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为 HistogramChart，并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为 LineChart，并返回 EmbeddedLineChartBuilder。
asPieChart()	EmbeddedPieChartBuilder	将图表类型设置为 PieChart，并返回 EmbeddedPieChartBuilder。
asScatterChart()	EmbeddedScatterChartBuilder	将图表类型设置为 ScatterChart，并返回 EmbeddedScatterChartBuilder。
asTableChart()	EmbeddedTableChartBuilder	将图表类型设置为 TableChart，并返回 EmbeddedTableChartBuilder。
build()	EmbeddedChart	构建图表，以反映对其所做的所有更改。
clearRanges()	EmbeddedChartBuilder	从此构建器修改的图表中移除所有范围。
getChartType()	ChartType	返回当前图表类型。
getContainer()	ContainerInfo	返回图表 ContainerInfo，该图表封装了图表在工作表中显示的位置。
getRanges()	Range[]	返回当前为此图表提供数据的范围列表的副本。
removeRange(range)	EmbeddedChartBuilder	从此构建器修改的图表中移除指定范围。
reverseCategories()	EmbeddedLineChartBuilder	反转领域轴中系列图表的绘制方向。
setBackgroundColor(cssValue)	EmbeddedLineChartBuilder	设置图表的背景颜色。
setChartType(type)	EmbeddedChartBuilder	更改图表类型。
setColors(cssValues)	EmbeddedLineChartBuilder	设置图表中线条的颜色。
setCurveStyle(style)	EmbeddedLineChartBuilder	设置图表中曲线的样式。
setHiddenDimensionStrategy(strategy)	EmbeddedChartBuilder	设置要对隐藏的行和列使用的策略。
setLegendPosition(position)	EmbeddedLineChartBuilder	设置图例相对于图表的位置。
setLegendTextStyle(textStyle)	EmbeddedLineChartBuilder	设置图表图例的文本样式。
setMergeStrategy(mergeStrategy)	EmbeddedChartBuilder	设置在存在多个范围时要使用的合并策略。
setNumHeaders(headers)	EmbeddedChartBuilder	设置应被视为标题的范围的行数或列数。
setOption(option, value)	EmbeddedChartBuilder	设置此图表的高级选项。
setPointStyle(style)	EmbeddedLineChartBuilder	设置线条中点的样式。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)	EmbeddedChartBuilder	设置位置，更改图表在工作表中的显示位置。
setRange(start, end)	EmbeddedLineChartBuilder	设置图表的范围。
setTitle(chartTitle)	EmbeddedLineChartBuilder	设置图表的标题。
setTitleTextStyle(textStyle)	EmbeddedLineChartBuilder	设置图表标题的文本样式。
setTransposeRowsAndColumns(transpose)	EmbeddedChartBuilder	设置图表的行和列是否要转置。
setXAxisTextStyle(textStyle)	EmbeddedLineChartBuilder	设置横轴文本样式。
setXAxisTitle(title)	EmbeddedLineChartBuilder	为横轴添加标题。
setXAxisTitleTextStyle(textStyle)	EmbeddedLineChartBuilder	设置横轴标题文本样式。
setYAxisTextStyle(textStyle)	EmbeddedLineChartBuilder	设置纵轴文本样式。
setYAxisTitle(title)	EmbeddedLineChartBuilder	为纵轴添加标题。
setYAxisTitleTextStyle(textStyle)	EmbeddedLineChartBuilder	设置纵轴标题文本样式。
useLogScale()	EmbeddedLineChartBuilder	将范围轴设为对数刻度（要求所有值均为正数）。

EmbeddedPieChartBuilder

方法

方法	返回类型	简介
addRange(range)	EmbeddedChartBuilder	向此构建器修改的图表添加范围。
asAreaChart()	EmbeddedAreaChartBuilder	将图表类型设置为“AreaChart”，并返回 EmbeddedAreaChartBuilder。
asBarChart()	EmbeddedBarChartBuilder	将图表类型设置为 BarChart，并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为 HistogramChart，并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为 LineChart，并返回 EmbeddedLineChartBuilder。
asPieChart()	EmbeddedPieChartBuilder	将图表类型设置为 PieChart，并返回 EmbeddedPieChartBuilder。
asScatterChart()	EmbeddedScatterChartBuilder	将图表类型设置为 ScatterChart，并返回 EmbeddedScatterChartBuilder。
asTableChart()	EmbeddedTableChartBuilder	将图表类型设置为 TableChart，并返回 EmbeddedTableChartBuilder。
build()	EmbeddedChart	构建图表，以反映对其所做的所有更改。
clearRanges()	EmbeddedChartBuilder	从此构建器修改的图表中移除所有范围。
getChartType()	ChartType	返回当前图表类型。
getContainer()	ContainerInfo	返回图表 ContainerInfo，该图表封装了图表在工作表中显示的位置。
getRanges()	Range[]	返回当前为此图表提供数据的范围列表的副本。
removeRange(range)	EmbeddedChartBuilder	从此构建器修改的图表中移除指定范围。
reverseCategories()	EmbeddedPieChartBuilder	反转领域轴中系列图表的绘制方向。
set3D()	EmbeddedPieChartBuilder	将图表设为三维图表。
setBackgroundColor(cssValue)	EmbeddedPieChartBuilder	设置图表的背景颜色。
setChartType(type)	EmbeddedChartBuilder	更改图表类型。
setColors(cssValues)	EmbeddedPieChartBuilder	设置图表中线条的颜色。
setHiddenDimensionStrategy(strategy)	EmbeddedChartBuilder	设置要对隐藏的行和列使用的策略。
setLegendPosition(position)	EmbeddedPieChartBuilder	设置图例相对于图表的位置。
setLegendTextStyle(textStyle)	EmbeddedPieChartBuilder	设置图表图例的文本样式。
setMergeStrategy(mergeStrategy)	EmbeddedChartBuilder	设置在存在多个范围时要使用的合并策略。
setNumHeaders(headers)	EmbeddedChartBuilder	设置应被视为标题的范围的行数或列数。
setOption(option, value)	EmbeddedChartBuilder	设置此图表的高级选项。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)	EmbeddedChartBuilder	设置位置，更改图表在工作表中的显示位置。
setTitle(chartTitle)	EmbeddedPieChartBuilder	设置图表的标题。
setTitleTextStyle(textStyle)	EmbeddedPieChartBuilder	设置图表标题的文本样式。
setTransposeRowsAndColumns(transpose)	EmbeddedChartBuilder	设置图表的行和列是否要转置。

EmbeddedScatterChartBuilder

方法

方法	返回类型	简介
addRange(range)	EmbeddedChartBuilder	向此构建器修改的图表添加范围。
asAreaChart()	EmbeddedAreaChartBuilder	将图表类型设置为“AreaChart”，并返回 EmbeddedAreaChartBuilder。
asBarChart()	EmbeddedBarChartBuilder	将图表类型设置为 BarChart，并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为 HistogramChart，并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为 LineChart，并返回 EmbeddedLineChartBuilder。
asPieChart()	EmbeddedPieChartBuilder	将图表类型设置为 PieChart，并返回 EmbeddedPieChartBuilder。
asScatterChart()	EmbeddedScatterChartBuilder	将图表类型设置为 ScatterChart，并返回 EmbeddedScatterChartBuilder。
asTableChart()	EmbeddedTableChartBuilder	将图表类型设置为 TableChart，并返回 EmbeddedTableChartBuilder。
build()	EmbeddedChart	构建图表，以反映对其所做的所有更改。
clearRanges()	EmbeddedChartBuilder	从此构建器修改的图表中移除所有范围。
getChartType()	ChartType	返回当前图表类型。
getContainer()	ContainerInfo	返回图表 ContainerInfo，该图表封装了图表在工作表中显示的位置。
getRanges()	Range[]	返回当前为此图表提供数据的范围列表的副本。
removeRange(range)	EmbeddedChartBuilder	从此构建器修改的图表中移除指定范围。
setBackgroundColor(cssValue)	EmbeddedScatterChartBuilder	设置图表的背景颜色。
setChartType(type)	EmbeddedChartBuilder	更改图表类型。
setColors(cssValues)	EmbeddedScatterChartBuilder	设置图表中线条的颜色。
setHiddenDimensionStrategy(strategy)	EmbeddedChartBuilder	设置要对隐藏的行和列使用的策略。
setLegendPosition(position)	EmbeddedScatterChartBuilder	设置图例相对于图表的位置。
setLegendTextStyle(textStyle)	EmbeddedScatterChartBuilder	设置图表图例的文本样式。
setMergeStrategy(mergeStrategy)	EmbeddedChartBuilder	设置在存在多个范围时要使用的合并策略。
setNumHeaders(headers)	EmbeddedChartBuilder	设置应被视为标题的范围的行数或列数。
setOption(option, value)	EmbeddedChartBuilder	设置此图表的高级选项。
setPointStyle(style)	EmbeddedScatterChartBuilder	设置线条中点的样式。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)	EmbeddedChartBuilder	设置位置，更改图表在工作表中的显示位置。
setTitle(chartTitle)	EmbeddedScatterChartBuilder	设置图表的标题。
setTitleTextStyle(textStyle)	EmbeddedScatterChartBuilder	设置图表标题的文本样式。
setTransposeRowsAndColumns(transpose)	EmbeddedChartBuilder	设置图表的行和列是否要转置。
setXAxisLogScale()	EmbeddedScatterChartBuilder	将横轴设为对数刻度（要求所有值均为正数）。
setXAxisRange(start, end)	EmbeddedScatterChartBuilder	设置图表横轴的范围。
setXAxisTextStyle(textStyle)	EmbeddedScatterChartBuilder	设置横轴文本样式。
setXAxisTitle(title)	EmbeddedScatterChartBuilder	为横轴添加标题。
setXAxisTitleTextStyle(textStyle)	EmbeddedScatterChartBuilder	设置横轴标题文本样式。
setYAxisLogScale()	EmbeddedScatterChartBuilder	将纵轴设为对数刻度（要求所有值均为正数）。
setYAxisRange(start, end)	EmbeddedScatterChartBuilder	设置图表的纵轴范围。
setYAxisTextStyle(textStyle)	EmbeddedScatterChartBuilder	设置纵轴文本样式。
setYAxisTitle(title)	EmbeddedScatterChartBuilder	为纵轴添加标题。
setYAxisTitleTextStyle(textStyle)	EmbeddedScatterChartBuilder	设置纵轴标题文本样式。

EmbeddedTableChartBuilder

方法

方法	返回类型	简介
addRange(range)	EmbeddedChartBuilder	向此构建器修改的图表添加范围。
asAreaChart()	EmbeddedAreaChartBuilder	将图表类型设置为“AreaChart”，并返回 EmbeddedAreaChartBuilder。
asBarChart()	EmbeddedBarChartBuilder	将图表类型设置为 BarChart，并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为 HistogramChart，并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为 LineChart，并返回 EmbeddedLineChartBuilder。
asPieChart()	EmbeddedPieChartBuilder	将图表类型设置为 PieChart，并返回 EmbeddedPieChartBuilder。
asScatterChart()	EmbeddedScatterChartBuilder	将图表类型设置为 ScatterChart，并返回 EmbeddedScatterChartBuilder。
asTableChart()	EmbeddedTableChartBuilder	将图表类型设置为 TableChart，并返回 EmbeddedTableChartBuilder。
build()	EmbeddedChart	构建图表，以反映对其所做的所有更改。
clearRanges()	EmbeddedChartBuilder	从此构建器修改的图表中移除所有范围。
enablePaging(enablePaging)	EmbeddedTableChartBuilder	设置是否启用数据分页。
enablePaging(pageSize)	EmbeddedTableChartBuilder	启用分页并设置每页的行数。
enablePaging(pageSize, startPage)	EmbeddedTableChartBuilder	启用分页，设置每页的行数以及要显示的表格第一页（页码从零开始）。
enableRtlTable(rtlEnabled)	EmbeddedTableChartBuilder	通过将表格的列顺序反转，为从右到左书写的语言（例如阿拉伯语或希伯来语）添加了基本支持，这样，第 0 列就是最右列，最后一列就是最左列。
enableSorting(enableSorting)	EmbeddedTableChartBuilder	设置在用户点击列标题时是否对列进行排序。
getChartType()	ChartType	返回当前图表类型。
getContainer()	ContainerInfo	返回图表 ContainerInfo，该图表封装了图表在工作表中显示的位置。
getRanges()	Range[]	返回当前为此图表提供数据的范围列表的副本。
removeRange(range)	EmbeddedChartBuilder	从此构建器修改的图表中移除指定范围。
setChartType(type)	EmbeddedChartBuilder	更改图表类型。
setFirstRowNumber(number)	EmbeddedTableChartBuilder	设置数据表格中第一行的行号。
setHiddenDimensionStrategy(strategy)	EmbeddedChartBuilder	设置要对隐藏的行和列使用的策略。
setInitialSortingAscending(column)	EmbeddedTableChartBuilder	设置应按其对表格进行初始排序（升序）的列的索引。
setInitialSortingDescending(column)	EmbeddedTableChartBuilder	设置应按其对表格进行初始排序（降序）的列的索引。
setMergeStrategy(mergeStrategy)	EmbeddedChartBuilder	设置在存在多个范围时要使用的合并策略。
setNumHeaders(headers)	EmbeddedChartBuilder	设置应被视为标题的范围的行数或列数。
setOption(option, value)	EmbeddedChartBuilder	设置此图表的高级选项。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)	EmbeddedChartBuilder	设置位置，更改图表在工作表中的显示位置。
setTransposeRowsAndColumns(transpose)	EmbeddedChartBuilder	设置图表的行和列是否要转置。
showRowNumberColumn(showRowNumber)	EmbeddedTableChartBuilder	设置是否将行号显示为表格的第一个列。
useAlternatingRowStyle(alternate)	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

方法

方法	返回类型	简介
build()	FilterCriteria	使用您添加到条件构建器中的设置组装过滤条件。
copy()	FilterCriteriaBuilder	复制此过滤条件，并创建一个可应用于其他过滤条件的条件构建器。
getCriteriaType()	BooleanCriteria	返回条件的布尔值类型，例如 CELL_EMPTY。
getCriteriaValues()	Object[]	返回布尔条件的参数数组。
getHiddenValues()	String[]	返回过滤器隐藏的值。
getVisibleBackgroundColor()	Color	返回用作过滤条件的背景颜色。
getVisibleForegroundColor()	Color	返回用作过滤条件的前景颜色。
getVisibleValues()	String[]	返回数据透视表过滤条件显示的值。
setHiddenValues(values)	FilterCriteriaBuilder	设置要隐藏的值。
setVisibleBackgroundColor(visibleBackgroundColor)	FilterCriteriaBuilder	设置用作过滤条件的背景颜色。
setVisibleForegroundColor(visibleForegroundColor)	FilterCriteriaBuilder	设置用作过滤条件的前景颜色。
setVisibleValues(values)	FilterCriteriaBuilder	设置要在数据透视表中显示的值。
whenCellEmpty()	FilterCriteriaBuilder	设置过滤条件以显示空白单元格。
whenCellNotEmpty()	FilterCriteriaBuilder	设置过滤条件以显示非空单元格。
whenDateAfter(date)	FilterCriteriaBuilder	设置过滤条件，以显示日期晚于指定日期的单元格。
whenDateAfter(date)	FilterCriteriaBuilder	设置过滤条件，以显示日期晚于指定相对日期的单元格。
whenDateBefore(date)	FilterCriteriaBuilder	设置过滤条件，以显示日期早于指定日期的单元格。
whenDateBefore(date)	FilterCriteriaBuilder	设置过滤条件，以显示日期早于指定相对日期的单元格。
whenDateEqualTo(date)	FilterCriteriaBuilder	设置过滤条件，以显示日期等于指定日期的单元格。
whenDateEqualTo(date)	FilterCriteriaBuilder	设置过滤条件，以显示日期等于指定相对日期的单元格。
whenDateEqualToAny(dates)	FilterCriteriaBuilder	设置过滤条件，以显示日期等于任何指定日期的单元格。
whenDateNotEqualTo(date)	FilterCriteriaBuilder	设置过滤条件，以显示不等于指定日期的单元格。
whenDateNotEqualToAny(dates)	FilterCriteriaBuilder	设置过滤条件，以显示日期不等于任何指定日期的单元格。
whenFormulaSatisfied(formula)	FilterCriteriaBuilder	设置过滤条件，以显示计算结果为 true 的指定公式（例如 =B:B<C:C）对应的单元格。
whenNumberBetween(start, end)	FilterCriteriaBuilder	设置过滤条件，以显示数字介于 2 个指定数字之间或等于其中一个数字的单元格。
whenNumberEqualTo(number)	FilterCriteriaBuilder	设置过滤条件，以显示数值等于指定数值的单元格。
whenNumberEqualToAny(numbers)	FilterCriteriaBuilder	设置过滤条件，以显示数字等于任何指定数字的单元格。
whenNumberGreaterThan(number)	FilterCriteriaBuilder	设置过滤条件，以显示数值大于指定数值的单元格
whenNumberGreaterThanOrEqualTo(number)	FilterCriteriaBuilder	设置过滤条件，以显示数值大于或等于指定数值的单元格。
whenNumberLessThan(number)	FilterCriteriaBuilder	设置过滤条件，以显示数字小于指定数字的单元格。
whenNumberLessThanOrEqualTo(number)	FilterCriteriaBuilder	设置过滤条件，以显示数值小于或等于指定数值的单元格。
whenNumberNotBetween(start, end)	FilterCriteriaBuilder	设置过滤条件，以显示数字不在 2 个指定数字之间，也不等于这 2 个数字的单元格。
whenNumberNotEqualTo(number)	FilterCriteriaBuilder	设置过滤条件，以显示数字不等于指定数字的单元格。
whenNumberNotEqualToAny(numbers)	FilterCriteriaBuilder	设置过滤条件，以显示数字不等于任何指定数字的单元格。
whenTextContains(text)	FilterCriteriaBuilder	设置过滤条件，以显示包含指定文本的文本单元格。
whenTextDoesNotContain(text)	FilterCriteriaBuilder	设置过滤条件，以显示文本不含指定文本的单元格。
whenTextEndsWith(text)	FilterCriteriaBuilder	设置过滤条件，以显示文本以指定文本结尾的单元格。
whenTextEqualTo(text)	FilterCriteriaBuilder	设置过滤条件，以显示文本等于指定文本的单元格。
whenTextEqualToAny(texts)	FilterCriteriaBuilder	设置过滤条件，以显示文本等于任何指定文本值的单元格。
whenTextNotEqualTo(text)	FilterCriteriaBuilder	设置过滤条件，以显示文本不等于指定文本的单元格。
whenTextNotEqualToAny(texts)	FilterCriteriaBuilder	设置过滤条件，以显示文本不等于任何指定值的单元格。
whenTextStartsWith(text)	FilterCriteriaBuilder	设置过滤条件，以显示文本以指定文本开头的单元格。
withCriteria(criteria, args)	FilterCriteriaBuilder	将过滤条件设置为由 BooleanCriteria 值（例如 CELL_EMPTY 或 NUMBER_GREATER_THAN）定义的布尔值条件。

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

方法

方法	返回类型	简介
assignScript(functionName)	OverGridImage	将具有指定函数名称的函数分配给此图片。
getAltTextDescription()	String	返回此图片的替代文本说明。
getAltTextTitle()	String	返回此图片的替代文本标题。
getAnchorCell()	Range	返回图片锚定的单元格。
getAnchorCellXOffset()	Integer	返回相对于锚点单元格的水平像素偏移量。
getAnchorCellYOffset()	Integer	返回相对于锚点单元格的垂直像素偏移量。
getHeight()	Integer	返回此图片的实际高度（以像素为单位）。
getInherentHeight()	Integer	返回此图片的固有高度（以像素为单位）。
getInherentWidth()	Integer	返回此图片的固有高度（以像素为单位）。
getScript()	String	返回分配给此图片的函数的名称。
getSheet()	Sheet	返回此图片显示的页面。
getUrl()	String	获取图片的来源网址；如果网址不可用，则返回 null。
getWidth()	Integer	返回此图片的实际宽度（以像素为单位）。
remove()	void	从电子表格中删除此图片。
replace(blob)	OverGridImage	将此图片替换为由提供的 BlobSource 指定的图片。
replace(url)	OverGridImage	将此图片替换为指定网址中的图片。
resetSize()	OverGridImage	将此图片重置为其固有尺寸。
setAltTextDescription(description)	OverGridImage	设置此图片的替代文本说明。
setAltTextTitle(title)	OverGridImage	设置此图片的替代文本标题。
setAnchorCell(cell)	OverGridImage	设置图片锚定的单元格。
setAnchorCellXOffset(offset)	OverGridImage	设置相对于锚点单元格的水平像素偏移量。
setAnchorCellYOffset(offset)	OverGridImage	设置相对于锚点单元格的垂直像素偏移量。
setHeight(height)	OverGridImage	设置此图片的实际高度（以像素为单位）。
setWidth(width)	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	返回数据透视表元素组的透视表元素组限制。
getIndex()	Integer	返回此数据透视组在当前组顺序中的索引。
getPivotTable()	PivotTable	返回此分组所属的 PivotTable。
getSourceDataColumn()	Integer	返回此组汇总的来源数据列的数量。
getSourceDataSourceColumn()	DataSourceColumn	返回数据透视组要对其进行运算的数据源列。
hideRepeatedLabels()	PivotGroup	隐藏此分组的重复标签。
isSortAscending()	Boolean	如果排序方式为升序，则返回 true；如果排序方式为降序，则返回 false。
moveToIndex(index)	PivotGroup	将此组移至当前行或列组列表中的指定位置。
remove()	void	从表格中移除此数据透视组。
removeManualGroupingRule(groupName)	PivotGroup	移除具有指定 groupName 的手动分组规则。
resetDisplayName()	PivotGroup	将数据透视表中此组的显示名称重置为默认值。
setDateTimeGroupingRule(dateTimeGroupingRuleType)	PivotGroup	为数据透视表组设置日期时间分组规则。
setDisplayName(name)	PivotGroup	设置数据透视表中此组的显示名称。
setGroupLimit(countLimit)	PivotGroup	为数据透视表元素组设置数据透视表元素组限制。
setHistogramGroupingRule(minValue, maxValue, intervalSize)	PivotGroup	为此数据透视表组设置直方图分组规则。
showRepeatedLabels()	PivotGroup	如果有多个行或列分组，此方法会为后续分组的每个条目显示此分组的标签。
showTotals(showTotals)	PivotGroup	设置是否要在表格中显示此数据透视组的总值。
sortAscending()	PivotGroup	将排序顺序设为升序。
sortBy(value, oppositeGroupValues)	PivotGroup	按 oppositeGroupValues 中的值的指定 PivotValue 对此组进行排序。
sortDescending()	PivotGroup	将排序顺序设为降序。
totalsAreShown()	Boolean	返回此数据透视组目前是否显示总值。

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

方法

方法	返回类型	简介
addEditor(emailAddress)	Protection	将指定用户添加到受保护工作表或范围的编辑者列表中。
addEditor(user)	Protection	将指定用户添加到受保护工作表或范围的编辑者列表中。
addEditors(emailAddresses)	Protection	将指定的用户数组添加到受保护工作表或范围的编辑者列表中。
addTargetAudience(audienceId)	Protection	将指定的目标对象群组添加为受保护范围的编辑者。
canDomainEdit()	Boolean	确定拥有电子表格的网域中的所有用户是否有权修改受保护的范围或工作表。
canEdit()	Boolean	确定用户是否有权修改受保护的范围或工作表。
getDescription()	String	获取受保护范围或工作表的说明。
getEditors()	User[]	获取受保护范围或工作表的编辑者列表。
getProtectionType()	ProtectionType	获取受保护区域的类型，RANGE 或 SHEET。
getRange()	Range	获取要保护的范围。
getRangeName()	String	获取受保护范围的名称（如果与命名范围相关联）。
getTargetAudiences()	TargetAudience[]	返回可以修改受保护范围的目标受众群体的 ID。
getUnprotectedRanges()	Range[]	获取受保护工作表中不受保护的范围的数组。
isWarningOnly()	Boolean	确定受保护区域是否使用“基于警告”保护。
remove()	void	取消保护范围或工作表。
removeEditor(emailAddress)	Protection	从受保护工作表或范围的编辑者列表中移除指定用户。
removeEditor(user)	Protection	从受保护工作表或范围的编辑者列表中移除指定用户。
removeEditors(emailAddresses)	Protection	从受保护工作表或范围的编辑者列表中移除指定的用户数组。
removeTargetAudience(audienceId)	Protection	移除指定目标对象群组作为受保护范围的编辑者。
setDescription(description)	Protection	设置受保护范围或工作表的说明。
setDomainEdit(editable)	Protection	设置电子表格所属网域中的所有用户是否有权修改受保护的范围或工作表。
setNamedRange(namedRange)	Protection	将受保护的范围与现有的命名范围相关联。
setRange(range)	Protection	调整要保护的范围。
setRangeName(rangeName)	Protection	将受保护的范围与现有的命名范围相关联。
setUnprotectedRanges(ranges)	Protection	取消保护受保护工作表中的给定范围数组。
setWarningOnly(warningOnly)	Protection	设置此受保护范围是否使用“基于警告”保护。

ProtectionType

属性

属性	类型	说明
RANGE	Enum	对某个范围的保护。
SHEET	Enum	对工作表的保护。

Range

方法

方法	返回类型	简介
activate()	Range	将指定范围设置为 active range，并将范围中的左上角单元格设置为 current cell。
activateAsCurrentCell()	Range	将指定单元格设置为 current cell。
addDeveloperMetadata(key)	Range	向范围添加具有指定键的开发者元数据。
addDeveloperMetadata(key, visibility)	Range	向范围添加具有指定键和公开范围的开发者元数据。
addDeveloperMetadata(key, value)	Range	向范围添加具有指定键和值的开发者元数据。
addDeveloperMetadata(key, value, visibility)	Range	向范围添加具有指定键、值和公开范围的开发者元数据。
applyColumnBanding()	Banding	将默认的列分组主题应用于范围。
applyColumnBanding(bandingTheme)	Banding	将指定的列分组主题应用于范围。
applyColumnBanding(bandingTheme, showHeader, showFooter)	Banding	将指定的列分组主题应用于具有指定标题和页脚设置的范围。
applyRowBanding()	Banding	将默认的行条纹主题应用于范围。
applyRowBanding(bandingTheme)	Banding	将指定的行条纹主题应用于范围。
applyRowBanding(bandingTheme, showHeader, showFooter)	Banding	将指定的行条纹主题应用于具有指定标题和页脚设置的范围。
autoFill(destination, series)	void	根据此范围内的数据，使用数据填充 destinationRange。
autoFillToNeighbor(series)	void	根据相邻单元格计算要用新数据填充的范围，并根据此范围中包含的数据自动用新值填充该范围。
breakApart()	Range	再次将范围中的所有多列单元格拆分为单个单元格。
canEdit()	Boolean	确定用户是否有权修改范围内的每个单元格。
check()	Range	将范围内的复选框的状态更改为“已选中”。
clear()	Range	清除内容和格式范围。
clear(options)	Range	清除内容范围、格式、数据验证规则和/或备注（如通过给定高级选项指定）。
clearContent()	Range	清除范围的内容，但保留格式。
clearDataValidations()	Range	清除相应范围的数据验证规则。
clearFormat()	Range	清除此范围的格式。
clearNote()	Range	清除给定单元格或单元格中的备注。
collapseGroups()	Range	收起完全包含在范围内的所有组。
copyFormatToRange(gridId, column, columnEnd, row, rowEnd)	void	将范围的格式复制到给定位置。
copyFormatToRange(sheet, column, columnEnd, row, rowEnd)	void	将范围的格式复制到给定位置。
copyTo(destination)	void	将数据从一个单元格范围复制到另一个单元格范围。
copyTo(destination, copyPasteType, transposed)	void	将数据从一个单元格范围复制到另一个单元格范围。
copyTo(destination, options)	void	将数据从一个单元格范围复制到另一个单元格范围。
copyValuesToRange(gridId, column, columnEnd, row, rowEnd)	void	将范围的内容复制到给定位置。
copyValuesToRange(sheet, column, columnEnd, row, rowEnd)	void	将范围的内容复制到给定位置。
createDataSourcePivotTable(dataSource)	DataSourcePivotTable	根据数据源创建一个空的数据源数据透视表，并将其锚定在此范围内的第一个单元格。
createDataSourceTable(dataSource)	DataSourceTable	根据数据源创建一个空数据源表，并将其锚定在此范围内的第一个单元格。
createDeveloperMetadataFinder()	DeveloperMetadataFinder	返回 DeveloperMetadataFinderApi，用于查找此范围内的开发者元数据。
createFilter()	Filter	创建过滤器并将其应用于工作表中的指定范围。
createPivotTable(sourceData)	PivotTable	根据锚定在此范围内第一个单元格的指定 sourceData 创建空数据透视表。
createTextFinder(findText)	TextFinder	为范围创建文本查找器，该查找器可查找和替换此范围中的文本。
deleteCells(shiftDimension)	void	删除此单元格范围。
expandGroups()	Range	展开范围或控件切换开关与此范围相交的收起的组。
getA1Notation()	String	返回范围的字符串说明（采用 A1 表示法）。
getBackground()	String	返回范围（例如 '#ffffff'）中左上角单元格的背景颜色。
getBackgroundObject()	Color	返回范围中左上角单元格的背景颜色。
getBackgroundObjects()	Color[][]	返回指定范围内单元格的背景颜色。
getBackgrounds()	String[][]	返回范围内单元格的背景颜色（例如 '#ffffff'）。
getBandings()	Banding[]	返回应用于此范围中的任何单元格的所有条带。
getCell(row, column)	Range	返回范围内的给定单元格。
getColumn()	Integer	返回此范围的起始列位置。
getDataRegion()	Range	返回在四个基准 Direction 中展开的范围的副本，以覆盖包含数据的所有相邻单元格。
getDataRegion(dimension)	Range	如果指定的维度为 Dimension.ROWS，则返回展开的范围的副本（Direction.UP 和 Direction.DOWN）；如果维度为 Dimension.COLUMNS，则返回展开的范围的副本（Direction.NEXT 和 Direction.PREVIOUS）。
getDataSourceFormula()	DataSourceFormula	返回范围中第一个单元格的 DataSourceFormula；如果该单元格不包含数据源公式，则返回 null。
getDataSourceFormulas()	DataSourceFormula[]	返回范围内单元格的 DataSourceFormula。
getDataSourcePivotTables()	DataSourcePivotTable[]	获取与范围相交的数据源数据透视表。
getDataSourceTables()	DataSourceTable[]	获取与范围相交的数据源表。
getDataSourceUrl()	String	返回此范围内数据的网址，可用于创建图表和查询。
getDataTable()	DataTable	将此对象内的数据作为 DataTable 返回。
getDataTable(firstRowIsHeader)	DataTable	将此范围内的数据作为 DataTable 返回。
getDataValidation()	DataValidation	返回范围中左上角单元格的数据验证规则。
getDataValidations()	DataValidation[][]	返回范围中所有单元格的数据验证规则。
getDeveloperMetadata()	DeveloperMetadata[]	获取与此范围关联的开发者元数据。
getDisplayValue()	String	返回范围中左上角单元格的显示值。
getDisplayValues()	String[][]	返回此范围的值矩形网格。
getFilter()	Filter	返回此范围所属的工作表中的过滤器；如果工作表中没有过滤器，则返回 null。
getFontColorObject()	Color	返回范围左上角单元格的字体颜色。
getFontColorObjects()	Color[][]	返回指定范围内单元格的字体颜色。
getFontFamilies()	String[][]	返回指定范围内单元格的字体系列。
getFontFamily()	String	返回范围左上角单元格的字体系列。
getFontLine()	String	获取范围左上角单元格的线条样式（'underline'、'line-through' 或 'none'）。
getFontLines()	String[][]	获取范围内单元格的线条样式（'underline'、'line-through' 或 'none'）。
getFontSize()	Integer	返回范围左上角单元格的字体大小（以点为单位）。
getFontSizes()	Integer[][]	返回指定范围内单元格的字体大小。
getFontStyle()	String	返回范围左上角单元格的字体样式（'italic' 或 'normal'）。
getFontStyles()	String[][]	返回指定范围内单元格的字体样式。
getFontWeight()	String	返回范围左上角单元格的字体粗细（正常/粗体）。
getFontWeights()	String[][]	返回指定范围内单元格的字体粗细。
getFormula()	String	返回范围左上角单元格的公式（A1 表示法），如果单元格为空或不包含公式，则返回空字符串。
getFormulaR1C1()	String	返回给定单元格的公式（R1C1 表示法），如果没有，则返回 null。
getFormulas()	String[][]	返回范围内单元格的公式（A1 表示法）。
getFormulasR1C1()	String[][]	返回范围中单元格的公式（R1C1 表示法）。
getGridId()	Integer	返回范围父工作表的网格 ID。
getHeight()	Integer	返回范围的高度。
getHorizontalAlignment()	String	返回范围左上角单元格的文本水平对齐方式（左/居中/右）。
getHorizontalAlignments()	String[][]	返回指定范围内单元格的水平对齐方式。
getLastColumn()	Integer	返回结束列位置。
getLastRow()	Integer	返回结束行位置。
getMergedRanges()	Range[]	返回一个 Range 对象数组，表示完全位于当前范围内或包含当前范围内至少一个单元格的合并单元格。
getNextDataCell(direction)	Range	从范围的第一个列和行中的单元格开始，返回指定方向中的下一个单元格，该单元格是包含数据的连续单元格范围的边缘，或者是电子表格在该方向上的边缘单元格。
getNote()	String	返回与给定范围关联的备注。
getNotes()	String[][]	返回与范围中的单元格关联的备注。
getNumColumns()	Integer	返回此范围中的列数。
getNumRows()	Integer	返回此范围中的行数。
getNumberFormat()	String	获取给定范围的左上角单元格的数字或日期格式。
getNumberFormats()	String[][]	返回范围内单元格的数字或日期格式。
getRichTextValue()	RichTextValue	返回范围左上角单元格的富文本值；如果单元格值不是文本，则返回 null。
getRichTextValues()	RichTextValue[][]	返回指定范围内单元格的富文本值。
getRow()	Integer	返回此范围的行位置。
getRowIndex()	Integer	返回此范围的行位置。
getSheet()	Sheet	返回此范围所属的工作表。
getTextDirection()	TextDirection	返回范围左上角单元格的文本方向。
getTextDirections()	TextDirection[][]	返回指定范围内单元格的文本方向。
getTextRotation()	TextRotation	返回范围左上角单元格的文本旋转设置。
getTextRotations()	TextRotation[][]	返回指定范围内单元格的文本旋转设置。
getTextStyle()	TextStyle	返回范围左上角单元格的文本样式。
getTextStyles()	TextStyle[][]	返回指定范围内单元格的文本样式。
getValue()	Object	返回范围中左上角单元格的值。
getValues()	Object[][]	返回此范围的值矩形网格。
getVerticalAlignment()	String	返回范围左上角单元格的垂直对齐方式（上/中/下）。
getVerticalAlignments()	String[][]	返回指定范围内单元格的垂直对齐方式。
getWidth()	Integer	返回范围的列数。
getWrap()	Boolean	返回单元格中的文本是否会换行。
getWrapStrategies()	WrapStrategy[][]	返回范围内单元格的文本换行策略。
getWrapStrategy()	WrapStrategy	返回范围左上角单元格的文本换行策略。
getWraps()	Boolean[][]	返回单元格中的文本是否换行。
insertCells(shiftDimension)	Range	将空白单元格插入此范围。
insertCheckboxes()	Range	将复选框插入到范围中的每个单元格中，并将其配置为勾选时为 true，未勾选时为 false。
insertCheckboxes(checkedValue)	Range	在范围内的每个单元格中插入复选框，并为勾选状态配置自定义值，为未勾选状态配置空字符串。
insertCheckboxes(checkedValue, uncheckedValue)	Range	在范围内的每个单元格中插入复选框，并为勾选和未勾选状态配置自定义值。
isBlank()	Boolean	如果范围完全为空，则返回 true。
isChecked()	Boolean	返回范围内所有单元格的复选框状态是否为“已选中”。
isEndColumnBounded()	Boolean	确定范围的结束位置是否绑定到特定列。
isEndRowBounded()	Boolean	确定范围的结束位置是否绑定到特定行。
isPartOfMerge()	Boolean	如果当前范围中的单元格与任何合并的单元格重叠，则返回 true。
isStartColumnBounded()	Boolean	确定范围的起始位置是否绑定到特定列。
isStartRowBounded()	Boolean	确定范围的起点是否绑定到特定行。
merge()	Range	将范围中的单元格合并为一个单元格块。
mergeAcross()	Range	合并范围中各列中的单元格。
mergeVertically()	Range	合并范围内的单元格。
moveTo(target)	void	将此范围的内容（格式和值）剪切并粘贴到目标范围。
offset(rowOffset, columnOffset)	Range	返回一个新的范围，该范围相对于此范围向右偏移了指定的行数和列数（可以为负数）。
offset(rowOffset, columnOffset, numRows)	Range	返回一个相对于当前范围的新范围，其左上角相对于当前范围向右偏移了指定的行数和列数，并且单元格高度为指定值。
offset(rowOffset, columnOffset, numRows, numColumns)	Range	返回相对于当前范围的新范围，其左上角相对于当前范围向右偏移了指定的行数和列数，并且单元格的高度和宽度为指定值。
protect()	Protection	创建一个对象，可保护相应范围免遭修改，除非用户拥有相应权限。
randomize()	Range	对指定范围内的行进行随机排序。
removeCheckboxes()	Range	从范围中移除所有复选框。
removeDuplicates()	Range	移除此范围内包含与任何前一行值重复的值的行。
removeDuplicates(columnsToCompare)	Range	移除此范围内包含指定列中与任何前一行的值重复的值的行。
setBackground(color)	Range	使用 CSS 表示法（例如 '#ffffff' 或 'white'）设置范围内所有单元格的背景颜色。
setBackgroundObject(color)	Range	设置范围中所有单元格的背景颜色。
setBackgroundObjects(color)	Range	设置矩形背景颜色网格（必须与此范围的尺寸一致）。
setBackgroundRGB(red, green, blue)	Range	使用 RGB 值（介于 0 到 255 之间的整数）将背景设置为指定颜色。
setBackgrounds(color)	Range	设置矩形背景颜色网格（必须与此范围的尺寸一致）。
setBorder(top, left, bottom, right, vertical, horizontal)	Range	设置边框属性。
setBorder(top, left, bottom, right, vertical, horizontal, color, style)	Range	使用颜色和/或样式设置边框属性。
setDataValidation(rule)	Range	为范围内的所有单元格设置一个数据验证规则。
setDataValidations(rules)	Range	为范围中的所有单元格设置数据验证规则。
setFontColor(color)	Range	以 CSS 标记（例如 '#ffffff' 或 'white'）的形式设置字体颜色。
setFontColorObject(color)	Range	设置给定范围的字体颜色。
setFontColorObjects(colors)	Range	设置一个矩形网格字体颜色（必须与此范围的尺寸一致）。
setFontColors(colors)	Range	设置一个矩形网格字体颜色（必须与此范围的尺寸一致）。
setFontFamilies(fontFamilies)	Range	设置字体系列的矩形网格（必须与此范围的尺寸一致）。
setFontFamily(fontFamily)	Range	设置字体系列，例如“Arial”或“Helvetica”。
setFontLine(fontLine)	Range	设置给定范围的字体线条样式（'underline'、'line-through' 或 'none'）。
setFontLines(fontLines)	Range	设置线条样式的矩形网格（必须与此范围的尺寸一致）。
setFontSize(size)	Range	设置字体大小，大小是指要使用的点大小。
setFontSizes(sizes)	Range	设置字体大小的矩形网格（必须与此范围的尺寸一致）。
setFontStyle(fontStyle)	Range	为指定范围设置字体样式（'italic' 或 'normal'）。
setFontStyles(fontStyles)	Range	设置字体样式的矩形网格（必须与此范围的尺寸一致）。
setFontWeight(fontWeight)	Range	为指定范围设置字体粗细（正常/粗体）。
setFontWeights(fontWeights)	Range	设置字体粗细的矩形网格（必须与此范围的尺寸一致）。
setFormula(formula)	Range	更新此范围的公式。
setFormulaR1C1(formula)	Range	更新此范围的公式。
setFormulas(formulas)	Range	设置矩形公式网格（必须与此范围的尺寸一致）。
setFormulasR1C1(formulas)	Range	设置矩形公式网格（必须与此范围的尺寸一致）。
setHorizontalAlignment(alignment)	Range	为指定范围设置水平（从左到右）对齐方式（左/居中/右）。
setHorizontalAlignments(alignments)	Range	设置水平对齐的矩形网格。
setNote(note)	Range	将备注设置为给定值。
setNotes(notes)	Range	设置矩形的记事网格（必须与此范围的尺寸一致）。
setNumberFormat(numberFormat)	Range	将数字或日期格式设置为指定的格式字符串。
setNumberFormats(numberFormats)	Range	设置采用数字或日期格式的矩形网格（必须与此范围的尺寸一致）。
setRichTextValue(value)	Range	为范围内的单元格设置富文本值。
setRichTextValues(values)	Range	设置一个由富文本值组成的矩形网格。
setShowHyperlink(showHyperlink)	Range	设置范围是否应显示超链接。
setTextDirection(direction)	Range	为范围内的单元格设置文本方向。
setTextDirections(directions)	Range	设置文本方向的矩形网格。
setTextRotation(degrees)	Range	为范围内的单元格设置文本旋转设置。
setTextRotation(rotation)	Range	为范围内的单元格设置文本旋转设置。
setTextRotations(rotations)	Range	设置文本旋转的矩形网格。
setTextStyle(style)	Range	为范围内的单元格设置文本样式。
setTextStyles(styles)	Range	设置文本样式的矩形网格。
setValue(value)	Range	设置范围的值。
setValues(values)	Range	设置值的矩形网格（必须与此范围的维度一致）。
setVerticalAlignment(alignment)	Range	为给定范围（顶部/中间/底部）设置垂直（从上到下）对齐方式。
setVerticalAlignments(alignments)	Range	设置垂直对齐的矩形网格（必须与此范围的尺寸一致）。
setVerticalText(isVertical)	Range	设置是否为范围内的单元格堆叠文本。
setWrap(isWrapEnabled)	Range	设置指定范围的单元格换行。
setWrapStrategies(strategies)	Range	设置一个由换行策略组成的矩形网格。
setWrapStrategy(strategy)	Range	为范围内的单元格设置文本换行策略。
setWraps(isWrapEnabled)	Range	设置一个由换行政策组成的矩形网格（必须与此范围的尺寸一致）。
shiftColumnGroupDepth(delta)	Range	按指定的量更改范围的列分组深度。
shiftRowGroupDepth(delta)	Range	按指定的量更改范围的行分组深度。
sort(sortSpecObj)	Range	按指定的列和顺序对给定范围中的单元格进行排序。
splitTextToColumns()	void	根据自动检测到的分隔符，将一列文本拆分为多列。
splitTextToColumns(delimiter)	void	使用指定字符串作为自定义分隔符，将一列文本拆分为多列。
splitTextToColumns(delimiter)	void	根据指定的分隔符将一列文本拆分为多列。
trimWhitespace()	Range	剪除此范围中每个单元格中的空白（例如空格、制表符或换行符）。
uncheck()	Range	将范围内的复选框的状态更改为“未选中”。

RangeList

方法

方法	返回类型	简介
activate()	RangeList	选择 Range 实例列表。
breakApart()	RangeList	将范围列表中包含的所有水平或垂直合并的单元格再次拆分为单个单元格。
check()	RangeList	将范围内的复选框的状态更改为“已选中”。
clear()	RangeList	清除范围列表中每个 Range 的内容范围、格式和数据验证规则。
clear(options)	RangeList	清除内容范围、格式、数据验证规则和注释（如使用给定选项指定）。
clearContent()	RangeList	清除范围列表中每个 Range 的内容，但保留格式设置。
clearDataValidations()	RangeList	清除范围列表中每个 Range 的数据验证规则。
clearFormat()	RangeList	清除范围列表中每个 Range 的文本格式。
clearNote()	RangeList	清除范围列表中每个 Range 的备注。
getRanges()	Range[]	返回同一工作表中一个或多个 Range 实例的列表。
insertCheckboxes()	RangeList	将复选框插入到范围中的每个单元格中，并将其配置为勾选时为 true，未勾选时为 false。
insertCheckboxes(checkedValue)	RangeList	在范围内的每个单元格中插入复选框，并为勾选状态配置自定义值，为未勾选状态配置空字符串。
insertCheckboxes(checkedValue, uncheckedValue)	RangeList	在范围内的每个单元格中插入复选框，并为勾选和未勾选状态配置自定义值。
removeCheckboxes()	RangeList	从范围中移除所有复选框。
setBackground(color)	RangeList	设置范围列表中每个 Range 的背景颜色。
setBackgroundRGB(red, green, blue)	RangeList	将背景设置为给定的 RGB 颜色。
setBorder(top, left, bottom, right, vertical, horizontal)	RangeList	为范围列表中的每个 Range 设置边框属性。
setBorder(top, left, bottom, right, vertical, horizontal, color, style)	RangeList	为范围列表中的每个 Range 设置边框属性（颜色和/或样式）。
setFontColor(color)	RangeList	设置范围列表中每个 Range 的字体颜色。
setFontFamily(fontFamily)	RangeList	为范围列表中的每个 Range 设置字体系列。
setFontLine(fontLine)	RangeList	为范围列表中的每个 Range 设置字体线条样式。
setFontSize(size)	RangeList	设置范围列表中每个 Range 的字体大小（以点为单位）。
setFontStyle(fontStyle)	RangeList	为范围列表中的每个 Range 设置字体样式。
setFontWeight(fontWeight)	RangeList	为范围列表中的每个 Range 设置字体粗细。
setFormula(formula)	RangeList	更新范围列表中每个 Range 的公式。
setFormulaR1C1(formula)	RangeList	更新范围列表中每个 Range 的公式。
setHorizontalAlignment(alignment)	RangeList	为范围列表中的每个 Range 设置水平对齐方式。
setNote(note)	RangeList	为范围列表中的每个 Range 设置备注文本。
setNumberFormat(numberFormat)	RangeList	为范围列表中的每个 Range 设置数字或日期格式。
setShowHyperlink(showHyperlink)	RangeList	设置范围列表中的每个 Range 是否应显示超链接。
setTextDirection(direction)	RangeList	设置范围列表中每个 Range 中的单元格的文本方向。
setTextRotation(degrees)	RangeList	为范围列表中每个 Range 中的单元格设置文本旋转设置。
setValue(value)	RangeList	为范围列表中的每个 Range 设置值。
setVerticalAlignment(alignment)	RangeList	为范围列表中的每个 Range 设置垂直对齐方式。
setVerticalText(isVertical)	RangeList	设置是否堆叠范围列表中每个 Range 的单元格的文本。
setWrap(isWrapEnabled)	RangeList	为范围列表中的每个 Range 设置文本换行。
setWrapStrategy(strategy)	RangeList	为范围列表中的每个 Range 设置文本换行策略。
trimWhitespace()	RangeList	剪除此范围列表中每个单元格中的空白（例如空格、制表符或换行符）。
uncheck()	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

方法

方法	返回类型	简介
activate()	Sheet	激活此工作表。
addDeveloperMetadata(key)	Sheet	向工作表添加具有指定键的开发者元数据。
addDeveloperMetadata(key, visibility)	Sheet	向工作表添加具有指定键和可见性的开发者元数据。
addDeveloperMetadata(key, value)	Sheet	将具有指定键和值的开发者元数据添加到工作表中。
addDeveloperMetadata(key, value, visibility)	Sheet	向工作表添加具有指定键、值和公开范围的开发者元数据。
appendRow(rowContents)	Sheet	将一行附加到工作表中当前数据区域的底部。
asDataSourceSheet()	DataSourceSheet	如果工作表的类型为 SheetType.DATASOURCE，则以 DataSourceSheet 的形式返回工作表；否则，返回 null。
autoResizeColumn(columnPosition)	Sheet	将给定列的宽度设置为适合其内容。
autoResizeColumns(startColumn, numColumns)	Sheet	设置从给定列位置开始的所有列的宽度，以适应其内容。
autoResizeRows(startRow, numRows)	Sheet	设置从给定行位置开始的所有行的高度，以适应其内容。
clear()	Sheet	清除工作表中的内容和格式信息。
clear(options)	Sheet	清除表格的内容和/或格式（如通过给定高级选项指定）。
clearConditionalFormatRules()	void	从工作表中移除所有条件格式规则。
clearContents()	Sheet	清除目录工作表，同时保留格式信息。
clearFormats()	Sheet	清除工作表格式，同时保留内容。
clearNotes()	Sheet	清除工作表中的所有备注。
collapseAllColumnGroups()	Sheet	收起工作表中的所有列组。
collapseAllRowGroups()	Sheet	收起工作表上的所有行组。
copyTo(spreadsheet)	Sheet	将工作表复制到给定电子表格（可以与来源相同）。
createDeveloperMetadataFinder()	DeveloperMetadataFinder	返回 DeveloperMetadataFinder，用于在此工作表范围内查找开发者元数据。
createTextFinder(findText)	TextFinder	为工作表创建文本查找器，该查找器可查找和替换工作表中的文本。
deleteColumn(columnPosition)	Sheet	删除指定列位置的列。
deleteColumns(columnPosition, howMany)	void	从指定列位置开始删除多列。
deleteRow(rowPosition)	Sheet	删除指定行位置的行。
deleteRows(rowPosition, howMany)	void	从指定行位置开始删除多行。
expandAllColumnGroups()	Sheet	展开工作表中的所有列组。
expandAllRowGroups()	Sheet	展开工作表中的所有行组。
expandColumnGroupsUpToDepth(groupDepth)	Sheet	展开深度不超过给定深度的所有列组，并收起所有其他列组。
expandRowGroupsUpToDepth(groupDepth)	Sheet	展开深度不超过给定深度的所有行组，并收起所有其他行组。
getActiveCell()	Range	返回此工作表中的活动单元格。
getActiveRange()	Range	返回活动工作表中的选定范围，如果没有活动范围，则返回 null。
getActiveRangeList()	RangeList	返回活动工作表中的有效范围列表，如果没有有效范围，则返回 null。
getBandings()	Banding[]	返回此工作表中的所有条带。
getCharts()	EmbeddedChart[]	返回此工作表中的图表数组。
getColumnGroup(columnIndex, groupDepth)	Group	返回指定索引和组深度的列组。
getColumnGroupControlPosition()	GroupControlTogglePosition	返回工作表中所有列组的 GroupControlTogglePosition。
getColumnGroupDepth(columnIndex)	Integer	返回指定索引处列的组深度。
getColumnWidth(columnPosition)	Integer	获取给定列的宽度（以像素为单位）。
getConditionalFormatRules()	ConditionalFormatRule[]	获取此工作表中的所有条件格式规则。
getCurrentCell()	Range	返回活动工作表中的当前单元格；如果没有当前单元格，则返回 null。
getDataRange()	Range	返回与数据所在的维度对应的 Range。
getDataSourceFormulas()	DataSourceFormula[]	获取所有数据源公式。
getDataSourcePivotTables()	DataSourcePivotTable[]	获取所有数据源数据透视表。
getDataSourceTables()	DataSourceTable[]	获取所有数据源表。
getDeveloperMetadata()	DeveloperMetadata[]	获取与此工作表关联的所有开发者元数据。
getDrawings()	Drawing[]	返回工作表上的绘图数组。
getFilter()	Filter	返回此工作表中的过滤条件；如果没有过滤条件，则返回 null。
getFormUrl()	String	返回将其回复发送到此工作表的表单的网址；如果此工作表没有关联的表单，则返回 null。
getFrozenColumns()	Integer	返回冻结列的数量。
getFrozenRows()	Integer	返回冻结的行数。
getImages()	OverGridImage[]	返回工作表中的所有网格外图片。
getIndex()	Integer	获取工作表在其父级电子表格中的位置。
getLastColumn()	Integer	返回包含内容的最后一列的位置。
getLastRow()	Integer	返回包含内容的最后一行的索引。
getMaxColumns()	Integer	返回工作表中的当前列数（不考虑内容）。
getMaxRows()	Integer	返回工作表中的当前行数（不考虑内容）。
getName()	String	返回工作表的名称。
getNamedRanges()	NamedRange[]	获取此工作表中的所有命名范围。
getParent()	Spreadsheet	返回包含此工作表的 Spreadsheet。
getPivotTables()	PivotTable[]	返回此工作表中的所有数据透视表。
getProtections(type)	Protection[]	获取一个对象数组，表示工作表中的所有受保护范围，或一个表示工作表本身保护状态的单元素数组。
getRange(row, column)	Range	返回左上角单元格位于给定坐标的范围。
getRange(row, column, numRows)	Range	返回左上角单元格位于给定坐标且行数为给定值的范围。
getRange(row, column, numRows, numColumns)	Range	返回左上角单元格位于给定坐标且行数和列数为给定值的范围。
getRange(a1Notation)	Range	返回 A1 表示法或 R1C1 表示法中指定的范围。
getRangeList(a1Notations)	RangeList	返回一个 RangeList 集合，表示由 A1 表示法或 R1C1 表示法组成的非空列表指定的同一工作表中的范围。
getRowGroup(rowIndex, groupDepth)	Group	返回指定索引和分组深度处的行组。
getRowGroupControlPosition()	GroupControlTogglePosition	返回工作表中所有行组的 GroupControlTogglePosition。
getRowGroupDepth(rowIndex)	Integer	返回指定索引处的行组深度。
getRowHeight(rowPosition)	Integer	获取给定行的高度（以像素为单位）。
getSelection()	Selection	返回电子表格中的当前 Selection。
getSheetId()	Integer	返回此对象所代表的工作表的 ID。
getSheetName()	String	返回工作表名称。
getSheetValues(startRow, startColumn, numRows, numColumns)	Object[][]	返回从给定坐标开始的此范围的值矩形网格。
getSlicers()	Slicer[]	返回工作表上的切片器数组。
getTabColorObject()	Color	获取工作表标签页的颜色；如果工作表标签页没有颜色，则返回 null。
getType()	SheetType	返回工作表的类型。
hasHiddenGridlines()	Boolean	如果工作表的网格线处于隐藏状态，则返回 true；否则返回 false。
hideColumn(column)	void	隐藏指定范围中的列。
hideColumns(columnIndex)	void	隐藏给定索引处的单个列。
hideColumns(columnIndex, numColumns)	void	隐藏从给定索引开始的连续一列或多列。
hideRow(row)	void	隐藏给定范围中的行。
hideRows(rowIndex)	void	隐藏指定索引处的行。
hideRows(rowIndex, numRows)	void	隐藏从给定索引开始的一条或多条连续行。
hideSheet()	Sheet	隐藏此工作表。
insertChart(chart)	void	向此工作表添加新图表。
insertColumnAfter(afterPosition)	Sheet	在指定列位置后插入一列。
insertColumnBefore(beforePosition)	Sheet	在指定列位置之前插入一列。
insertColumns(columnIndex)	void	在工作表的指定位置插入空白列。
insertColumns(columnIndex, numColumns)	void	在工作表中从指定位置开始插入一个或多个连续的空白列。
insertColumnsAfter(afterPosition, howMany)	Sheet	在指定列位置后插入指定数量的列。
insertColumnsBefore(beforePosition, howMany)	Sheet	在指定列位置之前插入多列。
insertImage(blobSource, column, row)	OverGridImage	将 BlobSource 作为图片插入文档中的指定行和列。
insertImage(blobSource, column, row, offsetX, offsetY)	OverGridImage	将 BlobSource 作为图片插入文档中的给定行和列，并带有像素偏移。
insertImage(url, column, row)	OverGridImage	在文档中指定行和列插入图片。
insertImage(url, column, row, offsetX, offsetY)	OverGridImage	在文档中指定行和列（并带有像素偏移量）插入图片。
insertRowAfter(afterPosition)	Sheet	在指定的行位置后插入一行。
insertRowBefore(beforePosition)	Sheet	在指定的行位置之前插入一行。
insertRows(rowIndex)	void	在工作表的指定位置插入空白行。
insertRows(rowIndex, numRows)	void	在工作表中从指定位置开始插入一个或多个连续的空白行。
insertRowsAfter(afterPosition, howMany)	Sheet	在指定的行位置后插入多行。
insertRowsBefore(beforePosition, howMany)	Sheet	在指定的行位置之前插入多行。
insertSlicer(range, anchorRowPos, anchorColPos)	Slicer	向此工作表添加新的切片器。
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)	Slicer	向此工作表添加新的切片器。
isColumnHiddenByUser(columnPosition)	Boolean	返回指定列是否已被用户隐藏。
isRightToLeft()	Boolean	如果此工作表布局为从右到左，则返回 true。
isRowHiddenByFilter(rowPosition)	Boolean	返回给定行是否被过滤器（而非过滤器视图）隐藏。
isRowHiddenByUser(rowPosition)	Boolean	返回指定行是否已被用户隐藏。
isSheetHidden()	Boolean	如果工作表当前处于隐藏状态，则返回 true。
moveColumns(columnSpec, destinationIndex)	void	将通过给定范围选择的列移至 destinationIndex 指示的位置。
moveRows(rowSpec, destinationIndex)	void	将通过给定范围选择的行移至 destinationIndex 指示的位置。
newChart()	EmbeddedChartBuilder	返回一个构建器，用于为此工作表创建新图表。
protect()	Protection	创建一个对象，可保护工作表免遭修改，除非用户拥有相应权限。
removeChart(chart)	void	从父工作表中移除图表。
setActiveRange(range)	Range	将指定范围设置为活动工作表中的 active range，并将该范围的左上角单元格设置为 current cell。
setActiveRangeList(rangeList)	RangeList	将指定的范围列表设置为活动工作表中的 active ranges。
setActiveSelection(range)	Range	设置此工作表的有效选择区域。
setActiveSelection(a1Notation)	Range	设置 A1 或 R1C1 表示法中指定的有效选择。
setColumnGroupControlPosition(position)	Sheet	设置列组控件切换开关在工作表中的位置。
setColumnWidth(columnPosition, width)	Sheet	设置给定列的宽度（以像素为单位）。
setColumnWidths(startColumn, numColumns, width)	Sheet	设置给定列的宽度（以像素为单位）。
setConditionalFormatRules(rules)	void	将工作表中当前存在的所有条件格式规则替换为输入规则。
setCurrentCell(cell)	Range	将指定单元格设置为 current cell。
setFrozenColumns(columns)	void	冻结指定数量的列。
setFrozenRows(rows)	void	冻结指定的行数。
setHiddenGridlines(hideGridlines)	Sheet	隐藏或显示工作表网格线。
setName(name)	Sheet	设置工作表名称。
setRightToLeft(rightToLeft)	Sheet	将工作表布局设置为从右到左或取消设置。
setRowGroupControlPosition(position)	Sheet	设置行组控件切换开关在工作表中的位置。
setRowHeight(rowPosition, height)	Sheet	以像素为单位设置给定行的行高。
setRowHeights(startRow, numRows, height)	Sheet	以像素为单位设置指定行的高度。
setRowHeightsForced(startRow, numRows, height)	Sheet	以像素为单位设置指定行的高度。
setTabColor(color)	Sheet	设置工作表标签页颜色。
setTabColorObject(color)	Sheet	设置工作表标签页颜色。
showColumns(columnIndex)	void	取消隐藏指定索引处的列。
showColumns(columnIndex, numColumns)	void	取消隐藏从给定编号开始的连续一列或多列。
showRows(rowIndex)	void	取消隐藏指定索引处的行。
showRows(rowIndex, numRows)	void	取消隐藏从给定索引开始的一个或多个连续行。
showSheet()	Sheet	使工作表可见。
sort(columnPosition)	Sheet	按列（升序）对工作表进行排序。
sort(columnPosition, ascending)	Sheet	按列对工作表进行排序。
unhideColumn(column)	void	取消隐藏给定范围内的列。
unhideRow(row)	void	取消隐藏给定范围中的行。
updateChart(chart)	void	更新此工作表中的图表。

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	设置 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

方法

方法	返回类型	简介
addDeveloperMetadata(key)	Spreadsheet	将具有指定键的开发者元数据添加到顶级电子表格中。
addDeveloperMetadata(key, visibility)	Spreadsheet	将具有指定键和可见性的开发者元数据添加到电子表格中。
addDeveloperMetadata(key, value)	Spreadsheet	将具有指定键和值的开发者元数据添加到电子表格中。
addDeveloperMetadata(key, value, visibility)	Spreadsheet	将具有指定键、值和公开范围的开发者元数据添加到电子表格中。
addEditor(emailAddress)	Spreadsheet	将指定用户添加到 Spreadsheet 的编辑者列表中。
addEditor(user)	Spreadsheet	将指定用户添加到 Spreadsheet 的编辑者列表中。
addEditors(emailAddresses)	Spreadsheet	将指定的用户数组添加到 Spreadsheet 的编辑者列表中。
addMenu(name, subMenus)	void	在电子表格界面中创建新菜单。
addViewer(emailAddress)	Spreadsheet	将指定用户添加到 Spreadsheet 的观看者列表中。
addViewer(user)	Spreadsheet	将指定用户添加到 Spreadsheet 的观看者列表中。
addViewers(emailAddresses)	Spreadsheet	将给定用户数组添加到 Spreadsheet 的观看者列表中。
appendRow(rowContents)	Sheet	将一行附加到工作表中当前数据区域的底部。
autoResizeColumn(columnPosition)	Sheet	将给定列的宽度设置为适合其内容。
copy(name)	Spreadsheet	复制电子表格并返回新电子表格。
createDeveloperMetadataFinder()	DeveloperMetadataFinder	返回 DeveloperMetadataFinder，用于在此电子表格的范围内查找开发者元数据。
createTextFinder(findText)	TextFinder	为电子表格创建文本查找器，用于查找和替换电子表格中的文本。
deleteActiveSheet()	Sheet	删除当前处于活动状态的工作表。
deleteColumn(columnPosition)	Sheet	删除指定列位置的列。
deleteColumns(columnPosition, howMany)	void	从指定列位置开始删除多列。
deleteRow(rowPosition)	Sheet	删除指定行位置的行。
deleteRows(rowPosition, howMany)	void	从指定行位置开始删除多行。
deleteSheet(sheet)	void	删除指定的工作表。
duplicateActiveSheet()	Sheet	复制活动工作表并将其设为活动工作表。
getActiveCell()	Range	返回此工作表中的活动单元格。
getActiveRange()	Range	返回活动工作表中的选定范围，如果没有活动范围，则返回 null。
getActiveRangeList()	RangeList	返回活动工作表中的有效范围列表，如果没有有效范围，则返回 null。
getActiveSheet()	Sheet	获取电子表格中的活动工作表。
getAs(contentType)	Blob	将此对象内的数据作为转换为指定内容类型的 blob 返回。
getBandings()	Banding[]	返回此电子表格中的所有分组。
getBlob()	Blob	以 blob 的形式返回此对象内的数据。
getColumnWidth(columnPosition)	Integer	获取给定列的宽度（以像素为单位）。
getCurrentCell()	Range	返回活动工作表中的当前单元格；如果没有当前单元格，则返回 null。
getDataRange()	Range	返回与数据所在的维度对应的 Range。
getDataSourceFormulas()	DataSourceFormula[]	获取所有数据源公式。
getDataSourcePivotTables()	DataSourcePivotTable[]	获取所有数据源数据透视表。
getDataSourceRefreshSchedules()	DataSourceRefreshSchedule[]	获取此电子表格的刷新时间表。
getDataSourceSheets()	DataSourceSheet[]	返回电子表格中的所有数据源工作表。
getDataSourceTables()	DataSourceTable[]	获取所有数据源表。
getDataSources()	DataSource[]	返回电子表格中的所有数据源。
getDeveloperMetadata()	DeveloperMetadata[]	获取与顶级电子表格关联的开发者元数据。
getEditors()	User[]	获取此 Spreadsheet 的编辑器列表。
getFormUrl()	String	返回将回复发送到此电子表格的表单的网址；如果此电子表格没有关联的表单，则返回 null。
getFrozenColumns()	Integer	返回冻结列的数量。
getFrozenRows()	Integer	返回冻结的行数。
getId()	String	获取此电子表格的唯一标识符。
getImages()	OverGridImage[]	返回工作表中的所有网格外图片。
getIterativeCalculationConvergenceThreshold()	Number	返回迭代计算期间使用的阈值。
getLastColumn()	Integer	返回包含内容的最后一列的位置。
getLastRow()	Integer	返回包含内容的最后一行的索引。
getMaxIterativeCalculationCycles()	Integer	返回迭代计算期间要使用的迭代次数上限。
getName()	String	获取文档的名称。
getNamedRanges()	NamedRange[]	获取此电子表格中的所有命名范围。
getNumSheets()	Integer	返回此电子表格中的工作表数量。
getOwner()	User	返回文档的所有者，对于共享云端硬盘中的文档，则返回 null。
getPredefinedSpreadsheetThemes()	SpreadsheetTheme[]	返回预定义主题的列表。
getProtections(type)	Protection[]	获取一个对象数组，表示电子表格中的所有受保护的范围或工作表。
getRange(a1Notation)	Range	返回 A1 表示法或 R1C1 表示法中指定的范围。
getRangeByName(name)	Range	返回命名范围，如果未找到具有给定名称的范围，则返回 null。
getRangeList(a1Notations)	RangeList	返回一个 RangeList 集合，表示由 A1 表示法或 R1C1 表示法组成的非空列表指定的同一工作表中的范围。
getRecalculationInterval()	RecalculationInterval	返回此电子表格的计算间隔。
getRowHeight(rowPosition)	Integer	获取给定行的高度（以像素为单位）。
getSelection()	Selection	返回电子表格中的当前 Selection。
getSheetByName(name)	Sheet	返回具有给定名称的工作表。
getSheetId()	Integer	返回此对象所代表的工作表的 ID。
getSheetName()	String	返回工作表名称。
getSheetValues(startRow, startColumn, numRows, numColumns)	Object[][]	返回从给定坐标开始的此范围的值矩形网格。
getSheets()	Sheet[]	获取此电子表格中的所有工作表。
getSpreadsheetLocale()	String	获取电子表格的语言区域。
getSpreadsheetTheme()	SpreadsheetTheme	返回电子表格的当前主题；如果未应用任何主题，则返回 null。
getSpreadsheetTimeZone()	String	获取电子表格的时区。
getUrl()	String	返回给定电子表格的网址。
getViewers()	User[]	获取此 Spreadsheet 的查看者和评论者的列表。
hideColumn(column)	void	隐藏指定范围中的列。
hideRow(row)	void	隐藏给定范围中的行。
insertColumnAfter(afterPosition)	Sheet	在指定列位置后插入一列。
insertColumnBefore(beforePosition)	Sheet	在指定列位置之前插入一列。
insertColumnsAfter(afterPosition, howMany)	Sheet	在指定列位置后插入指定数量的列。
insertColumnsBefore(beforePosition, howMany)	Sheet	在指定列位置之前插入多列。
insertDataSourceSheet(spec)	DataSourceSheet	在电子表格中插入新的 DataSourceSheet 并开始数据执行。
insertImage(blobSource, column, row)	OverGridImage	将 Spreadsheet 作为图片插入文档中的指定行和列。
insertImage(blobSource, column, row, offsetX, offsetY)	OverGridImage	将 Spreadsheet 作为图片插入文档中的给定行和列，并带有像素偏移。
insertImage(url, column, row)	OverGridImage	在文档中指定行和列插入图片。
insertImage(url, column, row, offsetX, offsetY)	OverGridImage	在文档中指定行和列（并带有像素偏移量）插入图片。
insertRowAfter(afterPosition)	Sheet	在指定的行位置后插入一行。
insertRowBefore(beforePosition)	Sheet	在指定的行位置之前插入一行。
insertRowsAfter(afterPosition, howMany)	Sheet	在指定的行位置后插入多行。
insertRowsBefore(beforePosition, howMany)	Sheet	在指定的行位置之前插入多行。
insertSheet()	Sheet	使用默认工作表名称将新工作表插入电子表格中。
insertSheet(sheetIndex)	Sheet	在给定索引处将新工作表插入到电子表格中。
insertSheet(sheetIndex, options)	Sheet	在给定索引处将新工作表插入到电子表格中，并使用可选的高级参数。
insertSheet(options)	Sheet	使用默认工作表名称和可选的高级参数将新工作表插入到电子表格中。
insertSheet(sheetName)	Sheet	在电子表格中插入一个指定名称的新工作表。
insertSheet(sheetName, sheetIndex)	Sheet	在给定索引处向电子表格中插入一个具有给定名称的新工作表。
insertSheet(sheetName, sheetIndex, options)	Sheet	在给定编号处向电子表格中插入一个具有给定名称的新工作表，并使用可选的高级参数。
insertSheet(sheetName, options)	Sheet	向电子表格中插入一个指定名称的新工作表，并使用可选的高级参数。
insertSheetWithDataSourceTable(spec)	Sheet	在电子表格中插入新工作表，使用给定的数据源规范创建跨整个工作表的 DataSourceTable，并开始执行数据。
isColumnHiddenByUser(columnPosition)	Boolean	返回指定列是否已被用户隐藏。
isIterativeCalculationEnabled()	Boolean	返回此电子表格中是否启用了迭代计算。
isRowHiddenByFilter(rowPosition)	Boolean	返回给定行是否被过滤器（而非过滤器视图）隐藏。
isRowHiddenByUser(rowPosition)	Boolean	返回指定行是否已被用户隐藏。
moveActiveSheet(pos)	void	将活动工作表移至工作表列表中的指定位置。
moveChartToObjectSheet(chart)	Sheet	创建新的 SheetType.OBJECT 工作表，并将所提供的图表移至其中。
refreshAllDataSources()	void	刷新所有受支持的数据源及其关联的数据源对象，并跳过无效的数据源对象。
removeEditor(emailAddress)	Spreadsheet	从 Spreadsheet 的编辑者列表中移除指定用户。
removeEditor(user)	Spreadsheet	从 Spreadsheet 的编辑者列表中移除指定用户。
removeMenu(name)	void	移除由 addMenu(name, subMenus) 添加的菜单。
removeNamedRange(name)	void	删除具有给定名称的命名范围。
removeViewer(emailAddress)	Spreadsheet	从 Spreadsheet 的观看者和评论者列表中移除指定用户。
removeViewer(user)	Spreadsheet	从 Spreadsheet 的观看者和评论者列表中移除指定用户。
rename(newName)	void	重命名文档。
renameActiveSheet(newName)	void	将当前活动的工作表重命名为给定的新名称。
resetSpreadsheetTheme()	SpreadsheetTheme	移除已应用的主题，并在电子表格中设置默认主题。
setActiveRange(range)	Range	将指定范围设置为活动工作表中的 active range，并将该范围的左上角单元格设置为 current cell。
setActiveRangeList(rangeList)	RangeList	将指定的范围列表设置为活动工作表中的 active ranges。
setActiveSelection(range)	Range	设置此工作表的有效选择区域。
setActiveSelection(a1Notation)	Range	设置 A1 或 R1C1 表示法中指定的有效选择。
setActiveSheet(sheet)	Sheet	将指定的工作表设置为电子表格中的活动工作表。
setActiveSheet(sheet, restoreSelection)	Sheet	将指定的工作表设置为电子表格中的活动工作表，并提供用于恢复该工作表中最近一次所选内容的选项。
setColumnWidth(columnPosition, width)	Sheet	设置给定列的宽度（以像素为单位）。
setCurrentCell(cell)	Range	将指定单元格设置为 current cell。
setFrozenColumns(columns)	void	冻结指定数量的列。
setFrozenRows(rows)	void	冻结指定的行数。
setIterativeCalculationConvergenceThreshold(minThreshold)	Spreadsheet	设置迭代计算的最低阈值。
setIterativeCalculationEnabled(isEnabled)	Spreadsheet	设置此电子表格中是否启用了迭代计算。
setMaxIterativeCalculationCycles(maxIterations)	Spreadsheet	设置在迭代计算期间应执行的计算迭代次数上限。
setNamedRange(name, range)	void	为范围命名。
setRecalculationInterval(recalculationInterval)	Spreadsheet	设置此电子表格应重新计算的频率。
setRowHeight(rowPosition, height)	Sheet	以像素为单位设置给定行的行高。
setSpreadsheetLocale(locale)	void	设置电子表格的语言区域。
setSpreadsheetTheme(theme)	SpreadsheetTheme	在电子表格中设置主题。
setSpreadsheetTimeZone(timezone)	void	设置电子表格的时区。
show(userInterface)	void	在用户浏览器的视口中居中显示自定义界面组件。
sort(columnPosition)	Sheet	按列（升序）对工作表进行排序。
sort(columnPosition, ascending)	Sheet	按列对工作表进行排序。
toast(msg)	void	在电子表格的右下角显示一个弹出式窗口，其中包含给定消息。
toast(msg, title)	void	在电子表格的右下角显示一个弹出式窗口，其中包含指定的消息和标题。
toast(msg, title, timeoutSeconds)	void	在电子表格的右下角显示一个弹出式窗口，其中包含指定的标题和消息，该窗口会在一定时间内保持可见状态。
unhideColumn(column)	void	取消隐藏给定范围内的列。
unhideRow(row)	void	取消隐藏给定范围中的行。
updateMenu(name, subMenus)	void	更新由 addMenu(name, subMenus) 添加的菜单。
waitForAllDataExecutionsCompletion(timeoutInSeconds)	void	等待电子表格中的所有当前执行作业完成，并在提供的秒数后超时。

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	用于换行单元格的策略的枚举。

方法

方法	返回类型	简介
create(name)	Spreadsheet	创建一个具有给定名称的新电子表格。
create(name, rows, columns)	Spreadsheet	创建一个具有指定名称和指定行数和列数的新电子表格。
enableAllDataSourcesExecution()	void	为所有类型的数据源启用数据执行。
enableBigQueryExecution()	void	为 BigQuery 数据源启用数据执行。
enableLookerExecution()	void	为 Looker 数据源启用数据执行。
flush()	void	应用所有待处理的电子表格更改。
getActive()	Spreadsheet	返回当前活跃的电子表格；如果没有，则返回 null。
getActiveRange()	Range	返回活动工作表中的选定范围，如果没有活动范围，则返回 null。
getActiveRangeList()	RangeList	返回活动工作表中的有效范围列表，如果未选择任何范围，则返回 null。
getActiveSheet()	Sheet	获取电子表格中的活动工作表。
getActiveSpreadsheet()	Spreadsheet	返回当前活跃的电子表格；如果没有，则返回 null。
getCurrentCell()	Range	返回活动表格中某个活动范围中选定的当前（突出显示的）单元格；如果没有当前单元格，则返回 null。
getSelection()	Selection	返回电子表格中的当前 Selection。
getUi()	Ui	返回电子表格的界面环境实例，让脚本可以添加菜单、对话框和边栏等功能。
newCellImage()	CellImageBuilder	为 CellImage 创建构建器。
newColor()	ColorBuilder	为 Color 创建构建器。
newConditionalFormatRule()	ConditionalFormatRuleBuilder	为条件格式规则创建构建器。
newDataSourceSpec()	DataSourceSpecBuilder	为 DataSourceSpec 创建构建器。
newDataValidation()	DataValidationBuilder	为数据验证规则创建构建器。
newFilterCriteria()	FilterCriteriaBuilder	为 FilterCriteria 创建构建器。
newRichTextValue()	RichTextValueBuilder	为富文本值创建构建器。
newTextStyle()	TextStyleBuilder	为文本样式创建构建器。
open(file)	Spreadsheet	打开与给定 File 对象对应的电子表格。
openById(id)	Spreadsheet	打开具有指定 ID 的电子表格。
openByUrl(url)	Spreadsheet	使用给定网址打开电子表格。
setActiveRange(range)	Range	将指定范围设置为 active range，并将范围中的左上角单元格设置为 current cell。
setActiveRangeList(rangeList)	RangeList	将指定的范围列表设置为 active ranges。
setActiveSheet(sheet)	Sheet	设置电子表格中的活动工作表。
setActiveSheet(sheet, restoreSelection)	Sheet	设置电子表格中的活动工作表，并提供用于恢复该工作表中最近所选内容的选项。
setActiveSpreadsheet(newActiveSpreadsheet)	void	设置活动电子表格。
setCurrentCell(cell)	Range	将指定单元格设置为 current cell。

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	剪裁超出单元格宽度的线条。