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	将排序顺序设为升序。