Class: Google::Apis::SheetsV4::Sheet

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

Overview

A sheet in a spreadsheet.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Sheet

Returns a new instance of Sheet.



9181
9182
9183
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 9181

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

Instance Attribute Details

#banded_ranges ⇒ Array<Google::Apis::SheetsV4::BandedRange>

The banded (alternating colors) ranges on this sheet. Corresponds to the JSON property bandedRanges

Returns:



9105
9106
9107
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 9105

def banded_ranges
  @banded_ranges
end

#basic_filter ⇒ Google::Apis::SheetsV4::BasicFilter

The default filter associated with a sheet. Corresponds to the JSON property basicFilter

Returns:



9110
9111
9112
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 9110

def basic_filter
  @basic_filter
end

#charts ⇒ Array<Google::Apis::SheetsV4::EmbeddedChart>

The specifications of every chart on this sheet. Corresponds to the JSON property charts

Returns:



9115
9116
9117
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 9115

def charts
  @charts
end

#column_groups ⇒ Array<Google::Apis::SheetsV4::DimensionGroup>

All column groups on this sheet, ordered by increasing range start index, then by group depth. Corresponds to the JSON property columnGroups

Returns:



9121
9122
9123
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 9121

def column_groups
  @column_groups
end

#conditional_formats ⇒ Array<Google::Apis::SheetsV4::ConditionalFormatRule>

The conditional format rules in this sheet. Corresponds to the JSON property conditionalFormats

Returns:



9126
9127
9128
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 9126

def conditional_formats
  @conditional_formats
end

#data ⇒ Array<Google::Apis::SheetsV4::GridData>

Data in the grid, if this is a grid sheet. The number of GridData objects returned is dependent on the number of ranges requested on this sheet. For example, if this is representing Sheet1, and the spreadsheet was requested with ranges Sheet1!A1:C10 and Sheet1!D15:E20, then the first GridData will have a startRow/startColumn of 0, while the second one will have startRow 14 (zero-based row 15), and startColumn 3 (zero-based column D). For a DATA_SOURCE sheet, you can not request a specific range, the GridData contains all the values. Corresponds to the JSON property data

Returns:



9138
9139
9140
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 9138

def data
  @data
end

#developer_metadata ⇒ Array<Google::Apis::SheetsV4::DeveloperMetadata>

The developer metadata associated with a sheet. Corresponds to the JSON property developerMetadata

Returns:



9143
9144
9145
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 9143

def developer_metadata
  @developer_metadata
end

#filter_views ⇒ Array<Google::Apis::SheetsV4::FilterView>

The filter views in this sheet. Corresponds to the JSON property filterViews

Returns:



9148
9149
9150
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 9148

def filter_views
  @filter_views
end

#merges ⇒ Array<Google::Apis::SheetsV4::GridRange>

The ranges that are merged together. Corresponds to the JSON property merges

Returns:



9153
9154
9155
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 9153

def merges
  @merges
end

#properties ⇒ Google::Apis::SheetsV4::SheetProperties

Properties of a sheet. Corresponds to the JSON property properties

Returns:



9158
9159
9160
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 9158

def properties
  @properties
end

#protected_ranges ⇒ Array<Google::Apis::SheetsV4::ProtectedRange>

The protected ranges in this sheet. Corresponds to the JSON property protectedRanges

Returns:



9163
9164
9165
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 9163

def protected_ranges
  @protected_ranges
end

#row_groups ⇒ Array<Google::Apis::SheetsV4::DimensionGroup>

All row groups on this sheet, ordered by increasing range start index, then by group depth. Corresponds to the JSON property rowGroups

Returns:



9169
9170
9171
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 9169

def row_groups
  @row_groups
end

#slicers ⇒ Array<Google::Apis::SheetsV4::Slicer>

The slicers on this sheet. Corresponds to the JSON property slicers

Returns:



9174
9175
9176
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 9174

def slicers
  @slicers
end

#tables ⇒ Array<Google::Apis::SheetsV4::Table>

The tables on this sheet. Corresponds to the JSON property tables

Returns:



9179
9180
9181
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 9179

def tables
  @tables
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 9186

def update!(**args)
  @banded_ranges = args[:banded_ranges] if args.key?(:banded_ranges)
  @basic_filter = args[:basic_filter] if args.key?(:basic_filter)
  @charts = args[:charts] if args.key?(:charts)
  @column_groups = args[:column_groups] if args.key?(:column_groups)
  @conditional_formats = args[:conditional_formats] if args.key?(:conditional_formats)
  @data = args[:data] if args.key?(:data)
  @developer_metadata = args[:developer_metadata] if args.key?(:developer_metadata)
  @filter_views = args[:filter_views] if args.key?(:filter_views)
  @merges = args[:merges] if args.key?(:merges)
  @properties = args[:properties] if args.key?(:properties)
  @protected_ranges = args[:protected_ranges] if args.key?(:protected_ranges)
  @row_groups = args[:row_groups] if args.key?(:row_groups)
  @slicers = args[:slicers] if args.key?(:slicers)
  @tables = args[:tables] if args.key?(:tables)
end