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



3057
3058
3059
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3057

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:



3025
3026
3027
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3025

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:



3055
3056
3057
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3055

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:



3035
3036
3037
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3035

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:



3050
3051
3052
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3050

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:



3020
3021
3022
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3020

def data
  @data
end

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

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

Returns:



3040
3041
3042
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3040

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:



3008
3009
3010
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3008

def merges
  @merges
end

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

Properties of a sheet. Corresponds to the JSON property properties

Returns:



3030
3031
3032
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3030

def properties
  @properties
end

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

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

Returns:



3045
3046
3047
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3045

def protected_ranges
  @protected_ranges
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3062

def update!(**args)
  @merges = args[:merges] if args.key?(:merges)
  @data = args[:data] if args.key?(:data)
  @banded_ranges = args[:banded_ranges] if args.key?(:banded_ranges)
  @properties = args[:properties] if args.key?(:properties)
  @charts = args[:charts] if args.key?(:charts)
  @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)
  @basic_filter = args[:basic_filter] if args.key?(:basic_filter)
end