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

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 sheet in a spreadsheet.

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) ⇒ Sheet

Returns a new instance of Sheet



7242
7243
7244
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7242

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

Instance Attribute Details

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

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

Returns:



7188
7189
7190
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7188

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:



7193
7194
7195
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7193

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:



7198
7199
7200
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7198

def charts
  @charts
end

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

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

Returns:



7203
7204
7205
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7203

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). Corresponds to the JSON property data

Returns:



7215
7216
7217
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7215

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:



7220
7221
7222
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7220

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:



7225
7226
7227
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7225

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:



7230
7231
7232
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7230

def merges
  @merges
end

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

Properties of a sheet. Corresponds to the JSON property properties

Returns:



7235
7236
7237
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7235

def properties
  @properties
end

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

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

Returns:



7240
7241
7242
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7240

def protected_ranges
  @protected_ranges
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7247

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)
  @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)
end