工作表
电子表格中的工作表。
JSON 表示法 |
---|
{ "properties": { object ( |
田野 | |
---|---|
properties
|
工作表的属性。 |
data[]
|
网格中的数据(如果是网格工作表)。
返回的 GridData 对象数量取决于此工作表中请求的范围数量。例如,如果它表示
对于
|
merges[]
|
合并在一起的范围。 |
conditionalFormats[]
|
此工作表中的条件格式规则。 |
filterViews[]
|
此工作表中的过滤视图。 |
protectedRanges[]
|
此工作表中受保护的范围。 |
basicFilter
|
此工作表中的过滤器(如果有)。 |
charts[]
|
此工作表中每个图表的规范。 |
bandedRanges[]
|
此工作表中的带状(交替颜色)范围。 |
developerMetadata[]
|
与工作表相关联的开发者元数据。 |
rowGroups[]
|
此工作表中的所有行组,按范围起始索引递增,然后按组深度排序。 |
columnGroups[]
|
此工作表上的所有列组,按范围起始索引递增,然后按组深度排序。 |
slicers[]
|
此工作表上的截剪器。 |
SheetProperties
工作表的属性。
JSON 表示法 |
---|
{ "sheetId": integer, "title": string, "index": integer, "sheetType": enum ( |
田野 | |
---|---|
sheetId
|
工作表的 ID。必须是非负数。此字段一经设置便无法更改。 |
title
|
工作表的名称。 |
index
|
电子表格中工作表的索引。添加或更新工作表属性时,如果排除了此字段,则系统会将相应工作表添加或移动到工作表列表的末尾。更新工作表索引或插入工作表时,系统会在“移动之前”考虑移动操作索引。例如,如果有三个工作表(S1、S2、S3),为了将 S1 移到 S2 之前,则必须将索引设置为 2。如果请求的索引与工作表的当前索引相同,或者请求的新索引等于当前工作表索引 + 1,则系统会忽略工作表索引更新请求。 |
sheetType
|
工作表的类型。默认值为
|
gridProperties
|
工作表的其他属性(如果此工作表为网格)。(如果工作表是包含图表或图片的对象工作表,则此字段不会显示。)在写入时,在非网格工作表上设置任何网格属性会出错。
如果此工作表是
|
tabColor
|
界面中标签页的颜色。已弃用:使用
|
tabColorStyle
|
界面中标签页的颜色。如果
|
rightToLeft
|
如果工作表是 RTL 工作表而不是 LTR 工作表,则为 true。 |
dataSourceSheetProperties
|
仅限输出。如果存在,该字段包含
|
SheetType
工作表的类型。
枚举 | |
---|---|
SHEET_TYPE_UNSPECIFIED
|
默认值,请勿使用。 |
GRID
|
工作表是一个网格。 |
OBJECT
|
工作表中没有网格,而是包含图表或图片等对象。 |
DATA_SOURCE
|
该工作表会与外部
DataSource
并显示数据预览。
|
GridProperties
网格的属性。
JSON 表示法 |
---|
{ "rowCount": integer, "columnCount": integer, "frozenRowCount": integer, "frozenColumnCount": integer, "hideGridlines": boolean, "rowGroupControlAfter": boolean, "columnGroupControlAfter": boolean } |
田野 | |
---|---|
rowCount
|
网格中的行数。 |
columnCount
|
网格中的列数。 |
frozenRowCount
|
网格中冻结的行数。 |
frozenColumnCount
|
网格中的冻结列的数量。 |
hideGridlines
|
如果界面中的网格未显示网格线,则为 true。 |
rowGroupControlAfter
|
如果行分组控件切换开关显示在组后面,则为 true。 |
columnGroupControlAfter
|
如果列分组控件切换开关显示在组后面,则为 true。 |
DataSourceSheetProperties
其他属性
DATA_SOURCE
工作表。
JSON 表示法 |
---|
{ "dataSourceId": string, "columns": [ { object ( |
田野 | |
---|---|
dataSourceId
|
的 ID
|
columns[]
|
工作表上显示的列,与
|
dataExecutionStatus
|
数据执行状态。 |
GridData
网格中的数据,以及有关维度的元数据。
JSON 表示法 |
---|
{ "startRow": integer, "startColumn": integer, "rowData": [ { object ( |
田野 | |
---|---|
startRow
|
此 GridData 引用的第一行,从零开始。 |
startColumn
|
此 GridData 引用的第一列从零开始。 |
rowData[]
|
网格中的数据,每行一个条目,从 startRow 中的行开始。RowData 中的值将与从
|
rowMetadata[]
|
关于网格中请求行的元数据,从该行开始
|
columnMetadata[]
|
有关网格中所请求列的元数据,以
|
RowData
行中每个单元格的相关数据。
JSON 表示法 |
---|
{
"values": [
{
object (
|
田野 | |
---|---|
values[]
|
该行中的值(每列一个)。 |
DimensionProperties
维度的相关属性。
JSON 表示法 |
---|
{ "hiddenByFilter": boolean, "hiddenByUser": boolean, "pixelSize": integer, "developerMetadata": [ { object ( |
田野 | |
---|---|
pixelSize
|
尺寸的高度(如果是行)或宽度(如果是列)(以像素为单位)。 |
developerMetadata[]
|
与单行或单列关联的开发者元数据。 |
dataSourceColumnReference
|
仅限输出。如果已设置,则为数据源工作表中的一列。 |
ConditionalFormatRule
描述条件格式的规则。
JSON 表示法 |
---|
{ "ranges": [ { object ( |
田野 | |
---|---|
ranges[]
|
条件为 true 时采用的格式范围。所有范围必须在同一网格上。 |
联合字段
rule 。控制此条件格式的规则,必须设置一个。
rule
只能是下列其中一项:
|
|
booleanRule
|
格式为“开启”或“关闭”规则。 |
gradientRule
|
格式因规则中的渐变效果而异。 |
BooleanRule
规则可能匹配,也可能不匹配,具体取决于条件。
JSON 表示法 |
---|
{ "condition": { object ( |
田野 | |
---|---|
condition
|
规则的条件。如果条件的计算结果为 true,则应用该格式。 |
format
|
要应用的格式。条件格式只能应用部分格式设置:
|
GradientRule
根据列出的插值点应用渐变色阶格式的规则。单元格的格式会因其内容与插值点的值而有所不同。
JSON 表示法 |
---|
{ "minpoint": { object ( |
田野 | |
---|---|
minpoint
|
起始插值点。 |
midpoint
|
可选的中途插值点。 |
maxpoint
|
最终的插值点。 |
InterpolationPoint
采用渐变条件格式的单个插值点。根据所选的颜色、类型和值,固定渐变色阶。
JSON 表示法 |
---|
{ "color": { object ( |
田野 | |
---|---|
color
|
此插值点应使用的颜色。已弃用:使用
|
colorStyle
|
此插值点应使用的颜色。如果
|
type
|
应如何解读该值。 |
value
|
|
InterpolationPointType
插值点的种类。
枚举 | |
---|---|
INTERPOLATION_POINT_TYPE_UNSPECIFIED
|
默认值,请勿使用。 |
MIN
|
插值点使用条件格式范围内单元格中的最小值。 |
MAX
|
插值点会使用条件格式范围内单元格中的最大值。 |
NUMBER
|
插值点所使用的值与
InterpolationPoint.value 。
|
PERCENT
|
插值点是条件格式范围内所有单元格的指定百分比。这相当于
|
PERCENTILE
|
插值点是条件格式范围内所有单元格的指定百分位。这相当于
NUMBER
如果值为:
=PERCENTILE(FLATTEN(range), value / 100)
(在展平时忽略范围内的误差)。
|
FilterView
过滤视图。
JSON 表示法 |
---|
{ "filterViewId": integer, "title": string, "range": { object ( |
田野 | |
---|---|
filterViewId
|
过滤视图的 ID。 |
title
|
过滤视图的名称。 |
range
|
此过滤视图覆盖的范围。
写入时,只有一个
|
namedRangeId
|
此过滤视图所支持的命名范围(如果有)。
写入时,只有一个
|
sortSpecs[]
|
每列的排序顺序。如果旧规范中的值相等,系统会使用后期规范。 |
criteria
|
显示/隐藏每列值的条件。映射的键是列索引,值是该列的条件。
此字段已弃用,取而代之
|
filterSpecs[]
|
用于显示/隐藏每列值的过滤条件。
两者都有
|
ProtectedRange
受保护的范围。
JSON 表示法 |
---|
{ "protectedRangeId": integer, "range": { object ( |
田野 | |
---|---|
protectedRangeId
|
受保护的范围的 ID。此字段是只读字段。 |
range
|
要保护的范围。范围可以是完全无界限的,在这种情况下,此范围就会被视为受保护的工作表。
写入时,只有一个
|
namedRangeId
|
此受保护范围所支持的命名范围(如果有)。
写入时,只有一个
|
description
|
此受保护范围的说明。 |
warningOnly
|
如果此受保护范围在编辑时显示警告,则为“true”。基于警告的保护意味着所有用户都可以修改受保护范围内的数据,但若修改,系统会发出警告,要求用户确认修改。
写入时:如果此字段为 true,则
|
requestingUserCanEdit
|
如果请求此受保护范围的用户可以修改该受保护区域,则为“true”。此字段是只读字段。 |
unprotectedRanges[]
|
受保护的工作表中不受保护的范围列表。只有受保护的工作表才支持不受保护的范围。 |
editors
|
对受保护范围拥有修改权限的用户和群组。只有对受保护范围和文档拥有编辑权限的用户才能看到此字段。编辑器不支持
|
编辑者
受保护的范围的编辑者。
JSON 表示法 |
---|
{ "users": [ string ], "groups": [ string ], "domainUsersCanEdit": boolean } |
田野 | |
---|---|
users[]
|
对受保护范围拥有编辑权限的用户的电子邮件地址。 |
groups[]
|
对受保护范围拥有编辑权限的群组的电子邮件地址。 |
domainUsersCanEdit
|
如果文档网域中的任何人对受保护范围拥有编辑权限,则为“true”。只有网域内的文档支持网域保护功能。 |
BasicFilter
与工作表相关联的默认过滤器。
JSON 表示法 |
---|
{ "range": { object ( |
田野 | |
---|---|
range
|
过滤器覆盖的范围。 |
sortSpecs[]
|
每列的排序顺序。如果旧规范中的值相等,系统会使用后期规范。 |
criteria
|
显示/隐藏每列值的条件。映射的键是列索引,值是该列的条件。
此字段已弃用,取而代之
|
filterSpecs[]
|
每列的过滤条件。
两者都有
|
BandedRange
工作表中的带状(交替颜色)范围。
JSON 表示法 |
---|
{ "bandedRangeId": integer, "range": { object ( |
田野 | |
---|---|
bandedRangeId
|
带状范围的 ID。 |
range
|
这些属性的应用范围。 |
rowProperties
|
行频段的属性。这些属性会逐行应用于范围中的所有行。至少为以下项之一:
|
columnProperties
|
列频段的属性。这些属性会逐列应用到范围内的所有列中。至少为以下项之一:
|
BandingProperties
引用单个维度(行或列)的属性。如果两者
BandedRange.row_properties
和
BandedRange.column_properties
则填充颜色将根据以下规则应用于单元格:
-
headerColor
和footerColor
优先级高于表带颜色 -
firstBandColor
优先级高于secondBandColor
。 -
rowProperties
优先级高于columnProperties
。
例如,第一行颜色的优先级高于第一列颜色,但第一列的颜色优先于第二行颜色。同样,行标题的优先级高于左上角单元格中的列标题,但如果未设置行标题,列标题的优先级会高于第一行颜色。
JSON 表示法 |
---|
{ "headerColor": { object ( |
田野 | |
---|---|
headerColor
|
第一行或首列的颜色。如果设置了此字段,则第一行或第一列会填充此颜色,并会在
|
headerColorStyle
|
第一行或首列的颜色。如果设置了此字段,则第一行或第一列会填充此颜色,并会在
|
firstBandColor
|
第一种交替的颜色。(必需)已弃用:使用
|
firstBandColorStyle
|
第一种交替的颜色。(必需)如果
|
secondBandColor
|
交替的第二种颜色。(必需)已弃用:使用
|
secondBandColorStyle
|
交替的第二种颜色。(必需)如果
|
footerColor
|
最后一行或最后一列的颜色。如果未设置此字段,则最后一行或最后一列
|
footerColorStyle
|
最后一行或最后一列的颜色。如果未设置此字段,则最后一行或最后一列
|
DimensionGroup
工作表中以行或列为间隔的组,可以包含其他组,也可以包含在其他组中。组可以在工作表中作为一个单元收起或展开。
JSON 表示法 |
---|
{
"range": {
object (
|
田野 | |
---|---|
range
|
此组所在的范围。 |
depth
|
组的深度,表示有多少个组的范围完全包含此组的范围。 |
collapsed
|
如果组处于收起状态,则此字段为 true。如果收起的组在较浅的深度上展开,则收起的组会保持收起状态。 值为 true 并不意味着组内的所有维度都会被隐藏,因为维度的可见性可以独立于组属性发生变化。不过,更新此属性后,如果此字段为 true,则系统会将其中的所有维度设置为隐藏;如果此字段为 false,则会将其设置为可见展示次数。 |
截剪器
工作表中的截剪器。
JSON 表示法 |
---|
{ "slicerId": integer, "spec": { object ( |
田野 | |
---|---|
slicerId
|
截剪器的 ID。 |
spec
|
截剪器的规范。 |
position
|
截剪器的位置。请注意,截剪器只能放置在现有工作表上。此外,截剪器的宽度和高度可以自动调整,使其保持在允许的范围内。 |
SlicerSpec
截剪器的规范。
JSON 表示法 |
---|
{ "dataRange": { object ( |
田野 | |
---|---|
dataRange
|
截剪器的数据范围。 |
filterCriteria
|
截剪器的过滤条件。 |
columnIndex
|
数据表中应用过滤器的列索引(从零开始)。 |
applyToPivotTables
|
如果过滤器应应用于数据透视表,则为 true。如果未设置,则默认为
|
title
|
截剪器的标题。 |
textFormat
|
截剪器中标题的文本格式。不支持链接字段。 |
backgroundColor
|
截剪器的背景颜色。已弃用:使用
|
backgroundColorStyle
|
截剪器的背景颜色。如果
|
horizontalAlignment
|
截剪器中标题的水平对齐方式。如果未指定,则默认为
|