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



7840
7841
7842
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7840

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

Instance Attribute Details

#banded_ranges ⇒ Array<Google::Apis::SheetsV4::BandedRange>

The banded (alternating colors) ranges on this sheet. Corresponds to the JSON property bandedRanges

Returns:



7774
7775
7776
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7774

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:



7779
7780
7781
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7779

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:



7784
7785
7786
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7784

def charts
  @charts
end

#column_groups ⇒ Array<Google::Apis::SheetsV4::DimensionGroup>

All column groups on this sheet, ordered by increasing range start index, then by group depth. Corresponds to the JSON property columnGroups

Returns:



7790
7791
7792
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7790

def column_groups
  @column_groups
end

#conditional_formats ⇒ Array<Google::Apis::SheetsV4::ConditionalFormatRule>

The conditional format rules in this sheet. Corresponds to the JSON property conditionalFormats

Returns:



7795
7796
7797
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7795

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:



7807
7808
7809
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7807

def data
  @data
end

#developer_metadata ⇒ Array<Google::Apis::SheetsV4::DeveloperMetadata>

The developer metadata associated with a sheet. Corresponds to the JSON property developerMetadata

Returns:



7812
7813
7814
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7812

def developer_metadata
  @developer_metadata
end

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

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

Returns:



7817
7818
7819
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7817

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:



7822
7823
7824
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7822

def merges
  @merges
end

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

Properties of a sheet. Corresponds to the JSON property properties

Returns:



7827
7828
7829
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7827

def properties
  @properties
end

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

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

Returns:



7832
7833
7834
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7832

def protected_ranges
  @protected_ranges
end

#row_groups ⇒ Array<Google::Apis::SheetsV4::DimensionGroup>

All row groups on this sheet, ordered by increasing range start index, then by group depth. Corresponds to the JSON property rowGroups

Returns:



7838
7839
7840
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7838

def row_groups
  @row_groups
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7845

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)
  @column_groups = args[:column_groups] if args.key?(:column_groups)
  @conditional_formats = args[:conditional_formats] if args.key?(:conditional_formats)
  @data = args[:data] if args.key?(:data)
  @developer_metadata = args[:developer_metadata] if args.key?(:developer_metadata)
  @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)
  @row_groups = args[:row_groups] if args.key?(:row_groups)
end