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



7099
7100
7101
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7099

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:



7072
7073
7074
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7072

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:



7050
7051
7052
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7050

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:



7077
7078
7079
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7077

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:



7097
7098
7099
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7097

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:



7067
7068
7069
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7067

def data
  @data
end

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

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

Returns:



7087
7088
7089
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7087

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:



7055
7056
7057
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7055

def merges
  @merges
end

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

Properties of a sheet. Corresponds to the JSON property properties

Returns:



7082
7083
7084
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7082

def properties
  @properties
end

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

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

Returns:



7092
7093
7094
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7092

def protected_ranges
  @protected_ranges
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7104

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