Class PivotGroup
A single grouping (either row or column) in a pivot table.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.Sheets.v4.Data
Assembly: Google.Apis.Sheets.v4.dll
Syntax
public class PivotGroup : IDirectResponseSchemaProperties
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
GroupRule
The group rule to apply to this row/column group.
Declaration
[JsonProperty("groupRule")]
public virtual PivotGroupRule GroupRule { get; set; }Property Value
| Type | Description |
|---|---|
| PivotGroupRule |
Label
The labels to use for the row/column groups which can be customized. For example, in the following
pivot table, the row label is Region (which could be renamed to State) and the column label is Product
(which could be renamed Item). Pivot tables created before December 2017 do not have header labels. If
you'd like to add header labels to an existing pivot table, please delete the existing pivot table and then
create a new pivot table with same parameters.
+--------------+---------+-------+ | SUM of Units | Product | | | Region | Pen | Paper | +--------------+---------+-------+ | New York | 345 | 98 | | Oregon | 234 | 123 | | Tennessee | 531 | 415 | +--------------+---------+-------+ | Grand Total | 1110 | 636 | +--------------+---------+-------+
Declaration
[JsonProperty("label")]
public virtual string Label { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
RepeatHeadings
True if the headings in this pivot group should be repeated. This is only valid for row groupings and is ignored by columns.
By default, we minimize repitition of headings by not showing higher level headings where they are the same. For example, even though the third row below corresponds to "Q1 Mar", "Q1" is not shown because it is redundant with previous rows. Setting repeat_headings to true would cause "Q1" to be repeated for "Feb" and "Mar".
+--------------+ | Q1 | Jan | | | Feb | | | Mar | +--------+-----+ | Q1 Total | +--------------+
Declaration
[JsonProperty("repeatHeadings")]
public virtual bool? RepeatHeadings { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
ShowTotals
True if the pivot table should include the totals for this grouping.
Declaration
[JsonProperty("showTotals")]
public virtual bool? ShowTotals { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
SortOrder
The order the values in this group should be sorted.
Declaration
[JsonProperty("sortOrder")]
public virtual string SortOrder { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
SourceColumnOffset
The column offset of the source range that this grouping is based on.
For example, if the source was C10:E15, a sourceColumnOffset of 0 means this group refers to column
C, whereas the offset 1 would refer to column D.
Declaration
[JsonProperty("sourceColumnOffset")]
public virtual int? SourceColumnOffset { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
ValueBucket
The bucket of the opposite pivot group to sort by. If not specified, sorting is alphabetical by this group's values.
Declaration
[JsonProperty("valueBucket")]
public virtual PivotGroupSortValueBucket ValueBucket { get; set; }Property Value
| Type | Description |
|---|---|
| PivotGroupSortValueBucket |
ValueMetadata
Metadata about values in the grouping.
Declaration
[JsonProperty("valueMetadata")]
public virtual IList<PivotGroupValueMetadata> ValueMetadata { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<PivotGroupValueMetadata> |