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



6095
6096
6097
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6095

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:



6046
6047
6048
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6046

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:



6051
6052
6053
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6051

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:



6056
6057
6058
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6056

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:



6061
6062
6063
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6061

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:



6073
6074
6075
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6073

def data
  @data
end

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

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

Returns:



6078
6079
6080
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6078

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:



6083
6084
6085
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6083

def merges
  @merges
end

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

Properties of a sheet. Corresponds to the JSON property properties

Returns:



6088
6089
6090
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6088

def properties
  @properties
end

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

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

Returns:



6093
6094
6095
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6093

def protected_ranges
  @protected_ranges
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6100

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