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 中使用的值的插值选项。
NamedRange	在电子表格中创建、访问和修改命名的范围。
OverGridImage	表示电子表格中网格上的图片。
PageProtection	在旧版 Google 表格中访问和修改受保护的工作表。
PivotFilter	访问和修改数据透视表过滤器。
PivotGroup	访问和修改数据透视表细分组。
PivotGroupLimit	访问和修改数据透视表组限制。
PivotTable	访问和修改数据透视表。
PivotTableSummarizeFunction	用于汇总数据透视表数据的函数枚举。
PivotValue	访问和修改数据透视表中的值组。
PivotValueDisplayType	用于将数据透视值显示为另一个值的函数的枚举。
Protection	访问和修改受保护的范围和工作表。
ProtectionType	表示电子表格中可以防止修改的部分的枚举。
Range	访问和修改电子表格范围。
RangeList	同一工作表中的一个或多个 Range 实例的集合。
RecalculationInterval	表示电子表格重新计算中使用的可能间隔的枚举。
RelativeDate	此枚举表示相对日期选项，用于计算基于日期的 BooleanCriteria 中使用的值。
RichTextValue	用于表示单元格文本的风格化文本字符串。
RichTextValueBuilder	RTF 值的构建器。
Selection	访问当前工作表中的当前所选内容。
Sheet	访问和修改电子表格工作表。
SheetType	电子表格中可包含的不同表格类型。
Slicer	表示截剪器，用于以非协作方式过滤范围、图表和数据透视表。
SortOrder	表示排序顺序的枚举。
SortSpec	排序规范。
Spreadsheet	访问和修改 Google 表格文件。
SpreadsheetApp	访问和创建 Google 表格文件。
SpreadsheetTheme	访问和修改现有主题。
TextDirection	文本路线枚举。
TextFinder	查找或替换范围、工作表或电子表格中的文本。
TextRotation	访问单元格的文本旋转设置。
TextStyle	单元格中文本的呈现样式。
TextStyleBuilder	文本样式的构建器。
TextToColumnsDelimiter	枚举各种预设分隔符类型，可将一列文本拆分为多列。
ThemeColor	主题颜色的表示法。
ThemeColorType	描述主题中支持的各种颜色条目的枚举。
ValueType	由 Range.getValue() 和 Range.getValues() 从电子表格服务的 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	添加参数，如果存在具有名称的参数，则会更新其源单元格。
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	清除条件格式规则的梯度最大值值，改为使用规则范围内的最大值。
setGradientMaxpointObject(color)	ConditionalFormatRuleBuilder	清除条件格式规则的梯度最大值值，改为使用规则范围内的最大值。
setGradientMaxpointObjectWithValue(color, type, value)	ConditionalFormatRuleBuilder	设置条件格式规则的渐变最大值字段。
setGradientMaxpointWithValue(color, type, value)	ConditionalFormatRuleBuilder	设置条件格式规则的渐变最大值字段。
setGradientMidpointObjectWithValue(color, type, value)	ConditionalFormatRuleBuilder	设置条件格式规则的渐变中点字段。
setGradientMidpointWithValue(color, type, value)	ConditionalFormatRuleBuilder	设置条件格式规则的渐变中点字段。
setGradientMinpoint(color)	ConditionalFormatRuleBuilder	清除条件格式规则的梯度最小值值，改为使用规则范围内的最小值。
setGradientMinpointObject(color)	ConditionalFormatRuleBuilder	清除条件格式规则的梯度最小值值，改为使用规则范围内的最小值。
setGradientMinpointObjectWithValue(color, type, value)	ConditionalFormatRuleBuilder	设置条件格式规则的渐变最小值字段。
setGradientMinpointWithValue(color, type, value)	ConditionalFormatRuleBuilder	设置条件格式规则的渐变最小值字段。
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 脚本不支持数据执行错误代码。
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

方法

方法	返回类型	简介
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

方法

方法	返回类型	简介
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

方法

方法	返回类型	简介
forceRefreshData()	DataSourceFormula	刷新此对象的数据，而不考虑当前状态。
getAnchorCell()	Range	返回表示此数据源公式锚定的单元格的 Range。
getDataSource()	DataSource	获取对象关联的数据源。
getDisplayValue()	String	返回数据源公式的显示值。
getFormula()	String	返回此数据源公式的公式。
getStatus()	DataExecutionStatus	获取对象的数据执行状态。
refreshData()	DataSourceFormula	刷新对象的数据。
setFormula(formula)	DataSourceFormula	更新公式。
waitForCompletion(timeoutInSeconds)	DataExecutionStatus	等待当前执行完成，在提供的秒数后超时。

DataSourceParameter

方法

方法	返回类型	简介
getName()	String	获取参数名称。
getSourceCell()	String	获取评估参数所依据的源单元格，如果参数类型不是 DataSourceParameterType.CELL，则获取 null。
getType()	DataSourceParameterType	获取参数类型。

DataSourceParameterType

属性

媒体资源	类型	说明
DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTED	Enum	Apps 脚本中不支持的数据源参数类型。
CELL	Enum	数据源参数是根据单元格来赋值。

DataSourcePivotTable

方法

方法	返回类型	简介
addColumnGroup(columnName)	PivotGroup	根据指定的数据源列添加新的数据透视列组。
addFilter(columnName, filterCriteria)	PivotFilter	根据指定的数据源列和指定的过滤条件添加一个新的过滤器。
addPivotValue(columnName, summarizeFunction)	PivotValue	使用指定的汇总函数，根据指定的数据源列添加新的数据透视值。
addRowGroup(columnName)	PivotGroup	根据指定的数据源列添加新的数据透视行组。
asPivotTable()	PivotTable	将数据源数据透视表对象作为常规数据透视表对象返回。
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	自动调整指定列的宽度。
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 数据源的规范。
copy()	DataSourceSpecBuilder	根据此数据源的设置创建 DataSourceSpecBuilder。
getParameters()	DataSourceParameter[]	获取数据源的参数。
getType()	DataSourceType	获取数据源的类型。

DataSourceSpecBuilder

方法

方法	返回类型	简介
asBigQuery()	BigQueryDataSourceSpecBuilder	获取 BigQuery 数据源的构建器。
build()	DataSourceSpec	根据此构建器中的设置构建数据源规范。
copy()	DataSourceSpecBuilder	根据此数据源的设置创建 DataSourceSpecBuilder。
getParameters()	DataSourceParameter[]	获取数据源的参数。
getType()	DataSourceType	获取数据源的类型。
removeAllParameters()	DataSourceSpecBuilder	移除所有参数。
removeParameter(parameterName)	DataSourceSpecBuilder	移除指定的参数。
setParameterFromCell(parameterName, sourceCell)	DataSourceSpecBuilder	添加参数，如果存在具有名称的参数，则会更新其源单元格。

DataSourceTable

方法

方法	返回类型	简介
addColumns(columnNames)	DataSourceTable	向数据源表格中添加列。
addFilter(columnName, filterCriteria)	DataSourceTable	添加应用于数据源表的过滤条件。
addSortSpec(columnName, ascending)	DataSourceTable	为数据源表中的列添加排序规范。
addSortSpec(columnName, sortOrder)	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 数据源。

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	按季度对日期时间进行分组，例如 Q1（表示 1 月到 3 月）。
YEAR	Enum	按年份对日期时间分组，例如 2008。
YEAR_MONTH	Enum	按年份和月份对日期时间分组，例如 2008-Nov。
YEAR_QUARTER	Enum	按年份和季度对日期时间进行分组，例如 2008 Q4。
YEAR_MONTH_DAY	Enum	按年、月、日对日期时间进行分组，例如 2008-11-22。

DeveloperMetadata

方法

方法	返回类型	简介
getId()	Integer	返回与此开发者元数据关联的唯一 ID。
getKey()	String	返回与此开发者元数据关联的键。
getLocation()	DeveloperMetadataLocation	返回此开发者元数据的位置。
getValue()	String	返回与此开发者元数据关联的值，如果此元数据没有值，则返回 null。
getVisibility()	DeveloperMetadataVisibility	返回此开发者元数据的可见性。
moveToColumn(column)	DeveloperMetadata	将此开发者元数据移至指定列。
moveToRow(row)	DeveloperMetadata	将此开发者元数据移至指定行。
moveToSheet(sheet)	DeveloperMetadata	将此开发者元数据移至指定的工作表。
moveToSpreadsheet()	DeveloperMetadata	将此开发者元数据移至顶层电子表格。
remove()	void	删除此元数据。
setKey(key)	DeveloperMetadata	将此开发者元数据的键设置为指定值。
setValue(value)	DeveloperMetadata	将与此开发者元数据关联的值设置为指定值。
setVisibility(visibility)	DeveloperMetadata	将此开发者元数据的可见性设为指定的可见性。

DeveloperMetadataFinder

方法

方法	返回类型	简介
find()	DeveloperMetadata[]	执行此搜索并返回匹配的元数据。
onIntersectingLocations()	DeveloperMetadataFinder	将搜索配置为考虑与具有元数据的位置相交。
withId(id)	DeveloperMetadataFinder	限制此搜索仅考虑与指定 ID 匹配的元数据。
withKey(key)	DeveloperMetadataFinder	限制此搜索仅考虑与指定键匹配的元数据。
withLocationType(locationType)	DeveloperMetadataFinder	限制此搜索仅考虑与指定位置类型匹配的元数据。
withValue(value)	DeveloperMetadataFinder	限制此搜索仅考虑与指定值匹配的元数据。
withVisibility(visibility)	DeveloperMetadataFinder	限制此搜索仅考虑与指定公开范围匹配的元数据。

DeveloperMetadataLocation

方法

方法	返回类型	简介
getColumn()	Range	返回此元数据的列位置的 Range，如果位置类型不是 DeveloperMetadataLocationType.COLUMN，则返回 null。
getLocationType()	DeveloperMetadataLocationType	获取位置类型。
getRow()	Range	返回此元数据行位置的 Range，如果位置类型不是 DeveloperMetadataLocationType.ROW，则返回 null。
getSheet()	Sheet	返回此元数据的 Sheet 位置，如果位置类型不是 DeveloperMetadataLocationType.SHEET，则返回 null。
getSpreadsheet()	Spreadsheet	返回此元数据的 Spreadsheet 位置，如果位置类型不是 DeveloperMetadataLocationType.SPREADSHEET，则返回 null。

DeveloperMetadataLocationType

属性

媒体资源	类型	说明
SPREADSHEET	Enum	与顶级电子表格关联的开发者元数据的位置类型。
SHEET	Enum	与整个工作表关联的开发者元数据的位置类型。
ROW	Enum	与行关联的开发者元数据的位置类型。
COLUMN	Enum	与列关联的开发者元数据的位置类型。

DeveloperMetadataVisibility

属性

媒体资源	类型	说明
DOCUMENT	Enum	任何有权访问文档的开发者项目都可以访问文档可见的元数据。
PROJECT	Enum	项目可见的元数据仅对创建该元数据的开发者项目可见，并且可供其访问。

Dimension

属性

媒体资源	类型	说明
COLUMNS	Enum	列（行业）维度。
ROWS	Enum	行（水平）维度。

Direction

属性

媒体资源	类型	说明
UP	Enum	行索引递减的方向。
DOWN	Enum	增加行索引的方向。
PREVIOUS	Enum	列索引降序排列。
NEXT	Enum	列索引递增的方向。

Drawing

方法

方法	返回类型	简介
getContainerInfo()	ContainerInfo	获取有关绘图在工作表中位置的信息。
getHeight()	Integer	返回此绘图的实际高度（以像素为单位）。
getOnAction()	String	返回附加到此绘图的宏的名称。
getSheet()	Sheet	返回显示此绘图的工作表。
getWidth()	Integer	返回此绘图的实际宽度（以像素为单位）。
getZIndex()	Number	返回此绘图的 Z-index。
remove()	void	从电子表格中删除此绘图。
setHeight(height)	Drawing	设置此绘图的实际高度（以像素为单位）。
setOnAction(macroName)	Drawing	用于为此绘图分配一个宏函数。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)	Drawing	设置绘图在工作表中的显示位置。
setWidth(width)	Drawing	设置此绘图的实际宽度（以像素为单位）。
setZIndex(zIndex)	Drawing	设置此绘图的 Z-index。

EmbeddedAreaChartBuilder

方法

方法	返回类型	简介
addRange(range)	EmbeddedChartBuilder	向此构建器修改的图表添加一个范围。
asAreaChart()	EmbeddedAreaChartBuilder	将图表类型设置为 AreaChart，并返回一个 EmbeddedAreaChartBuilder。
asBarChart()	EmbeddedBarChartBuilder	将图表类型设置为条形图并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回一个 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart 值，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为直方图类型并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为折线图，并返回 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	将图表类型设置为条形图并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回一个 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart 值，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为直方图类型并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为折线图，并返回 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	将图表类型设置为条形图并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回一个 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart 值，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为直方图类型并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为折线图，并返回 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	将图表类型设置为条形图并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回一个 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart 值，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为直方图类型并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为折线图，并返回 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	将图表类型设置为条形图并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回一个 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart 值，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为直方图类型并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为折线图，并返回 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	将图表类型设置为条形图并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回一个 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart 值，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为直方图类型并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为折线图，并返回 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	将图表类型设置为条形图并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回一个 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart 值，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为直方图类型并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为折线图，并返回 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	将图表类型设置为条形图并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回一个 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart 值，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为直方图类型并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为折线图，并返回 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	将图表类型设置为条形图并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回一个 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart 值，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为直方图类型并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为折线图，并返回 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	将图表类型设置为条形图并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart，并返回一个 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart 值，并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为直方图类型并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为折线图，并返回 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	设置过滤条件，以显示包含指定公式（例如 =B:B<C:C）且求值为 true 的单元格。
whenNumberBetween(start, end)	FilterCriteriaBuilder	设置过滤条件，以显示所含数字介于 2 个或 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	推断梯度条件的最大值作为特定插值点。

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	在数据透视表中根据指定的 formula 和指定的 name 计算得出的新透视值。
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	返回范围内所有�