Class: Google::Apis::SheetsV4::PivotTable

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/sheets_v4/classes.rb,
generated/google/apis/sheets_v4/representations.rb,
generated/google/apis/sheets_v4/representations.rb

Overview

A pivot table.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PivotTable

Returns a new instance of PivotTable.



7166
7167
7168
# File 'generated/google/apis/sheets_v4/classes.rb', line 7166

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#columnsArray<Google::Apis::SheetsV4::PivotGroup>

Each column grouping in the pivot table. Corresponds to the JSON property columns



7104
7105
7106
# File 'generated/google/apis/sheets_v4/classes.rb', line 7104

def columns
  @columns
end

#criteriaHash<String,Google::Apis::SheetsV4::PivotFilterCriteria>

An optional mapping of filters per source column offset. The filters are applied before aggregating data into the pivot table. The map's key is the column offset of the source range that you want to filter, and the value is the criteria for that column. For example, if the source was C10:E15, a key of 0 will have the filter for column C, whereas the key 1 is for column D. Corresponds to the JSON property criteria



7114
7115
7116
# File 'generated/google/apis/sheets_v4/classes.rb', line 7114

def criteria
  @criteria
end

#data_execution_statusGoogle::Apis::SheetsV4::DataExecutionStatus

The data execution status. Corresponds to the JSON property dataExecutionStatus



7119
7120
7121
# File 'generated/google/apis/sheets_v4/classes.rb', line 7119

def data_execution_status
  @data_execution_status
end

#data_source_idString

The ID of the data source the pivot table is reading data from. Corresponds to the JSON property dataSourceId

Returns:

  • (String)


7124
7125
7126
# File 'generated/google/apis/sheets_v4/classes.rb', line 7124

def data_source_id
  @data_source_id
end

#filter_specsArray<Google::Apis::SheetsV4::PivotFilterSpec>

The filters applied to the source columns before aggregating data for the pivot table. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence. Corresponds to the JSON property filterSpecs



7131
7132
7133
# File 'generated/google/apis/sheets_v4/classes.rb', line 7131

def filter_specs
  @filter_specs
end

#rowsArray<Google::Apis::SheetsV4::PivotGroup>

Each row grouping in the pivot table. Corresponds to the JSON property rows



7136
7137
7138
# File 'generated/google/apis/sheets_v4/classes.rb', line 7136

def rows
  @rows
end

#sourceGoogle::Apis::SheetsV4::GridRange

A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if "Sheet1" is sheet ID 0, then: Sheet1!A1:A1 == sheet_id: 0, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1 Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2 Sheet1!A:B == sheet_id: 0, start_column_index: 0, end_column_index: 2 Sheet1!A5:B == sheet_id: 0, start_row_index: 4, start_column_index: 0, end_column_index: 2 Sheet1 == sheet_id:0 The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as # REF!. Corresponds to the JSON property source



7153
7154
7155
# File 'generated/google/apis/sheets_v4/classes.rb', line 7153

def source
  @source
end

#value_layoutString

Whether values should be listed horizontally (as columns) or vertically (as rows). Corresponds to the JSON property valueLayout

Returns:

  • (String)


7159
7160
7161
# File 'generated/google/apis/sheets_v4/classes.rb', line 7159

def value_layout
  @value_layout
end

#valuesArray<Google::Apis::SheetsV4::PivotValue>

A list of values to include in the pivot table. Corresponds to the JSON property values



7164
7165
7166
# File 'generated/google/apis/sheets_v4/classes.rb', line 7164

def values
  @values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
# File 'generated/google/apis/sheets_v4/classes.rb', line 7171

def update!(**args)
  @columns = args[:columns] if args.key?(:columns)
  @criteria = args[:criteria] if args.key?(:criteria)
  @data_execution_status = args[:data_execution_status] if args.key?(:data_execution_status)
  @data_source_id = args[:data_source_id] if args.key?(:data_source_id)
  @filter_specs = args[:filter_specs] if args.key?(:filter_specs)
  @rows = args[:rows] if args.key?(:rows)
  @source = args[:source] if args.key?(:source)
  @value_layout = args[:value_layout] if args.key?(:value_layout)
  @values = args[:values] if args.key?(:values)
end