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



1662
1663
1664
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1662

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:



1635
1636
1637
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1635

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:



1613
1614
1615
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1613

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:



1645
1646
1647
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1645

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:



1655
1656
1657
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1655

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:



1630
1631
1632
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1630

def data
  @data
end

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

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

Returns:



1650
1651
1652
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1650

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:



1618
1619
1620
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1618

def merges
  @merges
end

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

Properties of a sheet. Corresponds to the JSON property properties

Returns:



1640
1641
1642
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1640

def properties
  @properties
end

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

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

Returns:



1660
1661
1662
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1660

def protected_ranges
  @protected_ranges
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1667

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