此服务允许脚本创建、访问和修改 Google 表格文件。另请参阅在电子表格中存储数据的指南。
有时,电子表格操作会捆绑在一起以提高性能,例如在多次调用某个方法时。如果您想确保所有待处理的更改立即生效,例如在脚本执行时向用户显示信息,请调用 Spreadsheet。
类
AutoFillSeries
属性
| 属性 | 类型 | 说明 |
|---|---|---|
DEFAULT_SERIES | Enum | 默认。 |
ALTERNATE_SERIES | Enum | 如果使用此设置进行自动填充,则扩展范围内的空白单元格将填充现有值的副本。 |
Banding
方法
BandingTheme
属性
| 属性 | 类型 | 说明 |
|---|---|---|
LIGHT_GREY | Enum | 浅灰色条纹主题。 |
CYAN | Enum | 青色条带主题。 |
GREEN | Enum | 绿色条纹主题。 |
YELLOW | Enum | 黄色条带主题。 |
ORANGE | Enum | 橙色条带主题。 |
BLUE | Enum | 蓝色条纹主题。 |
TEAL | Enum | 蓝绿色条纹主题。 |
GREY | Enum | 灰色条纹主题。 |
BROWN | Enum | 一种棕色条纹主题。 |
LIGHT_GREEN | Enum | 浅绿色条纹主题。 |
INDIGO | Enum | 靛蓝条带主题。 |
PINK | Enum | 粉色条纹主题。 |
BigQueryDataSourceSpec
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
copy() | Data | 根据相应数据源的设置创建 Data。 |
get | String | 获取 BigQuery 数据集 ID。 |
get | Data | 获取数据源的参数。 |
get | String | 获取结算项目 ID。 |
get | String | 获取原始查询字符串。 |
get | String | 获取 BigQuery 表 ID。 |
get | String | 获取表的 BigQuery 项目 ID。 |
get | Data | 获取数据源的类型。 |
BigQueryDataSourceSpecBuilder
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
build() | Data | 根据此构建器中的设置构建数据源规范。 |
copy() | Data | 根据相应数据源的设置创建 Data。 |
get | String | 获取 BigQuery 数据集 ID。 |
get | Data | 获取数据源的参数。 |
get | String | 获取结算项目 ID。 |
get | String | 获取原始查询字符串。 |
get | String | 获取 BigQuery 表 ID。 |
get | String | 获取表的 BigQuery 项目 ID。 |
get | Data | 获取数据源的类型。 |
remove | Big | 移除所有参数。 |
remove | Big | 移除指定的参数。 |
set | Big | 设置 BigQuery 数据集 ID。 |
set | Big | 添加一个参数;如果具有相应名称的参数已存在,则更新其数据源规范构建器(类型为 Data)的源单元格。 |
set | Big | 设置结算 BigQuery 项目 ID。 |
set | Big | 设置原始查询字符串。 |
set | Big | 设置 BigQuery 表 ID。 |
set | Big | 为表设置 BigQuery 项目 ID。 |
BooleanCondition
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Color|null | 获取相应布尔值条件的背景颜色。 |
get | Boolean|null | 如果此布尔值条件使文本加粗,则返回 true;如果此布尔值条件使文本不加粗,则返回 false。 |
get | Boolean | 获取规则的条件类型,如 Boolean 枚举中所定义。 |
get | Object[] | 获取规则条件的一组实参。 |
get | Color|null | 获取相应布尔值条件的字体颜色。 |
get | Boolean|null | 如果此布尔值条件使文本变为斜体,则返回 true;如果此布尔值条件从文本中移除斜体,则返回 false。 |
get | Boolean|null | 如果此布尔值条件为文本添加删除线,则返回 true;如果此布尔值条件从文本中移除删除线,则返回 false。 |
get | Boolean|null | 如果此布尔值条件为文本添加下划线,则返回 true;如果此布尔值条件从文本中移除下划线,则返回 false。 |
BooleanCriteria
属性
| 属性 | 类型 | 说明 |
|---|---|---|
CELL_EMPTY | Enum | 当单元格为空时,即满足条件。 |
CELL_NOT_EMPTY | Enum | 当单元格不为空时,即满足条件。 |
DATE_AFTER | Enum | 当日期晚于指定值时,即满足条件。 |
DATE_BEFORE | Enum | 当日期早于指定值时,即满足条件。 |
DATE_EQUAL_TO | Enum | 当日期等于指定值时,即满足条件。 |
DATE_NOT_EQUAL_TO | Enum | 当日期不等于指定值时,即满足条件。 |
DATE_AFTER_RELATIVE | Enum | 当日期晚于相对日期值时,即满足条件。 |
DATE_BEFORE_RELATIVE | Enum | 当日期早于相对日期值时,即满足相应条件。 |
DATE_EQUAL_TO_RELATIVE | Enum | 当日期等于相对日期值时,即满足相应条件。 |
NUMBER_BETWEEN | Enum | 当某个数字介于指定值之间时,即满足相应条件。 |
NUMBER_EQUAL_TO | Enum | 当某个数字等于指定值时,即满足条件。 |
NUMBER_GREATER_THAN | Enum | 当某个数字大于给定值时,即满足相应条件。 |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | 当某个数字大于或等于指定值时,即满足相应条件。 |
NUMBER_LESS_THAN | Enum | 当某个数字小于给定值时,即满足相应条件。 |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | 当某个数字小于或等于指定值时,即满足相应条件。 |
NUMBER_NOT_BETWEEN | Enum | 当数字不在指定值之间时,即满足相应条件。 |
NUMBER_NOT_EQUAL_TO | Enum | 当数字不等于指定值时,即满足条件。 |
TEXT_CONTAINS | Enum | 当输入包含给定值时,即满足条件。 |
TEXT_DOES_NOT_CONTAIN | Enum | 当输入不包含给定值时,即满足条件。 |
TEXT_EQUAL_TO | Enum | 当输入等于指定值时,即满足条件。 |
TEXT_NOT_EQUAL_TO | Enum | 当输入不等于给定值时,即满足条件。 |
TEXT_STARTS_WITH | Enum | 当输入内容以指定值开头时,即满足条件。 |
TEXT_ENDS_WITH | Enum | 当输入内容以指定值结尾时,即满足条件。 |
CUSTOM_FORMULA | Enum | 当输入使给定公式的评估结果为 true 时,即满足相应条件。 |
BorderStyle
属性
| 属性 | 类型 | 说明 |
|---|---|---|
DOTTED | Enum | 虚线边框。 |
DASHED | Enum | 虚线边框。 |
SOLID | Enum | 细实线边框。 |
SOLID_MEDIUM | Enum | 中等粗细的实线边框。 |
SOLID_THICK | Enum | 粗实线边框。 |
DOUBLE | Enum | 两条实线边框。 |
CellImage
属性
| 属性 | 类型 | 说明 |
|---|---|---|
value | Value | 单元格图片的值类型,即 Value。 |
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | String | 返回相应图片的替代文本说明。 |
get | String | 返回相应图片的替代文本标题。 |
get | String | 返回 Google 托管的图片网址。 |
to | Cell | 根据当前图片属性创建单元格图片构建器。 |
CellImageBuilder
属性
| 属性 | 类型 | 说明 |
|---|---|---|
value | Value | 单元格图片的值类型,即 Value。 |
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
build() | Cell | 创建将图片添加到单元格所需的图片值类型。 |
get | String | 返回相应图片的替代文本说明。 |
get | String | 返回相应图片的替代文本标题。 |
get | String | 返回 Google 托管的图片网址。 |
set | Cell | 为相应图片设置替代文本说明。 |
set | Cell | 为相应图片设置替代文本标题。 |
set | Cell | 设置图片来源网址。 |
to | Cell | 根据当前图片属性创建单元格图片构建器。 |
Color
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
as | Rgb | 将此颜色转换为 Rgb。 |
as | Theme | 将此颜色转换为 Theme。 |
get | Color | 获取相应颜色的类型。 |
ColorBuilder
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
as | Rgb | 将此颜色转换为 Rgb。 |
as | Theme | 将此颜色转换为 Theme。 |
build() | Color | 根据提供给构建器的设置创建颜色对象。 |
get | Color | 获取相应颜色的类型。 |
set | Color | 设置为 RGB 颜色。 |
set | Color | 设置为主题颜色。 |
ConditionalFormatRule
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
copy() | Conditional | 返回包含相应规则设置的规则构建器预设。 |
get | Boolean | 如果相应规则使用布尔值条件标准,则检索该规则的 Boolean 信息。 |
get | Gradient | 如果相应规则使用梯度条件标准,则检索该规则的 Gradient 信息。 |
get | Range[] | 检索应用相应条件格式规则的范围。 |
ConditionalFormatRuleBuilder
方法
ContainerInfo
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Integer | 图表的左侧固定在此列中。 |
get | Integer | 图表的顶部固定在此行中。 |
get | Integer | 图表的左上角与锚定列之间的偏移像素数。 |
get | Integer | 图表的左上角与锚定行的偏移像素数。 |
CopyPasteType
属性
| 属性 | 类型 | 说明 |
|---|---|---|
PASTE_NORMAL | Enum | 粘贴值、公式、格式和合并。 |
PASTE_NO_BORDERS | Enum | 粘贴值、公式、格式和合并,但不粘贴边框。 |
PASTE_FORMAT | Enum | 仅粘贴格式。 |
PASTE_FORMULA | Enum | 仅粘贴公式。 |
PASTE_DATA_VALIDATION | Enum | 仅粘贴数据验证。 |
PASTE_VALUES | Enum | 仅粘贴值,不包含格式、公式或合并。 |
PASTE_CONDITIONAL_FORMATTING | Enum | 仅粘贴颜色规则。 |
PASTE_COLUMN_WIDTHS | Enum | 仅粘贴列宽。 |
DataExecutionErrorCode
属性
| 属性 | 类型 | 说明 |
|---|---|---|
DATA_EXECUTION_ERROR_CODE_UNSUPPORTED | Enum | Apps 脚本中不支持的数据执行错误代码。 |
NONE | Enum | 数据执行没有错误。 |
TIME_OUT | Enum | 数据执行超时。 |
TOO_MANY_ROWS | Enum | 数据执行返回的行数超出了限制。 |
TOO_MANY_COLUMNS | Enum | 数据执行结果返回的列数超过了上限。 |
TOO_MANY_CELLS | Enum | 数据执行结果返回的单元格数量超出了上限。 |
ENGINE | Enum | 数据执行引擎错误。 |
PARAMETER_INVALID | Enum | 数据执行参数无效。 |
UNSUPPORTED_DATA_TYPE | Enum | 数据执行结果返回了不受支持的数据类型。 |
DUPLICATE_COLUMN_NAMES | Enum | 数据执行结果返回了重复的列名称。 |
INTERRUPTED | Enum | 数据执行中断。 |
OTHER | Enum | 其他错误。 |
TOO_MANY_CHARS_PER_CELL | Enum | 数据执行结果返回的值超出了单个单元格中允许的最大字符数。 |
DATA_NOT_FOUND | Enum | 找不到数据源引用的数据库。 |
PERMISSION_DENIED | Enum | 用户无权访问数据源引用的数据库。 |
DataExecutionState
属性
| 属性 | 类型 | 说明 |
|---|---|---|
DATA_EXECUTION_STATE_UNSUPPORTED | Enum | Apps 脚本中不支持数据执行状态。 |
RUNNING | Enum | 数据执行已开始并正在运行。 |
SUCCESS | Enum | 数据执行已完成并成功。 |
ERROR | Enum | 数据执行已完成,但有错误。 |
NOT_STARTED | Enum | 数据执行尚未开始。 |
DataExecutionStatus
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Data | 获取数据执行的错误代码。 |
get | String | 获取数据执行的错误消息。 |
get | Data | 获取数据执行的状态。 |
get | Date|null | 获取上次数据执行完成的时间,无论执行状态如何。 |
get | Date|null | 获取数据上次成功刷新的时间。 |
is | Boolean | 如果上次成功执行的数据被截断,则返回 true;否则,返回 false。 |
DataSource
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
cancel | void | 取消与此数据源相关联的数据源对象的所有当前正在运行的刷新。 |
create | Data | 创建计算列。 |
create | Data | 根据相应数据源在新的工作表的第一个单元格中创建数据源透视表。 |
create | Data | 在新工作表的第一个单元格中,根据相应数据源创建数据源表。 |
get | Data | 返回数据源中与列名称匹配的计算列。 |
get | Data | 返回数据源中的所有计算列。 |
get | Data | 返回数据源中的所有列。 |
get | Data | 返回与相应数据源关联的数据源工作表。 |
get | Data | 获取数据源规范。 |
refresh | void | 刷新与数据源关联的所有数据源对象。 |
update | Data | 更新数据源规范,并使用新规范刷新与此数据源相关联的数据源对象。 |
update | Data | 更新数据源规范,并使用新规范刷新关联的 data
source sheets。 |
wait | void | 等待关联数据源对象的所有当前执行完成,并在指定秒数后超时。 |
DataSourceChart
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
cancel | Data | 取消与此对象关联的数据刷新(如果当前正在运行)。 |
force | Data | 刷新此对象的数据,无论当前状态如何。 |
get | Data | 获取对象所关联的数据源。 |
get | Data | 获取对象的数据执行状态。 |
refresh | Data | 刷新对象的数据。 |
wait | Data | 等待当前执行完成,并在指定秒数后超时。 |
DataSourceColumn
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Data | 获取与数据源列关联的数据源。 |
get | String | 获取数据源列的公式。 |
get | String | 获取数据源列的名称。 |
has | Boolean | 返回相应列是否具有数组依赖项。 |
is | Boolean | 返回相应列是否为计算列。 |
remove() | void | 移除数据源列。 |
set | Data | 为数据源列设置公式。 |
set | Data | 设置数据源列的名称。 |
DataSourceFormula
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
cancel | Data | 取消与此对象关联的数据刷新(如果当前正在运行)。 |
force | Data | 刷新此对象的数据,无论当前状态如何。 |
get | Range | 返回表示此数据源公式所锚定的单元格的 Range。 |
get | Data | 获取对象所关联的数据源。 |
get | String | 返回数据源公式的显示值。 |
get | String | 返回相应数据源公式的公式。 |
get | Data | 获取对象的数据执行状态。 |
refresh | Data | 刷新对象的数据。 |
set | Data | 更新公式。 |
wait | Data | 等待当前执行完成,并在指定秒数后超时。 |
DataSourceParameter
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | String | 获取参数名称。 |
get | String|null | 获取形参所基于的源单元格,如果形参类型不是 Data,则返回 null。 |
get | Data | 获取参数类型。 |
DataSourceParameterType
属性
| 属性 | 类型 | 说明 |
|---|---|---|
DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTED | Enum | Apps 脚本中不支持的数据源参数类型。 |
CELL | Enum | 数据源参数的值基于某个单元格。 |
DataSourcePivotTable
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
add | Pivot | 根据指定的数据源列添加新的透视列组。 |
add | Pivot | 根据指定的数据源列和指定的过滤条件添加新过滤条件。 |
add | Pivot | 根据指定的数据源列添加新的透视值,而不使用任何汇总函数。 |
add | Pivot | 根据指定的数据源列和指定的汇总函数添加新的透视值。 |
add | Pivot | 根据指定的数据源列添加新的透视行组。 |
as | Pivot | 以常规数据透视表对象的形式返回数据源数据透视表。 |
cancel | Data | 取消与此对象关联的数据刷新(如果当前正在运行)。 |
force | Data | 刷新此对象的数据,无论当前状态如何。 |
get | Data | 获取对象所关联的数据源。 |
get | Data | 获取对象的数据执行状态。 |
refresh | Data | 刷新对象的数据。 |
wait | Data | 等待当前执行完成,并在指定秒数后超时。 |
DataSourceRefreshSchedule
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Data | 获取刷新计划频率,用于指定刷新频率和时间。 |
get | Data | 获取相应刷新计划的范围。 |
get | Time | 获取相应刷新时间表的下一次运行的时间窗口。 |
is | Boolean | 确定相应刷新时间表是否已启用。 |
DataSourceRefreshScheduleFrequency
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Integer[] | 获取以数字 (1-28) 表示的刷新数据源的月份日期。 |
get | Weekday[] | 获取刷新数据源的星期几。 |
get | Frequency | 获取频次类型。 |
get | Integer | 获取刷新时间表运行的时间间隔的开始小时(以 0-23 之间的数字表示)。 |
DataSourceRefreshScope
属性
| 属性 | 类型 | 说明 |
|---|---|---|
DATA_SOURCE_REFRESH_SCOPE_UNSUPPORTED | Enum | 不支持数据源刷新范围。 |
ALL_DATA_SOURCES | Enum | 刷新操作会应用于电子表格中的所有数据源。 |
DataSourceSheet
方法
DataSourceSheetFilter
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Data | 返回相应过滤条件所应用到的数据源列。 |
get | Data | 返回相应过滤条件所属的 Data。 |
get | Filter | 返回相应过滤器的过滤条件。 |
remove() | void | 从数据源对象中移除相应过滤条件。 |
set | Data | 为此过滤器设置过滤条件。 |
DataSourceSpec
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
as | Big | 获取 BigQuery 数据源的规范。 |
as | Looker | 获取 Looker 数据源的规范。 |
copy() | Data | 根据相应数据源的设置创建 Data。 |
get | Data | 获取数据源的参数。 |
get | Data | 获取数据源的类型。 |
DataSourceSpecBuilder
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
as | Big | 获取 BigQuery 数据源的构建器。 |
as | Looker | 获取 Looker 数据源的构建器。 |
build() | Data | 根据此构建器中的设置构建数据源规范。 |
copy() | Data | 根据相应数据源的设置创建 Data。 |
get | Data | 获取数据源的参数。 |
get | Data | 获取数据源的类型。 |
remove | Data | 移除所有参数。 |
remove | Data | 移除指定的参数。 |
set | Data | 添加一个参数;如果具有相应名称的参数已存在,则更新其数据源规范构建器(类型为 Data)的源单元格。 |
DataSourceTable
方法
DataSourceTableColumn
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Data | 获取数据源列。 |
remove() | void | 从 Data 中移除列。 |
DataSourceTableFilter
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Data | 返回相应过滤条件所应用到的数据源列。 |
get | Data | 返回相应过滤条件所属的 Data。 |
get | Filter | 返回相应过滤器的过滤条件。 |
remove() | void | 从数据源对象中移除相应过滤条件。 |
set | Data | 为此过滤器设置过滤条件。 |
DataSourceType
属性
| 属性 | 类型 | 说明 |
|---|---|---|
DATA_SOURCE_TYPE_UNSUPPORTED | Enum | Apps 脚本中不支持的数据源类型。 |
BIGQUERY | Enum | BigQuery 数据源。 |
LOOKER | Enum | Looker 数据源。 |
DataValidation
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
copy() | Data | 根据相应规则的设置,为数据验证规则创建构建器。 |
get | Boolean | 如果规则在输入未能通过数据验证时显示警告,则返回 true;如果规则完全拒绝输入,则返回 false。 |
get | Data | 获取规则的条件类型,如 Data 枚举中所定义。 |
get | Object[] | 获取规则条件的一组实参。 |
get | String | 获取规则的帮助文本,如果没有设置帮助文本,则返回 null。 |
DataValidationBuilder
方法
DataValidationCriteria
属性
| 属性 | 类型 | 说明 |
|---|---|---|
DATE_AFTER | Enum | 需要一个晚于指定值的日期。 |
DATE_BEFORE | Enum | 需要一个早于指定值的日期。 |
DATE_BETWEEN | Enum | 需要介于指定值之间的日期。 |
DATE_EQUAL_TO | Enum | 需要一个等于给定值的日期。 |
DATE_IS_VALID_DATE | Enum | 需要提供日期。 |
DATE_NOT_BETWEEN | Enum | 要求日期不在指定值之间。 |
DATE_ON_OR_AFTER | Enum | 要求日期不早于指定值。 |
DATE_ON_OR_BEFORE | Enum | 需要不晚于指定值的日期。 |
NUMBER_BETWEEN | Enum | 需要一个介于给定值之间的数字。 |
NUMBER_EQUAL_TO | Enum | 需要一个等于给定值的数字。 |
NUMBER_GREATER_THAN | Enum | 要求提供大于指定值的数字。 |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | 需要一个大于或等于给定值的数字。 |
NUMBER_LESS_THAN | Enum | 需要一个小于给定值的数字。 |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | 需要一个小于或等于给定值的数字。 |
NUMBER_NOT_BETWEEN | Enum | 需要一个不在指定值之间的数字。 |
NUMBER_NOT_EQUAL_TO | Enum | 需要一个不等于指定值的数字。 |
TEXT_CONTAINS | Enum | 要求输入包含指定值。 |
TEXT_DOES_NOT_CONTAIN | Enum | 要求输入不包含指定值。 |
TEXT_EQUAL_TO | Enum | 要求输入等于指定值。 |
TEXT_IS_VALID_EMAIL | Enum | 要求输入采用电子邮件地址的格式。 |
TEXT_IS_VALID_URL | Enum | 要求输入内容采用网址格式。 |
VALUE_IN_LIST | Enum | 要求输入等于指定值之一。 |
VALUE_IN_RANGE | Enum | 要求输入等于指定范围内的某个值。 |
CUSTOM_FORMULA | Enum | 要求输入使给定公式的计算结果为 true。 |
CHECKBOX | Enum | 要求输入为自定义值或布尔值;呈现为复选框。 |
DATE_AFTER_RELATIVE | Enum | 需要一个晚于相对日期值的时间。 |
DATE_BEFORE_RELATIVE | Enum | 要求使用早于相对日期的日期。 |
DATE_EQUAL_TO_RELATIVE | Enum | 需要一个与相对日期值相等的日期。 |
DateTimeGroupingRule
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Date | 获取日期时间分组规则的类型。 |
DateTimeGroupingRuleType
属性
| 属性 | 类型 | 说明 |
|---|---|---|
UNSUPPORTED | Enum | 不支持的日期时间分组规则类型。 |
SECOND | Enum | 按秒(从 0 到 59)对日期时间进行分组。 |
MINUTE | Enum | 按分钟(从 0 到 59)对日期时间进行分组。 |
HOUR | Enum | 使用 24 小时制(从 0 到 23)按小时对日期时间进行分组。 |
HOUR_MINUTE | Enum | 使用 24 小时制按小时和分钟对日期时间进行分组,例如 19:45。 |
HOUR_MINUTE_AMPM | Enum | 使用 12 小时制按小时和分钟对日期时间进行分组,例如 7:45 PM。 |
DAY_OF_WEEK | Enum | 按周几对日期时间进行分组,例如 Sunday。 |
DAY_OF_YEAR | Enum | 按一年中的某天(从 1 到 366)对日期时间进行分组。 |
DAY_OF_MONTH | Enum | 按日期(从 1 到 31)对日期时间进行分组。 |
DAY_MONTH | Enum | 按天和月对日期时间进行分组,例如 22-Nov。 |
MONTH | Enum | 按月对日期时间进行分组,例如 Nov。 |
QUARTER | Enum | 按季度对日期时间进行分组,例如第 1 季度(表示 1 月至 3 月)。 |
YEAR | Enum | 按年份对日期时间进行分组,例如 2008 年。 |
YEAR_MONTH | Enum | 按年和月对日期时间进行分组,例如 2008-Nov。 |
YEAR_QUARTER | Enum | 按年和季度对日期时间进行分组,例如 2008 Q4。 |
YEAR_MONTH_DAY | Enum | 按年、月和日对日期时间进行分组,例如 2008-11-22。 |
DeveloperMetadata
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Integer | 返回与此开发者元数据相关联的唯一 ID。 |
get | String | 返回与此开发者元数据关联的键。 |
get | Developer | 返回相应开发者元数据的位置。 |
get | String | 返回与此开发者元数据关联的值;如果此元数据没有值,则返回 null。 |
get | Developer | 返回此开发者元数据的可见性。 |
move | Developer | 将此开发者元数据移至指定列。 |
move | Developer | 将此开发者元数据移动到指定的行。 |
move | Developer | 将此开发者元数据移动到指定的工作表中。 |
move | Developer | 将此开发者元数据移至顶级电子表格。 |
remove() | void | 删除相应元数据。 |
set | Developer | 将相应开发者元数据的键设置为指定值。 |
set | Developer | 将与此开发者元数据关联的值设置为指定值。 |
set | Developer | 将相应开发者元数据的公开范围设置为指定公开范围。 |
DeveloperMetadataFinder
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
find() | Developer | 执行此搜索并返回匹配的元数据。 |
on | Developer | 配置搜索以考虑具有元数据的相交位置。 |
with | Developer | 将此搜索限制为仅考虑与指定 ID 匹配的元数据。 |
with | Developer | 将此搜索限制为仅考虑与指定键匹配的元数据。 |
with | Developer | 将此搜索限制为仅考虑与指定位置类型匹配的元数据。 |
with | Developer | 将此搜索限制为仅考虑与指定值匹配的元数据。 |
with | Developer | 将此搜索限制为仅考虑与指定可见性匹配的元数据。 |
DeveloperMetadataLocation
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Range|null | 返回相应元数据列位置的 Range;如果位置类型不是 Developer,则返回 null。 |
get | Developer | 获取位置类型。 |
get | Range|null | 返回相应元数据行位置的 Range,如果位置类型不是 Developer,则返回 null。 |
get | Sheet|null | 返回相应元数据的 Sheet 位置,如果位置类型不是 Developer,则返回 null。 |
get | Spreadsheet|null | 返回相应元数据的 Spreadsheet 位置,如果位置类型不是 Developer,则返回 null。 |
DeveloperMetadataLocationType
属性
| 属性 | 类型 | 说明 |
|---|---|---|
SPREADSHEET | Enum | 与顶级电子表格关联的开发者元数据的位置类型。 |
SHEET | Enum | 与整个工作表关联的开发者元数据的位置类型。 |
ROW | Enum | 与行关联的开发者元数据的位置类型。 |
COLUMN | Enum | 与列关联的开发者元数据的位置类型。 |
DeveloperMetadataVisibility
属性
| 属性 | 类型 | 说明 |
|---|---|---|
DOCUMENT | Enum | 任何有权访问相应文档的开发者项目都可以访问文档可见的元数据。 |
PROJECT | Enum | 项目可见的元数据仅对创建该元数据的开发者项目可见,并且只能由该项目访问。 |
Dimension
属性
| 属性 | 类型 | 说明 |
|---|---|---|
COLUMNS | Enum | 列(纵向)维度。 |
ROWS | Enum | 行(水平)维度。 |
Direction
属性
| 属性 | 类型 | 说明 |
|---|---|---|
UP | Enum | 行索引递减的方向。 |
DOWN | Enum | 行指数递增的方向。 |
PREVIOUS | Enum | 列索引递减的方向。 |
NEXT | Enum | 列索引递增的方向。 |
Drawing
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Container | 获取有关图纸中绘图位置的信息。 |
get | Integer | 返回相应绘制对象的实际高度(以像素为单位)。 |
get | String|null | 返回附加到相应绘图的宏的名称。 |
get | Sheet | 返回此绘图所在的工作表。 |
get | Integer | 返回相应绘制对象的实际宽度(以像素为单位)。 |
get | Number | 返回相应绘图的 Z-index。 |
remove() | void | 从电子表格中删除相应绘图。 |
set | Drawing | 以像素为单位设置此绘图的实际高度。 |
set | Drawing | 将宏函数分配给此绘图。 |
set | Drawing | 设置绘图在工作表上的显示位置。 |
set | Drawing | 以像素为单位设置此绘制的实际宽度。 |
set | Drawing | 设置此绘图的 Z-index。 |
EmbeddedAreaChartBuilder
方法
EmbeddedBarChartBuilder
方法
EmbeddedChart
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
as | Data | 如果图表是数据源图表,则强制转换为数据源图表实例;否则为 null。 |
get | Blob | 以转换为指定内容类型的 blob 形式返回此对象内的数据。 |
get | Blob | 以 blob 形式返回此对象内的数据。 |
get | Integer|null | 返回图表的稳定标识符,该标识符在包含图表的电子表格中是唯一的;如果图表不在电子表格中,则返回 null。 |
get | Container | 返回有关图表在工作表中的位置的信息。 |
get | Chart | 返回用于处理隐藏行和列的策略。 |
get | Chart | 返回存在多个范围时使用的合并策略。 |
get | Integer | 返回被视为标题的范围的行数或列数。 |
get | Chart | 返回相应图表的选项,例如高度、颜色和轴。 |
get | Range[] | 返回相应图表用作数据源的范围。 |
get | Boolean | 如果值为 true,则用于填充图表的行和列会进行切换。 |
modify() | Embedded | 返回可用于修改相应图表的 Embedded。 |
EmbeddedChartBuilder
方法
EmbeddedColumnChartBuilder
方法
EmbeddedComboChartBuilder
方法
EmbeddedHistogramChartBuilder
方法
EmbeddedLineChartBuilder
方法
EmbeddedPieChartBuilder
方法
EmbeddedScatterChartBuilder
方法
EmbeddedTableChartBuilder
方法
Filter
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Filter | 获取指定列的过滤条件,如果该列未应用过滤条件,则返回 null。 |
get | Range | 获取相应过滤条件所适用的范围。 |
remove() | void | 移除相应过滤条件。 |
remove | Filter | 从指定列中移除过滤条件。 |
set | Filter | 为指定列设置过滤条件。 |
sort(columnPosition, ascending) | Filter | 按指定列对过滤后的范围进行排序,但不包括此过滤条件所应用范围内的第一行(标题行)。 |
FilterCriteria
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
copy() | Filter | 复制此过滤条件,并创建一个可应用于其他过滤条件的条件构建器。 |
get | Boolean | 返回相应条件的布尔值类型,例如 CELL_EMPTY。 |
get | Object[] | 返回布尔值条件的一组实参。 |
get | String[] | 返回过滤条件隐藏的值。 |
get | Color|null | 返回用作过滤条件的背景颜色。 |
get | Color|null | 返回用作过滤条件的前景色。 |
get | String[] | 返回透视表过滤器显示的值。 |
FilterCriteriaBuilder
方法
FrequencyType
属性
| 属性 | 类型 | 说明 |
|---|---|---|
FREQUENCY_TYPE_UNSUPPORTED | Enum | 频次类型不受支持。 |
DAILY | Enum | 每天刷新。 |
WEEKLY | Enum | 每周刷新一次,在指定的一周中的某几天刷新。 |
MONTHLY | Enum | 每月在指定日期刷新。 |
GradientCondition
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Color|null | 获取为此梯度条件的最大值设置的颜色。 |
get | Interpolation | 获取相应梯度条件最大值的插值类型。 |
get | String | 获取相应梯度条件的最大值。 |
get | Color|null | 获取为此梯度条件的中间点值设置的颜色。 |
get | Interpolation | 获取相应梯度条件的中间点值的插值类型。 |
get | String | 获取此梯度条件的中间值。 |
get | Color|null | 获取为此梯度条件设置的最小值颜色。 |
get | Interpolation | 获取相应梯度条件的最小值的插值类型。 |
get | String | 获取相应梯度条件的最小值。 |
Group
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
collapse() | Group | 收起此群组。 |
expand() | Group | 展开此群组。 |
get | Integer | 返回相应群组的控制切换开关指数。 |
get | Integer | 返回相应组的深度。 |
get | Range | 返回相应群组存在的时间范围。 |
is | Boolean | 如果相应群组已收起,则返回 true。 |
remove() | void | 从工作表中移除相应群组,从而将 range 的群组深度减少 1。 |
GroupControlTogglePosition
属性
| 属性 | 类型 | 说明 |
|---|---|---|
BEFORE | Enum | 控制切换开关位于群组之前(索引较低)的位置。 |
AFTER | Enum | 控制切换开关在组(位于较高索引处)之后的位置。 |
InterpolationType
属性
| 属性 | 类型 | 说明 |
|---|---|---|
NUMBER | Enum | 将该数字用作梯度条件的特定插值点。 |
PERCENT | Enum | 将该数字用作梯度条件的百分比插值点。 |
PERCENTILE | Enum | 将该数字用作梯度条件的百分位插值点。 |
MIN | Enum | 将最小值推断为梯度条件的特定插值点。 |
MAX | Enum | 将最大数量推断为梯度条件的特定插值点。 |
LookerDataSourceSpec
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
copy() | Data | 根据相应数据源的设置创建 Data。 |
get | String | 获取模型中 Looker 探索的名称。 |
get | String | 获取 Looker 实例的网址。 |
get | String | 获取实例中 Looker 模型的名称。 |
get | Data | 获取数据源的参数。 |
get | Data | 获取数据源的类型。 |
LookerDataSourceSpecBuilder
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
build() | Data | 根据此构建器中的设置构建数据源规范。 |
copy() | Data | 根据相应数据源的设置创建 Data。 |
get | String | 获取模型中 Looker 探索的名称。 |
get | String | 获取 Looker 实例的网址。 |
get | String | 获取实例中 Looker 模型的名称。 |
get | Data | 获取数据源的参数。 |
get | Data | 获取数据源的类型。 |
remove | Looker | 移除所有参数。 |
remove | Looker | 移除指定的参数。 |
set | Looker | 在 Looker 模型中设置探索名称。 |
set | Looker | 设置 Looker 的实例网址。 |
set | Looker | 在 Looker 实例中设置 Looker 模型名称。 |
set | Looker | 添加一个参数;如果具有相应名称的参数已存在,则更新其数据源规范构建器(类型为 Data)的源单元格。 |
NamedRange
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | String | 获取此命名范围的名称。 |
get | Range | 获取相应命名的范围所引用的范围。 |
remove() | void | 删除此命名的范围。 |
set | Named | 设置/更新命名范围的名称。 |
set | Named | 设置/更新相应命名的范围的范围。 |
OverGridImage
方法
PageProtection
PivotFilter
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Filter | 返回相应数据透视过滤器的过滤条件。 |
get | Pivot | 返回相应过滤条件所属的 Pivot。 |
get | Integer | 返回相应过滤条件所处理的源数据列的数量。 |
get | Data | 返回过滤条件所依据的数据源列。 |
remove() | void | 从数据透视表中移除相应的数据透视过滤条件。 |
set | Pivot | 为此透视过滤条件设置过滤条件。 |
PivotGroup
方法
PivotGroupLimit
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Integer | 获取透视组中行或列的数量限制。 |
get | Pivot | 返回相应限制所属的数据透视表元素组。 |
remove() | void | 移除数据透视表元素组限制。 |
set | Pivot | 设置透视组中行或列的数量限制。 |
PivotTable
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
add | Pivot | 根据指定的 formula 和 name,在数据透视表中创建一个新的数据透视值。 |
add | Pivot | 在数据透视表中定义新的透视列分组。 |
add | Pivot | 为数据透视表创建新的数据透视过滤条件。 |
add | Pivot | 在数据透视表中定义具有指定 summarize 的新透视值。 |
add | Pivot | 在数据透视表中定义新的数据透视行分组。 |
as | Data | 如果数据透视表已关联到 Data,则返回数据透视表作为数据源数据透视表;否则返回 null。 |
get | Range | 返回表示此数据透视表所锚定的单元格的 Range。 |
get | Pivot | 返回相应透视表中列组的有序列表。 |
get | Pivot | 返回相应透视表中过滤器的有序列表。 |
get | Pivot | 返回相应数据透视表中数据透视值的有序列表。 |
get | Pivot | 返回相应透视表中行组的有序列表。 |
get | Range | 返回构建数据透视表的源数据范围。 |
get | Dimension | 返回值是显示为行还是列。 |
remove() | void | 删除相应的数据透视表。 |
set | Pivot | 设置相应数据透视表的布局,以将值显示为列或行。 |
PivotTableSummarizeFunction
属性
| 属性 | 类型 | 说明 |
|---|---|---|
CUSTOM | Enum | 自定义函数,此值仅对计算字段有效。 |
SUM | Enum | SUM 函数 |
COUNTA | Enum | COUNTA 函数 |
COUNT | Enum | COUNT 函数 |
COUNTUNIQUE | Enum | COUNTUNIQUE 函数 |
AVERAGE | Enum | AVERAGE 函数 |
MAX | Enum | MAX 函数 |
MIN | Enum | MIN 函数 |
MEDIAN | Enum | MEDIAN 函数 |
PRODUCT | Enum | PRODUCT 函数 |
STDEV | Enum | STDEV 函数 |
STDEVP | Enum | STDEVP 函数 |
VAR | Enum | VAR 函数 |
VARP | Enum | VARP 函数 |
PivotValue
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Pivot | 返回显示类型,用于描述相应透视值当前在表格中的显示方式。 |
get | String | 返回用于计算此值的公式。 |
get | Pivot | 返回相应值所属的 Pivot。 |
get | Integer | 返回数据透视值汇总的源数据列的数量。 |
get | Data | 返回数据透视值汇总的数据源列。 |
get | Pivot | 返回相应组的总结函数。 |
remove() | void | 从透视表中移除此值。 |
set | Pivot | 设置透视表中相应值的显示名称。 |
set | Pivot | 设置用于计算此值的公式。 |
show | Pivot | 在透视表中将此值显示为另一个值的函数。 |
summarize | Pivot | 设置总结函数。 |
PivotValueDisplayType
属性
| 属性 | 类型 | 说明 |
|---|---|---|
DEFAULT | Enum | 默认。 |
PERCENT_OF_ROW_TOTAL | Enum | 以相应行的总计值的百分比形式显示透视值。 |
PERCENT_OF_COLUMN_TOTAL | Enum | 以百分比形式显示透视值,该百分比是透视值占相应列总值的百分比。 |
PERCENT_OF_GRAND_TOTAL | Enum | 以总计的百分比形式显示透视值。 |
Protection
方法
ProtectionType
属性
| 属性 | 类型 | 说明 |
|---|---|---|
RANGE | Enum | 范围保护。 |
SHEET | Enum | 工作表保护。 |
Range
方法
RangeList
方法
RecalculationInterval
属性
| 属性 | 类型 | 说明 |
|---|---|---|
ON_CHANGE | Enum | 仅在值发生变化时重新计算。 |
MINUTE | Enum | 在值发生变化时以及每分钟重新计算一次。 |
HOUR | Enum | 在值发生变化时以及每小时重新计算一次。 |
RelativeDate
属性
| 属性 | 类型 | 说明 |
|---|---|---|
TODAY | Enum | 与当前日期进行比较的日期。 |
TOMORROW | Enum | 与当前日期之后的日期进行比较。 |
YESTERDAY | Enum | 与当前日期之前一天的日期进行比较。 |
PAST_WEEK | Enum | 上周内的日期。 |
PAST_MONTH | Enum | 上个月内的日期。 |
PAST_YEAR | Enum | 过去一年内的日期。 |
RichTextValue
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
copy() | Rich | 返回一个富文本值构建器,该构建器已使用此富文本值的值进行初始化。 |
get | Integer | 获取相应值在单元格中的结束索引。 |
get | String|null | 返回相应值的链接网址。 |
get | String|null | 返回从 start 到 end 的文本的链接网址。 |
get | Rich | 返回拆分为一系列 run 的富文本字符串,其中每个 run 都是具有一致文本样式的最长可能子字符串。 |
get | Integer | 获取相应值在单元格中的起始索引。 |
get | String | 返回相应值的文本。 |
get | Text | 返回相应值的文字样式。 |
get | Text | 返回从 start 到 end 的文本样式。 |
RichTextValueBuilder
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
build() | Rich | 根据此构建器创建富文本值。 |
set | Rich | 为相应子字符串设置链接网址,如果 link 为 null,则清除链接网址。 |
set | Rich | 为整个值设置链接网址,如果 link 为 null,则清除该网址。 |
set | Rich | 为此值设置文本,并清除所有现有文本样式。 |
set | Rich | 将文本样式应用于此值的指定子字符串。 |
set | Rich | 将文本样式应用于整个值。 |
Selection
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Range|null | 返回活动工作表中的所选范围,如果没有活动范围,则返回 null。 |
get | Range | 返回活动工作表中活动范围的列表;如果没有活动范围,则返回 null。 |
get | Sheet | 返回电子表格中的活动工作表。 |
get | Range|null | 返回在某个活动范围内选定的当前(突出显示)单元格;如果没有当前单元格,则返回 null。 |
get | Range|null | 从 current cell和 active range开始,沿指定方向移动,返回一个调整后的范围,其中范围的相应边缘已移动到覆盖 next data cell,同时仍覆盖当前单元格。 |
Sheet
方法
SheetType
属性
| 属性 | 类型 | 说明 |
|---|---|---|
GRID | Enum | 包含网格的工作表。 |
OBJECT | Enum | 包含单个嵌入式对象(例如 Embedded)的工作表。 |
DATASOURCE | Enum | 包含 Data 的工作表。 |
Slicer
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Color|null | 返回切片器的背景 Color。 |
get | Integer|null | 返回切片器中应用过滤条件的列位置(相对于切片器的数据范围),如果未设置列位置,则返回 null。 |
get | Container | 获取有关切片器在工作表中的位置的信息。 |
get | Filter | 返回切片器的过滤条件;如果未设置过滤条件,则返回 null。 |
get | Range | 获取应用切片器的相应数据范围。 |
get | String | 返回切片器的标题。 |
get | String | 获取标题的水平对齐方式。 |
get | Text | 返回切片器标题的文字样式。 |
is | Boolean | 返回指定切片器是否应用于数据透视表。 |
remove() | void | 删除切片器。 |
set | Slicer | 设置指定切片器是否应应用于工作表中的数据透视表。 |
set | Slicer | 设置切片器的背景颜色。 |
set | Slicer | 设置切片器的背景 Color。 |
set | Slicer | 设置切片器的列索引和过滤条件。 |
set | Slicer | 设置切片器在工作表上的显示位置。 |
set | Slicer | 设置应用切片器的数据范围。 |
set | Slicer | 设置切片器的标题。 |
set | Slicer | 设置切片器中标题的水平对齐方式。 |
set | Slicer | 设置切片器的文字样式。 |
SortOrder
属性
| 属性 | 类型 | 说明 |
|---|---|---|
ASCENDING | Enum | 升序排列顺序。 |
DESCENDING | Enum | 降序排序顺序。 |
SortSpec
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Color|null | 返回用于排序的背景颜色,如果不存在,则返回 null。 |
get | Data | 获取排序规范所作用的数据源列。 |
get | Integer|null | 返回维度索引;如果未与本地过滤条件相关联,则返回 null。 |
get | Color|null | 返回用于排序的前景颜色,如果不存在,则返回 null。 |
get | Sort | 返回排序顺序。 |
is | Boolean | 返回排序顺序是否为升序。 |
Spreadsheet
方法
SpreadsheetApp
属性
| 属性 | 类型 | 说明 |
|---|---|---|
Auto | Auto | 用于计算自动填充值的序列类型的枚举。 |
Banding | Banding | 可能出现的条带主题的枚举。 |
Boolean | Boolean | 条件格式布尔值条件的枚举。 |
Border | Border | 用于设置 Range 边框的有效样式的枚举。 |
Color | Color | 可能颜色类型的枚举。 |
Copy | Copy | 可能粘贴类型的枚举。 |
Data | Data | 可能的数据执行错误代码的枚举。 |
Data | Data | 可能的数据执行状态的枚举。 |
Data | Data | 可能的数据源参数类型的枚举。 |
Data | Data | 可能的数据源刷新范围的枚举。 |
Data | Data | 可能的数据源类型的枚举。 |
Data | Data | 一种枚举,表示可针对范围设置的数据验证条件。 |
Date | Date | 日期时间分组规则的枚举。 |
Developer | Developer | 可能存在的开发者元数据位置类型的枚举。 |
Developer | Developer | 一个枚举,包含可能的开发者元数据公开范围。 |
Dimension | Dimension | 一个枚举,包含电子表格的可能维度。 |
Direction | Direction | 一个枚举,用于表示使用箭头键在电子表格中移动时可能采用的方向。 |
Frequency | Frequency | 可能频次类型的枚举。 |
Group | Group | 群组控制切换开关可处于的位置的枚举。 |
Interpolation | Interpolation | 条件格式渐变插值类型的枚举。 |
Pivot | Pivot | 一种枚举,用于表示可用于汇总数据透视表中的值的函数。 |
Pivot | Pivot | 一种枚举,用于表示透视值的显示方式。 |
Protection | Protection | 一种枚举,表示可以防止修改的电子表格部分。 |
Recalculation | Recalculation | 可在电子表格重新计算中使用的可能间隔的枚举。 |
Relative | Relative | 用于计算基于日期的 Boolean 中所用值的相对日期选项的枚举。 |
Sheet | Sheet | 电子表格中可能存在的不同类型的工作表的枚举。 |
Sort | Sort | 一种排序顺序枚举。 |
Text | Text | 有效文本方向的枚举。 |
Text | Text | 用于将文本分列的预设分隔符的枚举。 |
Theme | Theme | 可能的主题颜色类型的枚举。 |
Value | Value | 一种枚举,用于表示电子表格服务的 Range 类中 Range.getValue() 和 Range.getValues() 返回的值类型。 |
Wrap | Wrap | 用于单元格换行的策略的枚举。 |
方法
SpreadsheetTheme
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Color | 针对有效的主题颜色类型返回具体的 Color。 |
get | String|null | 返回主题的字体系列,如果主题为 null,则返回 null。 |
get | Theme | 返回当前主题的所有可能的主题颜色类型的列表。 |
set | Spreadsheet | 将此配色方案中与 Theme 关联的具体颜色设置为指定颜色。 |
set | Spreadsheet | 将此配色方案中与 Theme 关联的具体颜色设置为以 RGB 格式表示的指定颜色。 |
set | Spreadsheet | 为主题设置字体系列。 |
TextDirection
属性
| 属性 | 类型 | 说明 |
|---|---|---|
LEFT_TO_RIGHT | Enum | 从左至右的文字方向。 |
RIGHT_TO_LEFT | Enum | 从右至左的文字方向。 |
TextFinder
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
find | Range[] | 返回符合搜索条件的所有单元格。 |
find | Range | 返回符合搜索条件的下一个单元格。 |
find | Range | 返回符合搜索条件的上一个单元格。 |
get | Range | 返回符合搜索条件的当前单元格。 |
ignore | Text | 如果为 true,则配置搜索以在匹配时忽略变音符号;否则,搜索会匹配变音符号。 |
match | Text | 如果值为 true,则配置搜索以完全匹配搜索文本的大小写;否则,搜索默认采用不区分大小写的匹配。 |
match | Text | 如果值为 true,则将搜索配置为匹配整个单元格内容;否则,搜索默认采用部分匹配。 |
match | Text | 如果值为 true,则配置搜索以返回公式文本中出现的匹配项;否则,系统会根据公式单元格的显示值来考虑这些单元格。 |
replace | Integer | 将所有匹配项替换为指定文本。 |
replace | Integer | 将当前匹配的单元格中的搜索文本替换为指定文本,并返回替换的次数。 |
start | Text | 将搜索配置为在指定单元格范围之后立即开始搜索。 |
use | Text | 如果值为 true,则将搜索配置为将搜索字符串解释为正则表达式;否则,搜索会将搜索字符串解释为普通文本。 |
TextRotation
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Integer | 获取标准文字方向与当前文字方向之间的角度。 |
is | Boolean | 如果文本是竖向堆叠的,则返回 true;否则返回 false。 |
TextStyle
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
copy() | Text | 创建一个文本样式构建器,并使用相应文本样式的值进行初始化。 |
get | String | 获取文本的字体系列。 |
get | Integer | 获取文本的字体大小(以磅为单位)。 |
get | Color|null | 获取文本的字体颜色。 |
is | Boolean | 获取文字是否为粗体。 |
is | Boolean | 获取相应单元格是否为斜体。 |
is | Boolean | 获取相应单元格是否带有删除线。 |
is | Boolean | 获取相应单元格是否带有下划线。 |
TextStyleBuilder
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
build() | Text | 根据此构建器创建文本样式。 |
set | Text | 设置文字是否加粗。 |
set | Text | 设置文本字体系列,例如“Arial”。 |
set | Text | 设置文本字体大小(以磅为单位)。 |
set | Text | 设置文字字体颜色。 |
set | Text | 设置文字字体颜色。 |
set | Text | 设置文字是否为斜体。 |
set | Text | 设置文本是否带有删除线。 |
set | Text | 设置文本是否带有下划线。 |
TextToColumnsDelimiter
属性
| 属性 | 类型 | 说明 |
|---|---|---|
COMMA | Enum | "," 分隔符。 |
SEMICOLON | Enum | ";" 分隔符。 |
PERIOD | Enum | "." 分隔符。 |
SPACE | Enum | " " 分隔符。 |
ThemeColor
方法
| 方法 | 返回类型 | 简介 |
|---|---|---|
get | Color | 获取相应颜色的类型。 |
get | Theme | 获取相应颜色的主题颜色类型。 |
ThemeColorType
属性
| 属性 | 类型 | 说明 |
|---|---|---|
UNSUPPORTED | Enum | 表示不支持的主题颜色。 |
TEXT | Enum | 表示文字颜色。 |
BACKGROUND | Enum | 表示图表背景所用的颜色。 |
ACCENT1 | Enum | 表示第一个强调色。 |
ACCENT2 | Enum | 表示第二种强调色。 |
ACCENT3 | Enum | 表示第三种强调色。 |
ACCENT4 | Enum | 表示第四种强调色。 |
ACCENT5 | Enum | 表示第五种强调色。 |
ACCENT6 | Enum | 表示第六种强调色。 |
HYPERLINK | Enum | 表示要用于超链接的颜色。 |
ValueType
属性
| 属性 | 类型 | 说明 |
|---|---|---|
IMAGE | Enum | 当单元格包含图片时的值类型。 |
WrapStrategy
属性
| 属性 | 类型 | 说明 |
|---|---|---|
WRAP | Enum | 将长于单元格宽度的行换行。 |
OVERFLOW | Enum | 溢出到下一个单元格的行,只要该单元格为空即可。 |
CLIP | Enum | 剪裁长于单元格宽度的行。 |