Struct google_sheets4::PivotGroup

pub struct PivotGroup {
    pub show_totals: Option<bool>,
    pub source_column_offset: Option<i32>,
    pub label: Option<String>,
    pub value_metadata: Option<Vec<PivotGroupValueMetadata>>,
    pub value_bucket: Option<PivotGroupSortValueBucket>,
    pub sort_order: Option<String>,
    pub repeat_headings: Option<bool>,
    pub group_rule: Option<PivotGroupRule>,
}

A single grouping (either row or column) in a pivot table.

This type is not used in any activity, and only used as part of another schema.

Fields

show_totals: Option<bool>

True if the pivot table should include the totals for this grouping.

source_column_offset: Option<i32>

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.

label: Option<String>

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 |
+--------------+---------+-------+

value_metadata: Option<Vec<PivotGroupValueMetadata>>

Metadata about values in the grouping.

value_bucket: Option<PivotGroupSortValueBucket>

The bucket of the opposite pivot group to sort by. If not specified, sorting is alphabetical by this group’s values.

sort_order: Option<String>

The order the values in this group should be sorted.

repeat_headings: Option<bool>

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     |
+--------------+

group_rule: Option<PivotGroupRule>

The group rule to apply to this row/column group.

Trait Implementations

impl Clone for PivotGroup

fn clone(&self) -> PivotGroup

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PivotGroup

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PivotGroup

fn default() -> PivotGroup

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PivotGroup

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PivotGroup

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for PivotGroup