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.



4427
4428
4429
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4427

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

Instance Attribute Details

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

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

Returns:



4408
4409
4410
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4408

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:



4388
4389
4390
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4388

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:



4398
4399
4400
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4398

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:



4425
4426
4427
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4425

def data
  @data
end

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

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

Returns:



4393
4394
4395
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4393

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:



4413
4414
4415
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4413

def merges
  @merges
end

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

Properties of a sheet. Corresponds to the JSON property properties

Returns:



4383
4384
4385
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4383

def properties
  @properties
end

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

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

Returns:



4403
4404
4405
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4403

def protected_ranges
  @protected_ranges
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4432

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