Spreadsheet Service

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。
电子表格

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

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

名称简介
AutoFillSeries用于计算自动填充值的系列类型的枚举。
Banding访问和修改条带,即应用到某个范围的行或列的颜色模式。
BandingTheme带状主题的枚举。
BigQueryDataSourceSpec访问现有的 BigQuery 数据源规范。
BigQueryDataSourceSpecBuilderBigQueryDataSourceSpecBuilder 的构建器。
BooleanCondition访问 ConditionalFormatRules 中的布尔条件。
BooleanCriteria表示可在条件格式或过滤条件中使用的布尔条件的枚举。
BorderStyle可以使用 Range.setBorder(top, left, bottom, right, vertical, horizontal, color, style) 在范围上设置的样式。
CellImage表示要添加到单元格中的图片。
CellImageBuilderCellImage 的构建器。
Color一种颜色的表示形式。
ColorBuilderColorBuilder 的构建器。
ConditionalFormatRule访问条件格式规则。
ConditionalFormatRuleBuilder条件格式规则的构建器。
ContainerInfo访问图表在表格中的位置。
CopyPasteType可能的特殊粘贴类型的枚举。
DataExecutionErrorCode数据执行错误代码的枚举。
DataExecutionState数据执行状态的枚举。
DataExecutionStatus数据执行状态。
DataSource访问和修改现有的数据源。
DataSourceChart访问和修改现有的数据源图表。
DataSourceColumn访问和修改数据源列。
DataSourceFormula访问和修改现有的数据源公式。
DataSourceParameter访问现有的数据源参数。
DataSourceParameterType数据源参数类型的枚举。
DataSourcePivotTable访问和修改现有的数据源数据透视表。
DataSourceRefreshSchedule访问和修改现有的刷新时间表。
DataSourceRefreshScheduleFrequency查看刷新频率,该频率用于指定刷新的频率和时间。
DataSourceRefreshScope用于刷新范围的枚举。
DataSourceSheet访问和修改现有的数据源工作表。
DataSourceSheetFilter访问和修改现有的数据源工作表过滤条件。
DataSourceSpec访问现有数据源规范的常规设置。
DataSourceSpecBuilderDataSourceSpec 的构建器。
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如需向过滤条件添加条件,您必须执行以下操作:
  1. 使用 SpreadsheetApp.newFilterCriteria() 创建条件构建器。
  2. 使用此类中的方法将设置添加到构建器中。
  3. 使用 build() 通过您指定的设置来组合条件。
FrequencyType频率类型的枚举。
GradientCondition访问 ConditionalFormatRuleApis 中的渐变(颜色)条件。
Group访问和修改电子表格组。
GroupControlTogglePosition表示组控件切换开关可能具有的位置的枚举。
InterpolationType枚举用于计算要在 ConditionalFormatRuleGradientCondition 中使用的值的插值选项。
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 类返回的 Range.getValue()Range.getValues() 值类型的枚举。
WrapStrategy用于处理单元格文本换行策略的枚举。

AutoFillSeries

属性

属性类型说明
DEFAULT_SERIESEnum默认此值。
ALTERNATE_SERIESEnum如果使用此设置进行自动填充,会导致扩展范围内的空单元格内出现现有值的副本。

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_GREYEnum浅灰色的带状主题。
CYANEnum青色条纹主题。
GREENEnum绿色的带状主题。
YELLOWEnum一个黄色条纹主题。
ORANGEEnum橙色条带主题。
BLUEEnum一个蓝色条纹主题。
TEALEnum蓝绿色条纹主题。
GREYEnum灰色带状主题。
BROWNEnum棕色条纹主题。
LIGHT_GREENEnum浅绿色条纹主题。
INDIGOEnum靛蓝条纹主题。
PINKEnum粉色条纹主题。

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_EMPTYEnum当单元格为空时,满足这些条件。
CELL_NOT_EMPTYEnum当单元格不为空时满足条件。
DATE_AFTEREnum当日期晚于指定值时,满足这些条件。
DATE_BEFOREEnum当日期早于指定值时,满足条件。
DATE_EQUAL_TOEnum当日期等于指定值时,满足这些条件。
DATE_NOT_EQUAL_TOEnum当日期不等于指定值时,满足这些条件。
DATE_AFTER_RELATIVEEnum当日期晚于相对日期值时,满足条件。
DATE_BEFORE_RELATIVEEnum当日期早于相对日期值时,满足条件。
DATE_EQUAL_TO_RELATIVEEnum当日期等于相对日期值时,则满足这些条件。
NUMBER_BETWEENEnum当数字介于指定值之间时,满足条件。
NUMBER_EQUAL_TOEnum当数字等于指定值时,满足条件。
NUMBER_GREATER_THANEnum当数字大于指定值时,满足条件。
NUMBER_GREATER_THAN_OR_EQUAL_TOEnum大于或等于指定值的数字满足条件。
NUMBER_LESS_THANEnum当数字小于指定值时,满足条件。
NUMBER_LESS_THAN_OR_EQUAL_TOEnum当数字小于或等于指定值时,满足条件。
NUMBER_NOT_BETWEENEnum当数字不在指定值之间时,满足条件。
NUMBER_NOT_EQUAL_TOEnum当数字不等于指定值时,满足条件。
TEXT_CONTAINSEnum当输入中包含指定值时,满足条件。
TEXT_DOES_NOT_CONTAINEnum如果输入不包含给定值,则满足条件。
TEXT_EQUAL_TOEnum当输入等于指定值时满足这些条件。
TEXT_NOT_EQUAL_TOEnum当输入不等于给定值时,满足条件。
TEXT_STARTS_WITHEnum当输入以给定值开头时,满足该条件。
TEXT_ENDS_WITHEnum当输入以给定值结尾时,满足条件。
CUSTOM_FORMULAEnum当输入使给定公式的计算结果为 true 时,满足条件。

BorderStyle

属性

属性类型说明
DOTTEDEnum虚线边框。
DASHEDEnum虚线边框。
SOLIDEnum细实线边框。
SOLID_MEDIUMEnum中等实线边框。
SOLID_THICKEnum粗实线边框。
DOUBLEEnum两个实线边框。

CellImage

属性

属性类型说明
valueTypeValueType设置为 ValueType.IMAGE 的字段,表示图片值类型。

方法

方法返回类型简介
getAltTextDescription()String返回此图片的替代文本说明。
getAltTextTitle()String返回此图片的替代文本标题。
getContentUrl()String返回图片的 Google 托管网址。
getUrl()String获取图片的源网址;如果网址不可用,则返回 null
toBuilder()CellImageBuilder创建用于将图片转换为图片值类型的构建器,以便您将其放入单元格中。

CellImageBuilder

属性

属性类型说明
valueTypeValueType设置为 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 值定义的条件(通常取现有规则的 criteriaarguments)。

ContainerInfo

方法

方法返回类型简介
getAnchorColumn()Integer图表的左侧锚定在该列。
getAnchorRow()Integer图表的顶部锚定在这一行中。
getOffsetX()Integer图表左上角的锚点相对于锚点列偏移这么多像素。
getOffsetY()Integer图表左上角的锚点相对于锚点行偏移了这么多像素。

CopyPasteType

属性

属性类型说明
PASTE_NORMALEnum粘贴值、公式、格式和合并值。
PASTE_NO_BORDERSEnum粘贴值、公式、格式和合并值,但不含边框。
PASTE_FORMATEnum仅粘贴格式和数据验证。
PASTE_FORMULAEnum仅粘贴公式。
PASTE_DATA_VALIDATIONEnum仅粘贴数据验证。
PASTE_VALUESEnum仅粘贴值,不粘贴格式、公式或合并值。
PASTE_CONDITIONAL_FORMATTINGEnum请仅粘贴颜色规则。
PASTE_COLUMN_WIDTHSEnum请仅粘贴列宽。

DataExecutionErrorCode

属性

属性类型说明
DATA_EXECUTION_ERROR_CODE_UNSUPPORTEDEnumApps 脚本不支持的数据执行错误代码。
NONEEnum数据执行过程没有错误。
TIME_OUTEnum数据执行超时。
TOO_MANY_ROWSEnum数据执行返回的行数超出上限。
TOO_MANY_COLUMNSEnum数据执行返回的列数超出上限。
TOO_MANY_CELLSEnum数据执行返回的单元格数超出上限。
ENGINEEnum数据执行引擎错误。
PARAMETER_INVALIDEnum数据执行参数无效。
UNSUPPORTED_DATA_TYPEEnum数据执行返回不受支持的数据类型。
DUPLICATE_COLUMN_NAMESEnum数据执行结果会返回重复的列名称。
INTERRUPTEDEnum数据执行中断。
OTHEREnum其他错误。
TOO_MANY_CHARS_PER_CELLEnum数据执行返回的值超出单个单元格所允许的字符数上限。
DATA_NOT_FOUNDEnum找不到数据源引用的数据库。
PERMISSION_DENIEDEnum用户无权访问数据源引用的数据库。

DataExecutionState

属性

属性类型说明
DATA_EXECUTION_STATE_UNSUPPORTEDEnumApps 脚本不支持数据执行状态。
RUNNINGEnum数据执行操作已启动并正在运行。
SUCCESSEnum数据执行已完成且成功。
ERROREnum数据执行已完成,但存在错误。
NOT_STARTEDEnum数据执行操作尚未开始。

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_UNSUPPORTEDEnumApps 脚本不支持的数据源参数类型。
CELLEnum数据源参数根据单元格值。

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_UNSUPPORTEDEnum数据源刷新范围不受支持。
ALL_DATA_SOURCESEnum刷新会应用于电子表格中的所有数据源。

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()voidDataSourceTable 中移除此列。

DataSourceTableFilter

方法

方法返回类型简介
getDataSourceColumn()DataSourceColumn返回此过滤条件适用的数据源列。
getDataSourceTable()DataSourceTable返回此过滤器所属的 DataSourceTable
getFilterCriteria()FilterCriteria返回此过滤条件的过滤条件。
remove()void从数据源对象中移除此过滤条件。
setFilterCriteria(filterCriteria)DataSourceTableFilter为此过滤器设置过滤条件。

DataSourceType

属性

属性类型说明
DATA_SOURCE_TYPE_UNSUPPORTEDEnumApps 脚本不支持的数据源类型。
BIGQUERYEnumBigQuery 数据源。

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 值定义的条件(通常取自现有规则的 criteriaarguments)。

DataValidationCriteria

属性

属性类型说明
DATE_AFTEREnum要求的日期晚于指定值。
DATE_BEFOREEnum要求的日期早于指定值。
DATE_BETWEENEnum需要一个介于指定值之间的日期。
DATE_EQUAL_TOEnum要求日期与给定值相等。
DATE_IS_VALID_DATEEnum需要指定日期。
DATE_NOT_BETWEENEnum要求日期不在指定值之间。
DATE_ON_OR_AFTEREnum要求的日期不得晚于指定值。
DATE_ON_OR_BEFOREEnum要求的日期不得早于指定值。
NUMBER_BETWEENEnum需要介于指定值之间的数字。
NUMBER_EQUAL_TOEnum需要一个等于指定值的数字。
NUMBER_GREATER_THANEnum要求数字大于指定值。
NUMBER_GREATER_THAN_OR_EQUAL_TOEnum需要一个大于或等于指定值的数字。
NUMBER_LESS_THANEnum要求数字小于指定的值。
NUMBER_LESS_THAN_OR_EQUAL_TOEnum需要小于或等于指定值的数字。
NUMBER_NOT_BETWEENEnum要求数字不在指定值之间。
NUMBER_NOT_EQUAL_TOEnum需要输入不等于指定值的数字。
TEXT_CONTAINSEnum要求输入包含给定的值。
TEXT_DOES_NOT_CONTAINEnum要求输入值不包含指定值。
TEXT_EQUAL_TOEnum要求输入值等于指定的值。
TEXT_IS_VALID_EMAILEnum要求输入值采用电子邮件地址的形式。
TEXT_IS_VALID_URLEnum要求输入格式为网址。
VALUE_IN_LISTEnum要求输入值与给定值相等。
VALUE_IN_RANGEEnum要求输入值等于给定范围内的值。
CUSTOM_FORMULAEnum需要输入使给定公式的计算结果为 true
CHECKBOXEnum要求输入值是自定义值或布尔值;以复选框形式呈现。

DateTimeGroupingRule

方法

方法返回类型简介
getRuleType()DateTimeGroupingRuleType获取日期时间分组规则的类型。

DateTimeGroupingRuleType

属性

属性类型说明
UNSUPPORTEDEnum日期时间分组规则类型不受支持。
SECONDEnum按秒(从 0 到 59)分组日期时间。
MINUTEEnum按分钟分组日期时间(0 到 59)。
HOUREnum使用 24 小时制按小时对日期时间进行分组(从 0 到 23)。
HOUR_MINUTEEnum使用 24 小时制(例如 19:45)按小时和分钟对日期时间进行分组。
HOUR_MINUTE_AMPMEnum使用 12 小时制按小时和分钟对日期时间进行分组,例如 7:45 PM
DAY_OF_WEEKEnum按周几对日期时间进行分组,例如 Sunday
DAY_OF_YEAREnum按日期(1 到 366)对日期时间进行分组。
DAY_OF_MONTHEnum按日期(从 1 到 31)对日期时间进行分组。
DAY_MONTHEnum按日期和月份分组日期时间,例如 22-Nov
MONTHEnum按月份对日期时间进行分组,例如 Nov
QUARTEREnum按季度对日期时间进行分组,例如 Q1(代表 1 月到 3 月)。
YEAREnum按年对日期时间进行分组,例如 2008。
YEAR_MONTHEnum按年和月对日期时间进行分组,例如 2008-Nov
YEAR_QUARTEREnum按年和季度对日期时间进行分组,例如 2008 Q4
YEAR_MONTH_DAYEnum按年、月、日分组日期-时间,例如 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

属性

属性类型说明
SPREADSHEETEnum与顶级电子表格相关联的开发者元数据的位置类型。
SHEETEnum与整个工作表关联的开发者元数据的位置类型。
ROWEnum与行相关联的开发者元数据的位置类型。
COLUMNEnum与列关联的开发者元数据的位置类型。

DeveloperMetadataVisibility

属性

属性类型说明
DOCUMENTEnum凡是可以访问文档的开发者项目,都可以访问文档可见的元数据。
PROJECTEnum项目可见的元数据仅对创建元数据的开发者项目可见,并且只能供其访问。

Dimension

属性

属性类型说明
COLUMNSEnum列(垂直)维度。
ROWSEnum行(水平)维度。

Direction

属性

属性类型说明
UPEnum减少行索引的方向。
DOWNEnum提高行索引的方向。
PREVIOUSEnum降低列索引的方向。
NEXTEnum列索引的增加方向。

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将图表类型设置为 BarChart 并返回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder将图表类型设置为 ColumnChart 并返回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder将图表类型设置为 ComboChart 并返回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder将图表类型设置为 HistogramChart 并返回 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将图表类型设置为 BarChart 并返回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder将图表类型设置为 ColumnChart 并返回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder将图表类型设置为 ComboChart 并返回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder将图表类型设置为 HistogramChart 并返回 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将图表类型设置为 BarChart 并返回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder将图表类型设置为 ColumnChart 并返回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder将图表类型设置为 ComboChart 并返回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder将图表类型设置为 HistogramChart 并返回 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将图表类型设置为 BarChart 并返回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder将图表类型设置为 ColumnChart 并返回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder将图表类型设置为 ComboChart 并返回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder将图表类型设置为 HistogramChart 并返回 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将图表类型设置为 BarChart 并返回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder将图表类型设置为 ColumnChart 并返回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder将图表类型设置为 ComboChart 并返回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder将图表类型设置为 HistogramChart 并返回 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将图表类型设置为 BarChart 并返回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder将图表类型设置为 ColumnChart 并返回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder将图表类型设置为 ComboChart 并返回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder将图表类型设置为 HistogramChart 并返回 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将图表类型设置为 BarChart 并返回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder将图表类型设置为 ColumnChart 并返回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder将图表类型设置为 ComboChart 并返回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder将图表类型设置为 HistogramChart 并返回 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将图表类型设置为 BarChart 并返回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder将图表类型设置为 ColumnChart 并返回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder将图表类型设置为 ComboChart 并返回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder将图表类型设置为 HistogramChart 并返回 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将图表类型设置为 BarChart 并返回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder将图表类型设置为 ColumnChart 并返回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder将图表类型设置为 ComboChart 并返回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder将图表类型设置为 HistogramChart 并返回 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将图表类型设置为 BarChart 并返回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder将图表类型设置为 ColumnChart 并返回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder将图表类型设置为 ComboChart 并返回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder将图表类型设置为 HistogramChart 并返回 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设置过滤条件,以显示求值结果为 true 且具有指定公式(如 =B:B<C:C)的单元格。
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_EMPTYNUMBER_GREATER_THAN

FrequencyType

属性

属性类型说明
FREQUENCY_TYPE_UNSUPPORTEDEnum频率类型不受支持。
DAILYEnum每天刷新。
WEEKLYEnum每周的每周特定日刷新。
MONTHLYEnum在每月的给定日期每月刷新。

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

属性

属性类型说明
BEFOREEnum控制切换开关在组之前的位置(索引位置较低)。
AFTEREnum控制切换开关在组之后的位置(指数较高)。

InterpolationType

属性

属性类型说明
NUMBEREnum将该数值用作渐变条件的特定插值点。
PERCENTEnum将该数值用作渐变条件的百分比插值点。
PERCENTILEEnum将该数值用作渐变条件的百分位插值点。
MINEnum推断出最小数量作为梯度条件的特定插值点。
MAXEnum推断最大值作为梯度条件的特定插值点。

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

属性

属性类型说明
CUSTOMEnum自定义函数,此值仅对计算字段有效。
SUMEnumSUM 函数
COUNTAEnumCOUNTA 函数
COUNTEnumCOUNT 函数
COUNTUNIQUEEnumCOUNTUNIQUE 函数
AVERAGEEnumAVERAGE 函数
MAXEnumMAX 函数
MINEnumMIN 函数
MEDIANEnumMEDIAN 函数
PRODUCTEnumPRODUCT 函数
STDEVEnumSTDEV 函数
STDEVPEnumSTDEVP 函数
VAREnumVAR 函数
VARPEnumVARP 函数

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

属性

属性类型说明
DEFAULTEnum默认此值。
PERCENT_OF_ROW_TOTALEnum以相应行占总数的百分比形式显示数据透视值。
PERCENT_OF_COLUMN_TOTALEnum将数据透视值显示为该列总计的百分比。
PERCENT_OF_GRAND_TOTALEnum将数据透视值显示为占总数的百分比。

Protection

方法

方法返回类型简介
addEditor(emailAddress)Protection将指定用户添加到受保护的工作表或范围的编辑器列表中。
addEditor(user)Protection将指定用户添加到受保护的工作表或范围的编辑器列表中。
addEditors(emailAddresses)Protection将指定用户数组添加到受保护的工作表或范围的编辑器列表中。
addTargetAudience(audienceId)Protection将指定的目标对象群组添加为受保护范围的编辑者。
canDomainEdit()Boolean确定网域内拥有电子表格的所有用户是否有权修改受保护的范围或工作表。
canEdit()Boolean确定用户是否有权修改受保护的范围或工作表。
getDescription()String获取受保护范围或工作表的说明。
getEditors()User[]获取受保护范围或工作表的编辑器列表。
getProtectionType()ProtectionType获取受保护地区的类型,即 RANGESHEET
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

属性

属性类型说明
RANGEEnum针对某个范围的保护。
SHEETEnum工作表的保护。

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.UPDirection.DOWN 的副本;如果维度为 Dimension.COLUMNS,则返回 Direction.NEXTDirection.PREVIOUS
getDataSourceFormula()DataSourceFormula返回范围内第一个单元格的 DataSourceFormula,如果单元格不包含数据源公式,则返回 null
getDataSourceFormulas()DataSourceFormula[]返回范围中单元格的 DataSourceFormula
getDataSourcePivotTables()DataSourcePivotTable[]获取与范围相交的所有数据源数据透视表。
getDataSourceTables()DataSourceTable[]获取与范围相交的所有数据源表。
getDataSourceUrl()String返回此范围内数据的网址,该网址可用于创建图表和查询。
getDataTable()DataTable以 DataTable 的形式返回此对象中的数据。
getDataTable(firstRowIsHeader)DataTable以 DataTable 的形式返回此范围内的数据。
getDataValidation()DataValidation返回范围中左上角单元格的数据验证规则。
getDataValidations()DataValidation[][]返回范围内所有单元格的数据验证规则。
getDeveloperMetadata()DeveloperMetadata[]获取与此范围关联的开发者元数据。
getDisplayValue()String返回范围中左上角单元格的显示值。
getDisplayValues()String[][]返回此范围中的矩形网格值。
getFilter()Filter返回此范围所属的工作表上的过滤条件;如果工作表上没有任何过滤条件,则返回 null
getFontColorObject()Color返回单元格左上角相应单元格的字体颜色。
getFontColorObjects()Color[][]返回范围内的单元格的字体颜色。
getFontFamilies()String[][]返回范围内的单元格的字体系列。
getFontFamily()String返回单元格左上角的字体集。
getFontLine()String获取范围左上角的单元格线条样式('underline''line-through''none')。
getFontLines()String[][]获取范围内的单元格的线条样式('underline''line-through''none')。
getFontSize()Integer返回单元格左上角相应单元格字体大小的字体大小。
getFontSizes()Integer[][]返回范围中单元格的字体大小。
getFontStyle()String返回单元格左上角的字体样式('italic''normal')。
getFontStyles()String[][]返回范围内的单元格的字体样式。
getFontWeight()String返回单元格左上角字体粗细(正常/粗体)的范围。
getFontWeights()String[][]返回范围内的单元格的字体粗细。
getFormula()String返回范围左上角的单元格的公式(A1 表示法);如果单元格为空或不包含公式,则为空字符串。
getFormulaR1C1()String返回给定单元格的公式(R1C1 表示法);如果没有,则返回 null
getFormulas()String[][]返回范围中单元格的公式(A1 表示法)。
getFormulasR1C1()String[][]返回范围中单元格的公式(R1C1 表示法)。
getGridId()Integer返回范围的父工作表的网格 ID。
getHeight()Integer返回范围的高度。
getHorizontalAlignment()String返回单元格左上角文本(水平/左上角)的水平对齐方式。
getHorizontalAlignments()String[][]返回单元格内相应单元格的水平对齐方式。
getLastColumn()Integer返回结束列的位置。
getLastRow()Integer返回结束行位置。
getMergedRanges()Range[]返回代表已合并单元格的 Range 对象数组,这些单元格完全位于当前范围内,或包含当前范围内的至少一个单元格。
getNextDataCell(direction)Range从范围第一行和首行的单元格开始,返回给定方向上的下一个单元格,即包含数据的连续单元格范围的边缘,或电子表格方向上单元格边缘的单元格。
getNote()String返回与指定范围关联的备注。
getNotes()String[][]返回与范围中的单元格相关联的备注。
getNumColumns()Integer返回此范围内的列数。
getNumRows()Integer返回此范围内的行数。
getNumberFormat()String获取给定范围左上角的单元格的数字或日期格式。
getNumberFormats()String[][]返回单元格中数字或日期的格式。
getRichTextValue()RichTextValue返回范围左上角的单元格的富文本值;如果单元格值不是文本,则返回 null
getRichTextValues()RichTextValue[][]返回范围中单元格的富文本值。
getRow()Integer返回此范围的行位置。
getRowIndex()Integer返回此范围的行位置。
getSheet()Sheet返回此范围所属的工作表。
getTextDirection()TextDirection返回范围左上角的单元格的文本方向。
getTextDirections()TextDirection[][]返回范围中单元格的文本方向。
getTextRotation()TextRotation返回范围左上角的单元格的文本旋转设置。
getTextRotations()TextRotation[][]返回范围中单元格的文本旋转设置。
getTextStyle()TextStyle返回范围左上角的单元格的文本样式。
getTextStyles()TextStyle[][]返回范围中单元格的文本样式。
getValue()Object返回范围中左上角单元格的值。
getValues()Object[][]返回此范围中的矩形网格值。
getVerticalAlignment()String返回单元格在范围左上角的垂直对齐方式(顶部/中间/底部)。
getVerticalAlignments()String[][]返回范围中单元格的垂直对齐方式。
getWidth()Integer以列为单位返回范围的宽度。
getWrap()Boolean返回单元格中的文本是否换行。
getWrapStrategies()WrapStrategy[][]返回范围内的单元格的文本换行策略。
getWrapStrategy()WrapStrategy返回范围左上角的单元格的文本换行策略。
getWraps()Boolean[][]返回单元格中的文本是否换行。
insertCells(shiftDimension)Range在此范围内插入空白单元格。
insertCheckboxes()Range在相应范围的每个单元格中插入复选框,并配置 true 表示已选中,false 表示未选中。
insertCheckboxes(checkedValue)Range在相应范围的每个单元格中插入复选框,并配置一个自定义值(针对已选中)和空字符串(对于取消选中状态)。
insertCheckboxes(checkedValue, uncheckedValue)Range将复选框插入范围内的每个单元格,并配置自定义值作为已选中和未选中状态的值。
isBlank()Boolean如果范围完全为空,则返回 true
isChecked()Boolean返回范围内所有单元格的复选框状态是否为“已勾选”。
isEndColumnBounded()Boolean确定范围的末尾是否绑定到特定列。
isEndRowBounded()Boolean确定范围的末尾是否绑定到特定行。
isPartOfMerge()Boolean如果当前范围内的单元格与已合并的单元格重叠,则返回 true
isStartColumnBounded()Boolean确定范围的开头是否绑定到特定列。
isStartRowBounded()Boolean确定范围的开头是否绑定到特定行。
merge()Range将范围中的单元格合并为一个文本块。
mergeAcross()Range合并该范围中各列内的单元格。
mergeVertically()Range将范围中的单元格合并。
moveTo(target)void从此范围剪切并粘贴(格式和值)到目标范围。
offset(rowOffset, columnOffset)Range返回给定范围的行数和列数(可以是负数)相对于此范围的新范围。
offset(rowOffset, columnOffset, numRows)Range返回相对于当前范围的新范围,其左上角与当前范围相隔给定的行和列,并且具有指定的单元格高度。
offset(rowOffset, columnOffset, numRows, numColumns)Range返回相对于当前范围的新范围,其左上角通过给定行和列相对于当前范围偏移,并且具有指定的单元格高度和宽度。
protect()Protection创建一个对象,该对象可防止除了拥有权限的用户修改该范围。
randomize()Range随机排列给定范围中各行的顺序。
removeCheckboxes()Range移除范围中的所有复选框。
removeDuplicates()Range移除此范围中包含与之前任何行中的值重复的行。
removeDuplicates(columnsToCompare)Range移除此范围中包含指定列中与前一行重复的值的行。
setBackground(color)Range以 CSS 表示法(例如 '#ffffff''white')设置范围内所有单元格的背景颜色。
setBackgroundObject(color)Range设置范围内所有单元格的背景颜色。
setBackgroundObjects(color)Range用于设置背景颜色的矩形网格(必须与此范围的尺寸匹配)。
setBackgroundRGB(red, green, blue)Range使用 RGB 值(0 到 255 之间的整数,包括 0 和 255)将背景设置为指定的颜色。
setBackgrounds(color)Range用于设置背景颜色的矩形网格(必须与此范围的尺寸匹配)。
setBorder(top, left, bottom, right, vertical, horizontal)Range设置边框属性。
setBorder(top, left, bottom, right, vertical, horizontal, color, style)Range设置颜色和/或样式的边框属性。
setDataValidation(rule)Range为范围中的所有单元格设置一条数据验证规则。
setDataValidations(rules)Range为范围中的所有单元格设置数据验证规则。
setFontColor(color)Range设置 CSS 表示法中的字体颜色(例如 '#ffffff''white')。
setFontColorObject(color)Range设置指定范围的字体颜色。
setFontColorObjects(colors)Range设置矩形字体网格(必须与此范围的尺寸匹配)。
setFontColors(colors)Range设置矩形字体网格(必须与此范围的尺寸匹配)。
setFontFamilies(fontFamilies)Range设置矩形字体网格系列(必须与此范围的尺寸匹配)。
setFontFamily(fontFamily)Range设置字体系列,例如“ Arial”或“Helvetica”。
setFontLine(fontLine)Range设置指定范围('underline''line-through''none')的字体线条样式。
setFontLines(fontLines)Range设置矩形矩形网格网格(必须与此范围的尺寸匹配)。
setFontSize(size)Range设置要使用的字体大小。
setFontSizes(sizes)Range用于设置字体大小的矩形网格(必须与此范围的尺寸匹配)。
setFontStyle(fontStyle)Range为指定范围('italic''normal')设置字体样式。
setFontStyles(fontStyles)Range设置矩形字体网格(必须与此范围的尺寸匹配)。
setFontWeight(fontWeight)Range为指定范围(正常/粗体)设置字体粗细。
setFontWeights(fontWeights)Range用于设置字体粗细的矩形网格(必须与此范围的尺寸匹配)。
setFormula(formula)Range更新此范围的公式。
setFormulaR1C1(formula)Range更新此范围的公式。
setFormulas(formulas)Range用于设置公式中的矩形网格(必须与此范围的维度相匹配)。
setFormulasR1C1(formulas)Range用于设置公式中的矩形网格(必须与此范围的维度相匹配)。
setHorizontalAlignment(alignment)Range设置给定范围(左侧/中心/右侧)的水平(从左到右)对齐。
setHorizontalAlignments(alignments)Range设置水平对齐的矩形网格。
setNote(note)Range将备注设置为指定值。
setNotes(notes)Range用于设置矩形备注网格(必须与此范围的尺寸匹配)。
setNumberFormat(numberFormat)Range将数字或日期格式设置为指定的格式字符串。
setNumberFormats(numberFormats)Range用于设置数字或日期格式的矩形网格(必须与此范围的尺寸匹配)。
setRichTextValue(value)Range为范围中的单元格设置富文本值。
setRichTextValues(values)Range设置富文本值的矩形网格。
setShowHyperlink(showHyperlink)Range设置该范围是否应显示超链接。
setTextDirection(direction)Range设置范围中单元格的文本方向。
setTextDirections(directions)Range设置文本方向的矩形网格。
setTextRotation(degrees)Range为范围中的单元格设定文本旋转设置。
setTextRotation(rotation)Range为范围中的单元格设定文本旋转设置。
setTextRotations(rotations)Range用于设置文本旋转功能的矩形网格。
setTextStyle(style)Range为范围中的单元格设置文本样式。
setTextStyles(styles)Range设置矩形文本网格。
setValue(value)Range设置范围的值。
setValues(values)Range设置一个矩形值网格(必须与此范围的尺寸匹配)。
setVerticalAlignment(alignment)Range设置给定范围(顶部/中间/底部)的垂直(顶部至底部)对齐。
setVerticalAlignments(alignments)Range设置垂直对齐的矩形网格(必须与此范围的尺寸匹配)。
setVerticalText(isVertical)Range设置是否堆叠范围内的单元格文本。
setWrap(isWrapEnabled)Range设置指定范围的单元格换行。
setWrapStrategies(strategies)Range设置矩形封装网格策略。
setWrapStrategy(strategy)Range为范围内的单元格设置文本换行策略。
setWraps(isWrapEnabled)Range设置矩形换行策略网格(必须与此范围的尺寸匹配)。
shiftColumnGroupDepth(delta)Range将范围的列分组深度更改为指定量。
shiftRowGroupDepth(delta)Range将范围的行分组深度更改为指定量。
sort(sortSpecObj)Range根据指定的列和顺序对指定范围内的单元格进行排序。
splitTextToColumns()void根据自动检测的分隔符将一列文本拆分为多列。
splitTextToColumns(delimiter)void将某列的文本拆分为多列,并将指定字符串用作自定义分隔符。
splitTextToColumns(delimiter)void根据指定的分隔符将一列文本拆分为多列。
trimWhitespace()Range去除此范围中的每个单元格中的空格(例如空格、制表符或换行符)。
uncheck()Range将范围中复选框的状态更改为“未选中”。

RangeList

方法

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

RecalculationInterval

属性

属性类型说明
ON_CHANGEEnum仅在值发生更改时重新计算。
MINUTEEnum每分钟重新计算值的变化。
HOUREnum更改值,并且每小时重新计算。

RelativeDate

属性

属性类型说明
TODAYEnum与当前日期相比的日期。
TOMORROWEnum与当前日期之后的日期进行比较。
YESTERDAYEnum与当前日期相比的日期。
PAST_WEEKEnum过去一周的日期。
PAST_MONTHEnum过去一个月内的日期。
PAST_YEAREnum日期在最近一年内。

RichTextValue

方法

方法返回类型简介
copy()RichTextValueBuilder返回使用此富文本值初始化的富文本值的构建器。
getEndIndex()Integer获取单元格内此值的结束索引。
getLinkUrl()String返回此值的链接网址。
getLinkUrl(startOffset, endOffset)String返回从 startOffsetendOffset 的文本的链接网址。
getRuns()RichTextValue[]返回拆分为运行数组的富文本字符串,其中每次运行时是具有一致文本样式的最长子字符串。
getStartIndex()Integer获取该值在单元格中的起始索引。
getText()String返回此值的文本。
getTextStyle()TextStyle返回此值的文本样式。
getTextStyle(startOffset, endOffset)TextStyle返回从 startOffsetendOffset 的文本文本样式。

RichTextValueBuilder

方法

方法返回类型简介
build()RichTextValue通过该构建器创建富文本值。
setLinkUrl(startOffset, endOffset, linkUrl)RichTextValueBuilder设置此值的给定子字符串的链接网址;如果 linkUrlnull,则清除该网址。
setLinkUrl(linkUrl)RichTextValueBuilder为整个值设置链接网址,或者在 linkUrlnull 时清除网址。
setText(text)RichTextValueBuilder设置此值的文本并清除所有现有文本样式。
setTextStyle(startOffset, endOffset, textStyle)RichTextValueBuilder将文本样式应用于此值的给定子字符串。
setTextStyle(textStyle)RichTextValueBuilder将文本样式应用于整个值。

Selection

方法

方法返回类型简介
getActiveRange()Range返回活动工作表中的所选范围,如果没有活动范围,则返回 null
getActiveRangeList()RangeList返回活动工作表中的活动范围列表;如果没有活动范围,则返回 null
getActiveSheet()Sheet返回电子表格中的活动工作表。
getCurrentCell()Range返回某个有效范围内选定的当前(突出显示的)单元格;如果没有当前单元格,则返回 null
getNextDataRange(direction)Rangecurrent cellactive range 开始,并沿给定方向移动时,会返回调整范围,即范围的相应边缘已偏移,以覆盖 next data cell,同时仍覆盖当前单元格。

Sheet

方法

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

SheetType

属性

属性类型说明
GRIDEnum包含网格的工作表。
OBJECTEnum包含单个嵌入对象(例如 EmbeddedChart)的工作表。
DATASOURCEEnum包含 DataSource 的工作表。

Slicer

方法

方法返回类型简介
getBackgroundColorObject()Color返回截剪器的背景 Color
getColumnPosition()Integer返回在截剪器中应用过滤条件的列位置(相对于截剪器的数据范围);如果未设置列位置,则返回 null
getContainerInfo()ContainerInfo获取有关截剪器在工作表中放置位置的信息。
getFilterCriteria()FilterCriteria返回截剪器的过滤条件;如果未设置过滤条件,则返回 null
getRange()Range获取应用截剪器的数据范围。
getTitle()String返回截剪器的标题。
getTitleHorizontalAlignment()String获取标题的水平对齐方式。
getTitleTextStyle()TextStyle返回截剪器标题的文本样式。
isAppliedToPivotTables()Boolean返回指定的截剪器是否已应用于数据透视表。
remove()void删除截剪器。
setApplyToPivotTables(applyToPivotTables)Slicer设置是否应将指定截剪器应用于工作表中的数据透视表。
setBackgroundColor(color)Slicer设置截剪器的背景颜色。
setBackgroundColorObject(color)Slicer设置截剪器的背景 Color
setColumnFilterCriteria(columnPosition, filterCriteria)Slicer设置截剪器的列索引和过滤条件。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)Slicer设置截剪器在工作表上的位置。
setRange(rangeApi)Slicer设置应用截剪器的数据范围。
setTitle(title)Slicer设置截剪器的标题。
setTitleHorizontalAlignment(horizontalAlignment)Slicer设置截剪器中标题的水平对齐方式。
setTitleTextStyle(textStyle)Slicer设置截剪器的文本样式。

SortOrder

属性

属性类型说明
ASCENDINGEnum升序排序。
DESCENDINGEnum降序排序顺序。

SortSpec

方法

方法返回类型简介
getBackgroundColor()Color返回用于排序的背景颜色,如果没有,则返回 null
getDataSourceColumn()DataSourceColumn获取排序规范所依据的数据源列。
getDimensionIndex()Integer返回维度索引或 null(如果未关联到本地过滤器)。
getForegroundColor()Color返回用于排序的前景颜色,如果没有,则返回 null
getSortOrder()SortOrder返回排序顺序。
isAscending()Boolean返回排序顺序是否为升序。

Spreadsheet

方法

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

SpreadsheetApp

属性

属性类型说明
AutoFillSeriesAutoFillSeries用于计算自动填充值的系列类型的枚举。
BandingThemeBandingTheme可能的带状主题的枚举。
BooleanCriteriaBooleanCriteria条件格式布尔值条件的枚举。
BorderStyleBorderStyle用于为 Range 设置边框的有效样式的枚举。
ColorTypeColorType可能的颜色类型的枚举。
CopyPasteTypeCopyPasteType可能的粘贴类型的枚举。
DataExecutionErrorCodeDataExecutionErrorCode枚举可能的数据执行错误代码。
DataExecutionStateDataExecutionState可能的数据执行状态的枚举。
DataSourceParameterTypeDataSourceParameterType可能的数据源参数类型的枚举。
DataSourceRefreshScopeDataSourceRefreshScope可能的数据源刷新范围的枚举。
DataSourceTypeDataSourceType可能的数据源类型的枚举。
DataValidationCriteriaDataValidationCriteria表示可以对范围设置的数据验证条件的枚举。
DateTimeGroupingRuleTypeDateTimeGroupingRuleType日期时间分组规则的枚举。
DeveloperMetadataLocationTypeDeveloperMetadataLocationType可能的开发者元数据位置类型的枚举。
DeveloperMetadataVisibilityDeveloperMetadataVisibility枚举可能的开发者元数据显示设置。
DimensionDimension一个电子表格可能的维度的枚举。
DirectionDirection使用箭头键在电子表格中可能移动的方向的枚举。
FrequencyTypeFrequencyType可能的频率类型的枚举。
GroupControlTogglePositionGroupControlTogglePosition枚举组控件切换位置的位置。
InterpolationTypeInterpolationType条件格式渐变插值类型的枚举。
PivotTableSummarizeFunctionPivotTableSummarizeFunction用于汇总数据透视表中的值的函数枚举。
PivotValueDisplayTypePivotValueDisplayType枚举数据透视值显示方式的枚举。
ProtectionTypeProtectionType表示电子表格中可免受修改部分的部分的枚举。
RecalculationIntervalRecalculationInterval枚举可在电子表格重新计算中使用的间隔。
RelativeDateRelativeDate用于计算要在基于日期的 BooleanCriteria 中使用的值的相对日期选项的枚举。
SheetTypeSheetType枚举可以存在于电子表格中的不同类型的工作表。
SortOrderSortOrder排序顺序的枚举。
TextDirectionTextDirection有效文本方向的枚举。
TextToColumnsDelimiterTextToColumnsDelimiter用于拆分文本到列的预设分隔符的枚举。
ThemeColorTypeThemeColorType可能的主题颜色类型的枚举。
ValueTypeValueType由电子表格服务的 Range 类返回的 Range.getValue()Range.getValues() 值类型的枚举。
WrapStrategyWrapStrategy用于封装单元格的策略的枚举。

方法

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

SpreadsheetTheme

方法

方法返回类型简介
getConcreteColor(themeColorType)Color返回有效的主题颜色类型对应的具体 Color
getFontFamily()String返回主题的字体系列;如果主题是 null 主题,则返回 null
getThemeColors()ThemeColorType[]返回当前主题的所有可能主题颜色类型的列表。
setConcreteColor(themeColorType, color)SpreadsheetTheme将与此配色方案中的 ThemeColorType 相关联的具体颜色设为指定颜色。
setConcreteColor(themeColorType, red, green, blue)SpreadsheetTheme将与此配色方案中的 ThemeColorType 相关联的具体颜色设为 RGB 格式的指定颜色。
setFontFamily(fontFamily)SpreadsheetTheme设置主题的字体系列。

TextDirection

属性

属性类型说明
LEFT_TO_RIGHTEnum从左到右的文本方向。
RIGHT_TO_LEFTEnum从右向左的文本方向。

TextFinder

方法

方法返回类型简介
findAll()Range[]返回符合搜索条件的所有单元格。
findNext()Range返回符合搜索条件的下一个单元格。
findPrevious()Range返回符合搜索条件的上一个单元格。
getCurrentMatch()Range返回符合搜索条件的当前单元格。
ignoreDiacritics(ignoreDiacritics)TextFinder如果为 true,则将搜索配置为在匹配时忽略变音符号;否则,搜索匹配变音符号。
matchCase(matchCase)TextFinder如果为 true,则将搜索配置为与搜索文本完全匹配,否则将默认搜索不区分大小写。
matchEntireCell(matchEntireCell)TextFinder如果为 true,则将搜索配置为匹配单元格的全部内容;否则,搜索默认为部分匹配。
matchFormulaText(matchFormulaText)TextFinder如果为 true,则将搜索配置为返回公式文本中显示的匹配项;否则,根据公式的显示值考虑包含公式的单元格。
replaceAllWith(replaceText)Integer使用指定文本替换所有匹配项。
replaceWith(replaceText)Integer将当前匹配的单元格中的搜索文本替换为指定文本,并返回替换次数。
startFrom(startRange)TextFinder将搜索配置为在指定的单元格范围之后立即开始搜索。
useRegularExpression(useRegEx)TextFinder如果为 true,则将搜索配置为将搜索字符串解读为正则表达式;否则,搜索会将搜索字符串解读为普通文本。

TextRotation

方法

方法返回类型简介
getDegrees()Integer获取标准文本方向与当前文本方向之间的角度。
isVertical()Boolean如果文本是垂直堆叠的,则返回 true;否则返回 false

TextStyle

方法

方法返回类型简介
copy()TextStyleBuilder创建使用此文本样式的值初始化的文本样式构建器。
getFontFamily()String获取文本的字体系列。
getFontSize()Integer获取文本的字体大小(以点为单位)。
getForegroundColorObject()Color获取文本的字体颜色。
isBold()Boolean获取文本是否为粗体。
isItalic()Boolean获取单元格是否为斜体。
isStrikethrough()Boolean获取单元格是否包含删除线。
isUnderline()Boolean获取单元格是否带有下划线。

TextStyleBuilder

方法

方法返回类型简介
build()TextStyle通过此构建器创建文本样式。
setBold(bold)TextStyleBuilder设置文本是否粗体。
setFontFamily(fontFamily)TextStyleBuilder设置文本字体系列,例如“ Arial”。
setFontSize(fontSize)TextStyleBuilder设置文本字体大小(以点为单位)。
setForegroundColor(cssString)TextStyleBuilder设置文本字体颜色。
setForegroundColorObject(color)TextStyleBuilder设置文本字体颜色。
setItalic(italic)TextStyleBuilder设置文本是否为斜体。
setStrikethrough(strikethrough)TextStyleBuilder设置文本是否包含删除线。
setUnderline(underline)TextStyleBuilder设置文本是否带有下划线。

TextToColumnsDelimiter

属性

属性类型说明
COMMAEnum"," 分隔符。
SEMICOLONEnum";" 分隔符。
PERIODEnum"." 分隔符。
SPACEEnum" " 分隔符。

ThemeColor

方法

方法返回类型简介
getColorType()ColorType获取此颜色的类型。
getThemeColorType()ThemeColorType获取此颜色的主题颜色类型。

ThemeColorType

属性

属性类型说明
UNSUPPORTEDEnum表示不受支持的主题颜色。
TEXTEnum表示文本颜色。
BACKGROUNDEnum表示用于图表背景的颜色。
ACCENT1Enum表示第一种强调色。
ACCENT2Enum表示第二种强调色。
ACCENT3Enum表示第三个强调色。
ACCENT4Enum表示第四种强调色。
ACCENT5Enum表示第五个强调色。
ACCENT6Enum表示第六个强调色。
HYPERLINKEnum表示用于超链接的颜色。

ValueType

属性

属性类型说明
IMAGEEnum单元格包含图片时的值类型。

WrapStrategy

属性

属性类型说明
WRAPEnum将超出单元格宽度的行换行到新行。
OVERFLOWEnum将单元格内容插入下一个单元格,前提是该单元格为空。
CLIPEnum超过单元格宽度的剪辑行。