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用于表示单元格文本的风格化文本字符串。
RichTextValueBuilderRTF 值的构建器。
Selection访问当前工作表中的当前所选内容。
Sheet访问和修改电子表格工作表。
SheetType电子表格中可包含的不同表格类型。
Slicer表示截剪器,用于以非协作方式过滤范围、图表和数据透视表。
SortOrder表示排序顺序的枚举。
SortSpec排序规范。
Spreadsheet访问和修改 Google 表格文件。
SpreadsheetApp访问和创建 Google 表格文件。
SpreadsheetTheme访问和修改现有主题。
TextDirection文本路线枚举。
TextFinder查找或替换范围、工作表或电子表格中的文本。
TextRotation访问单元格的文本旋转设置。
TextStyle单元格中文本的呈现样式。
TextStyleBuilder文本样式的构建器。
TextToColumnsDelimiter枚举各种预设分隔符类型,可将一列文本拆分为多列。
ThemeColor主题颜色的表示法。
ThemeColorType描述主题中支持的各种颜色条目的枚举。
ValueTypeRange.getValue()Range.getValues() 从电子表格服务的 Range 类中返回的值类型的枚举。
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将图表类型设置为条形图并返回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder将图表类型设置为 ColumnChart,并返回一个 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder将图表类型设置为 ComboChart 值,并返回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder将图表类型设置为直方图类型并返回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder将图表类型设置为折线图,并返回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder将图表类型设置为 PieChart 并返回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder将图表类型设置为 ScatterChart 并返回 EmbeddedScatterChartBuilder
asTableChart()EmbeddedTableChartBuilder将图表类型设置为 TableChart,并返回 EmbeddedTableChartBuilder
build()EmbeddedChart构建图表以反映对其做出的所有更改。
clearRanges()EmbeddedChartBuilder从此构建器修改的图表中移除所有范围。
getChartType()ChartType返回当前的图表类型。
getContainer()ContainerInfo返回图表 ContainerInfo,其中封装了图表在工作表上的显示位置。
getRanges()Range[]返回当前为此图表提供数据的范围列表的副本。
removeRange(range)EmbeddedChartBuilder从此构建器修改的图表中移除指定范围。
reverseCategories()EmbeddedAreaChartBuilder反转域轴上的序列绘制。
setBackgroundColor(cssValue)EmbeddedAreaChartBuilder设置图表的背景颜色。
setChartType(type)EmbeddedChartBuilder更改图表类型。
setColors(cssValues)EmbeddedAreaChartBuilder设置图表中线条的颜色。
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilder设置用于隐藏的行和列的策略。
setLegendPosition(position)EmbeddedAreaChartBuilder设置图例相对于图表的位置。
setLegendTextStyle(textStyle)EmbeddedAreaChartBuilder设置图表图例的文本样式。
setMergeStrategy(mergeStrategy)EmbeddedChartBuilder设置当存在多个范围时要使用的合并策略。
setNumHeaders(headers)EmbeddedChartBuilder设置范围应被视为标题的行数或列数。
setOption(option, value)EmbeddedChartBuilder设置此图表的高级选项。
setPointStyle(style)EmbeddedAreaChartBuilder设置线条中点的样式。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilder设置位置,更改图表在工作表中的显示位置。
setRange(start, end)EmbeddedAreaChartBuilder设置图表的范围。
setStacked()EmbeddedAreaChartBuilder使用堆叠的线条,表示线条值和条形值会堆叠(累积)。
setTitle(chartTitle)EmbeddedAreaChartBuilder设置图表的标题。
setTitleTextStyle(textStyle)EmbeddedAreaChartBuilder设置图表标题的文本样式。
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilder设置是否转置图表的行和列。
setXAxisTextStyle(textStyle)EmbeddedAreaChartBuilder设置横轴文本样式。
setXAxisTitle(title)EmbeddedAreaChartBuilder向横轴添加标题。
setXAxisTitleTextStyle(textStyle)EmbeddedAreaChartBuilder设置横轴标题文本样式。
setYAxisTextStyle(textStyle)EmbeddedAreaChartBuilder设置纵轴文本样式。
setYAxisTitle(title)EmbeddedAreaChartBuilder为纵轴添加标题。
setYAxisTitleTextStyle(textStyle)EmbeddedAreaChartBuilder设置纵轴标题文本样式。
useLogScale()EmbeddedAreaChartBuilder将范围轴设为对数刻度(要求所有值均为正数)。

EmbeddedBarChartBuilder

方法

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

EmbeddedChart

方法

方法返回类型简介
asDataSourceChart()DataSourceChart如果图表是数据源图表,则转换为数据源图表实例,否则转换为 null
getAs(contentType)Blob返回此对象内的数据,并将其作为 blob 转换为指定内容类型。
getBlob()Blob以 blob 的形式返回此对象内的数据。
getChartId()Integer返回图表的稳定标识符,该标识符在包含该图表的电子表格中是唯一的;如果该图表不在电子表格中,则返回 null
getContainerInfo()ContainerInfo返回有关图表在工作表中的位置的信息。
getHiddenDimensionStrategy()ChartHiddenDimensionStrategy返回用于处理隐藏行和列的策略。
getMergeStrategy()ChartMergeStrategy返回多个范围时所使用的合并策略。
getNumHeaders()Integer返回范围内被视为标题的行数或列数。
getOptions()ChartOptions返回此图表的选项,例如高度、颜色和轴。
getRanges()Range[]返回此图表用作数据源的范围。
getTransposeRowsAndColumns()Boolean如果为 true,则系统会切换用于填充图表的行和列。
modify()EmbeddedChartBuilder返回可用于修改此图表的 EmbeddedChartBuilder

EmbeddedChartBuilder

方法

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

EmbeddedColumnChartBuilder

方法

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

EmbeddedComboChartBuilder

方法

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

EmbeddedHistogramChartBuilder

方法

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

EmbeddedLineChartBuilder

方法

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

EmbeddedPieChartBuilder

方法

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

EmbeddedScatterChartBuilder

方法

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

EmbeddedTableChartBuilder

方法

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

Filter

方法

方法返回类型简介
getColumnFilterCriteria(columnPosition)FilterCriteria获取指定列的过滤条件,如果列未应用过滤条件,则为 null
getRange()Range获取此过滤条件适用的范围。
remove()void移除此过滤条件。
removeColumnFilterCriteria(columnPosition)Filter从指定列中移除过滤条件。
setColumnFilterCriteria(columnPosition, filterCriteria)Filter设置指定列的过滤条件。
sort(columnPosition, ascending)Filter按指定列对过滤范围进行排序,但排除此过滤条件所适用的范围的第一行(标题行)。

FilterCriteria

方法

方法返回类型简介
copy()FilterCriteriaBuilder复制此过滤条件并创建可应用于其他过滤条件的条件构建器。
getCriteriaType()BooleanCriteria返回条件的布尔值类型,例如 CELL_EMPTY
getCriteriaValues()Object[]返回布尔值条件的参数数组。
getHiddenValues()String[]返回过滤条件隐藏的值。
getVisibleBackgroundColor()Color返回用作过滤条件的背景颜色。
getVisibleForegroundColor()Color返回用作过滤条件的前景颜色。
getVisibleValues()String[]返回数据透视表过滤器显示的值。

FilterCriteriaBuilder

方法

方法返回类型简介
build()FilterCriteria使用您添加到条件构建工具的设置来汇集过滤条件。
copy()FilterCriteriaBuilder复制此过滤条件并创建可应用于其他过滤条件的条件构建器。
getCriteriaType()BooleanCriteria返回条件的布尔值类型,例如 CELL_EMPTY
getCriteriaValues()Object[]返回布尔值条件的参数数组。
getHiddenValues()String[]返回过滤条件隐藏的值。
getVisibleBackgroundColor()Color返回用作过滤条件的背景颜色。
getVisibleForegroundColor()Color返回用作过滤条件的前景颜色。
getVisibleValues()String[]返回数据透视表过滤器显示的值。
setHiddenValues(values)FilterCriteriaBuilder设置要隐藏的值。
setVisibleBackgroundColor(visibleBackgroundColor)FilterCriteriaBuilder设置用作过滤条件的背景颜色。
setVisibleForegroundColor(visibleForegroundColor)FilterCriteriaBuilder设置用作过滤条件的前景颜色。
setVisibleValues(values)FilterCriteriaBuilder设置要在数据透视表上显示的值。
whenCellEmpty()FilterCriteriaBuilder设置过滤条件以显示空单元格。
whenCellNotEmpty()FilterCriteriaBuilder设置过滤条件,以显示非空单元格。
whenDateAfter(date)FilterCriteriaBuilder设置过滤条件,以显示日期在指定日期之后的单元格。
whenDateAfter(date)FilterCriteriaBuilder设置过滤条件,以显示日期晚于指定相对日期的单元格。
whenDateBefore(date)FilterCriteriaBuilder设置过滤条件,以显示日期早于指定日期的单元格。
whenDateBefore(date)FilterCriteriaBuilder设置过滤条件,以显示日期早于指定相对日期的单元格。
whenDateEqualTo(date)FilterCriteriaBuilder设置过滤条件,以显示日期等于指定日期的单元格。
whenDateEqualTo(date)FilterCriteriaBuilder设置过滤条件,以显示日期与指定相对日期相同的单元格。
whenDateEqualToAny(dates)FilterCriteriaBuilder设置过滤条件,以显示日期等于任何指定日期的单元格。
whenDateNotEqualTo(date)FilterCriteriaBuilder设置过滤条件,以显示与指定日期不同的单元格。
whenDateNotEqualToAny(dates)FilterCriteriaBuilder设置过滤条件,以显示日期不等于任何指定日期的单元格。
whenFormulaSatisfied(formula)FilterCriteriaBuilder设置过滤条件,以显示包含指定公式(例如 =B:B<C:C)且求值为 true 的单元格。
whenNumberBetween(start, end)FilterCriteriaBuilder设置过滤条件,以显示所含数字介于 2 个或 2 个指定数字中的单元格。
whenNumberEqualTo(number)FilterCriteriaBuilder设置过滤条件,以显示数字等于指定数字的单元格。
whenNumberEqualToAny(numbers)FilterCriteriaBuilder设置过滤条件,以显示数字等于任何指定数字的单元格。
whenNumberGreaterThan(number)FilterCriteriaBuilder将过滤条件设置为显示数字大于指定数字的单元格
whenNumberGreaterThanOrEqualTo(number)FilterCriteriaBuilder设置过滤条件,以显示数字大于或等于指定值的单元格。
whenNumberLessThan(number)FilterCriteriaBuilder将过滤条件设置为显示数字小于指定数字的单元格。
whenNumberLessThanOrEqualTo(number)FilterCriteriaBuilder设置过滤条件,以显示数字小于或等于指定值的单元格。
whenNumberNotBetween(start, end)FilterCriteriaBuilder将过滤条件设置为显示符合以下条件的单元格:包含不在 2 个指定数字之间、也不在 2 个指定数字之间的单元格。
whenNumberNotEqualTo(number)FilterCriteriaBuilder设置过滤条件,以显示数字不等于指定数字的单元格。
whenNumberNotEqualToAny(numbers)FilterCriteriaBuilder设置过滤条件,以显示数字不等于任何指定数字的单元格。
whenTextContains(text)FilterCriteriaBuilder设置过滤条件,以显示所含文本包含指定文本的单元格。
whenTextDoesNotContain(text)FilterCriteriaBuilder设置过滤条件,以显示所含文本不包含指定文本的单元格。
whenTextEndsWith(text)FilterCriteriaBuilder将过滤条件设置为显示文本以指定文本结尾的单元格。
whenTextEqualTo(text)FilterCriteriaBuilder设置过滤条件,以显示文本与指定文本相等的单元格。
whenTextEqualToAny(texts)FilterCriteriaBuilder将过滤条件设置为显示文本等于任何指定文本值的单元格。
whenTextNotEqualTo(text)FilterCriteriaBuilder将过滤条件设置为显示文本不等于指定文本的单元格。
whenTextNotEqualToAny(texts)FilterCriteriaBuilder将过滤条件设置为显示文本不等于任何指定值的单元格。
whenTextStartsWith(text)FilterCriteriaBuilder设置过滤条件,以显示所含文本以指定文本开头的单元格。
withCriteria(criteria, args)FilterCriteriaBuilder将过滤条件设置为由 BooleanCriteria 值定义的布尔条件,如 CELL_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)PivotGroupoppositeGroupValues 中的值的指定 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设置字体系列,例如“bigquery”或“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为使用此 RTF 值的值初始化的富文本值返回构建器。
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返回 RangeList 集合,该集合表示通过非空 A1 表示法或 R1C1 表示法指定的同一工作表中指定的范围。
getRowGroup(rowIndex, groupDepth)Group返回具有指定索引和组深度的行组。
getRowGroupControlPosition()GroupControlTogglePosition返回工作表中所有行组的 GroupControlTogglePosition
getRowGroupDepth(rowIndex)Integer返回行位于指定索引处的组深度。
getRowHeight(rowPosition)Integer获取指定行的高度(以像素为单位)。
getSelection()Selection返回电子表格中的当前 Selection
getSheetId()Integer返回此对象代表的工作表的 ID。
getSheetName()String返回工作表名称。
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]返回此范围值从指定坐标开始的矩形网格。
getSlicers()Slicer[]返回工作表上的截剪器数组。
getTabColorObject()Color获取工作表标签页颜色,如果工作表标签页没有颜色,则返回 null
getType()SheetType返回工作表的类型。
hasHiddenGridlines()Boolean如果工作表的网格线处于隐藏状态,则返回 true;否则返回 false
hideColumn(column)void隐藏指定范围内的一列或多列。
hideColumns(columnIndex)void隐藏位于指定索引的单个列。
hideColumns(columnIndex, numColumns)void隐藏从指定索引开始的一个或多个连续列。
hideRow(row)void隐藏给定范围内的行。
hideRows(rowIndex)void隐藏位于指定索引的行。
hideRows(rowIndex, numRows)void隐藏从指定索引开始的一行或多行连续行。
hideSheet()Sheet隐藏此工作表。
insertChart(chart)void向此工作表中添加新图表。
insertColumnAfter(afterPosition)Sheet在指定列位置之后插入一列。
insertColumnBefore(beforePosition)Sheet在指定列位置之前插入一列。
insertColumns(columnIndex)void在工作表中的指定位置插入空白列。
insertColumns(columnIndex, numColumns)void在工作表中从指定位置开始插入一个或多个连续的空白列。
insertColumnsAfter(afterPosition, howMany)Sheet在指定列位置之后插入指定数量的列。
insertColumnsBefore(beforePosition, howMany)Sheet在指定列位置之前插入多个列。
insertImage(blobSource, column, row)OverGridImage在文档的指定行和列处插入 BlobSource 作为图片。
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImage在文档中的指定行和列处插入 BlobSource 作为图像,并偏移像素。
insertImage(url, column, row)OverGridImage在文档中的给定行和列处插入图片。
insertImage(url, column, row, offsetX, offsetY)OverGridImage在文档中的指定行和列处插入图片(偏移像素)。
insertRowAfter(afterPosition)Sheet在指定行位置之后插入一行。
insertRowBefore(beforePosition)Sheet在指定行位置前插入一行。
insertRows(rowIndex)void在工作表中的指定位置插入空白行。
insertRows(rowIndex, numRows)void在工作表中从指定位置开始插入一个或多个连续空白行。
insertRowsAfter(afterPosition, howMany)Sheet在给定行位置之后插入一定数量的行。
insertRowsBefore(beforePosition, howMany)Sheet在给定行位置之前插入若干行。
insertSlicer(range, anchorRowPos, anchorColPos)Slicer向此工作表添加新的截剪器。
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)Slicer向此工作表添加新的截剪器。
isColumnHiddenByUser(columnPosition)Boolean返回用户是否隐藏指定列。
isRightToLeft()Boolean如果此工作表布局为从右到左,则返回 true
isRowHiddenByFilter(rowPosition)Boolean返回给定行是否被过滤器(而不是过滤视图)隐藏。
isRowHiddenByUser(rowPosition)Boolean返回用户是否隐藏了指定行。
isSheetHidden()Boolean如果工作表当前处于隐藏状态,则返回 true
moveColumns(columnSpec, destinationIndex)void将给定范围选择的列移到 destinationIndex 指示的位置。
moveRows(rowSpec, destinationIndex)void将给定范围选择的行移动到 destinationIndex 指示的位置。
newChart()EmbeddedChartBuilder返回构建器为此工作表创建新图表。
protect()Protection创建一个对象,该对象可以防止工作表被拥有的用户修改。
removeChart(chart)void从父工作表中移除图表。
setActiveRange(range)Range将指定范围设为活动工作表中的 active range,并将范围左上角的单元格设为 current cell
setActiveRangeList(rangeList)RangeList将指定的范围列表设为有效工作表中的 active ranges
setActiveSelection(range)Range设置此工作表的有效选择区域。
setActiveSelection(a1Notation)Range按照 A1 或 R1C1 表示法指定有效的选择。
setColumnGroupControlPosition(position)Sheet设置列组控件在工作表中的位置。
setColumnWidth(columnPosition, width)Sheet设置指定列的宽度(以像素为单位)。
setColumnWidths(startColumn, numColumns, width)Sheet设置指定列的宽度(以像素为单位)。
setConditionalFormatRules(rules)void将工作表中当前的所有现有条件格式规则替换为输入规则。
setCurrentCell(cell)Range将指定单元格设置为 current cell
setFrozenColumns(columns)void冻结指定数量的列。
setFrozenRows(rows)void冻结指定的行数。
setHiddenGridlines(hideGridlines)Sheet隐藏或显示工作表网格线。
setName(name)Sheet设置工作表名称。
setRightToLeft(rightToLeft)Sheet将工作表布局设为从右到左。
setRowGroupControlPosition(position)Sheet设置行组控件开关在工作表中的位置。
setRowHeight(rowPosition, height)Sheet设置指定行的行高(以像素为单位)。
setRowHeights(startRow, numRows, height)Sheet设置指定行的高度(以像素为单位)。
setRowHeightsForced(startRow, numRows, height)Sheet设置指定行的高度(以像素为单位)。
setTabColor(color)Sheet设置工作表标签颜色。
setTabColorObject(color)Sheet设置工作表标签颜色。
showColumns(columnIndex)void取消隐藏位于指定索引的列。
showColumns(columnIndex, numColumns)void取消隐藏从指定索引开始的一个或多个连续列。
showRows(rowIndex)void取消隐藏位于指定索引的行。
showRows(rowIndex, numRows)void取消隐藏从指定索引开始的一行或多行连续行。
showSheet()Sheet显示工作表。
sort(columnPosition)Sheet按列对工作表进行升序排序。
sort(columnPosition, ascending)Sheet按列对工作表进行排序。
unhideColumn(column)void取消隐藏给定范围内的列。
unhideRow(row)void取消隐藏给定范围内的行。
updateChart(chart)void更新此工作表中的图表。

SheetType

属性

媒体资源类型说明
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返回 RangeList 集合,该集合表示通过非空 A1 表示法或 R1C1 表示法指定的同一工作表中指定的范围。
getRecalculationInterval()RecalculationInterval返回此电子表格的计算间隔。
getRowHeight(rowPosition)Integer获取指定行的高度(以像素为单位)。
getSelection()Selection返回电子表格中的当前 Selection
getSheetByName(name)Sheet返回具有指定名称的工作表。
getSheetId()Integer返回此对象代表的工作表的 ID。
getSheetName()String返回工作表名称。
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]返回此范围值从指定坐标开始的矩形网格。
getSheets()Sheet[]获取此电子表格中的所有工作表。
getSpreadsheetLocale()String获取电子表格语言区域。
getSpreadsheetTheme()SpreadsheetTheme返回电子表格的当前主题背景;如果未应用任何主题背景,则返回 null
getSpreadsheetTimeZone()String获取电子表格的时区。
getUrl()String返回指定电子表格的网址。
getViewers()User[]获取此 Spreadsheet 的查看者和评论者列表。
hideColumn(column)void隐藏指定范围内的一列或多列。
hideRow(row)void隐藏给定范围内的行。
insertColumnAfter(afterPosition)Sheet在指定列位置之后插入一列。
insertColumnBefore(beforePosition)Sheet在指定列位置之前插入一列。
insertColumnsAfter(afterPosition, howMany)Sheet在指定列位置之后插入指定数量的列。
insertColumnsBefore(beforePosition, howMany)Sheet在指定列位置之前插入多个列。
insertDataSourceSheet(spec)DataSourceSheet在电子表格中插入新的 DataSourceSheet 并开始执行数据。
insertImage(blobSource, column, row)OverGridImage在文档的指定行和列处插入 Spreadsheet 作为图片。
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImage在文档中的指定行和列处插入 Spreadsheet 作为图像,并偏移像素。
insertImage(url, column, row)OverGridImage在文档中的给定行和列处插入图片。
insertImage(url, column, row, offsetX, offsetY)OverGridImage在文档中的指定行和列处插入图片(偏移像素)。
insertRowAfter(afterPosition)Sheet在指定行位置之后插入一行。
insertRowBefore(beforePosition)Sheet在指定行位置前插入一行。
insertRowsAfter(afterPosition, howMany)Sheet在给定行位置之后插入一定数量的行。
insertRowsBefore(beforePosition, howMany)Sheet在给定行位置之前插入若干行。
insertSheet()Sheet使用默认的工作表名称在电子表格中插入新的工作表。
insertSheet(sheetIndex)Sheet在电子表格中的指定索引处插入新工作表。
insertSheet(sheetIndex, options)Sheet将新工作表插入电子表格中的指定索引处,并使用可选的高级参数。
insertSheet(options)Sheet使用默认工作表名称和可选高级参数将新工作表插入电子表格。
insertSheet(sheetName)Sheet在电子表格中插入具有指定名称的新工作表。
insertSheet(sheetName, sheetIndex)Sheet在指定索引处以给定名称向电子表格插入新工作表。
insertSheet(sheetName, sheetIndex, options)Sheet将给定索引处具有指定名称的新工作表插入电子表格,并使用可选的高级参数。
insertSheet(sheetName, options)Sheet将具有指定名称的新工作表插入电子表格,并使用可选的高级参数。
insertSheetWithDataSourceTable(spec)Sheet在电子表格中插入新工作表,根据给定数据源规范创建跨越整个工作表的 DataSourceTable,然后开始执行数据。
isColumnHiddenByUser(columnPosition)Boolean返回用户是否隐藏指定列。
isIterativeCalculationEnabled()Boolean返回此电子表格中是否激活了迭代计算。
isRowHiddenByFilter(rowPosition)Boolean返回给定行是否被过滤器(而不是过滤视图)隐藏。
isRowHiddenByUser(rowPosition)Boolean返回用户是否隐藏了指定行。
moveActiveSheet(pos)void将当前使用的工作表移到工作表列表中的指定位置。
moveChartToObjectSheet(chart)Sheet创建一个新的 SheetType.OBJECT 工作表,并将提供的图表移动到该工作表中。
refreshAllDataSources()void刷新所有受支持的数据源及其关联的数据源对象,跳过无效的数据源对象。
removeEditor(emailAddress)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枚举可能的主题颜色类型。
ValueTypeValueTypeRange.getValue()Range.getValues() 从电子表格服务的 Range 类中返回的值类型的枚举。
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设置文本字体系列,例如“bigquery”。
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长度超过单元格宽度的裁剪线条。