Class: Google::Apis::SheetsV4::Sheet

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/sheets_v4/classes.rb,
lib/google/apis/sheets_v4/representations.rb,
lib/google/apis/sheets_v4/representations.rb

Overview

A sheet in a spreadsheet.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Sheet

Returns a new instance of Sheet.



8921
8922
8923
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8921

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:



8850
8851
8852
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8850

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:



8855
8856
8857
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8855

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:



8860
8861
8862
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8860

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:



8866
8867
8868
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8866

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:



8871
8872
8873
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8871

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). For a DATA_SOURCE sheet, you can not request a specific range, the GridData contains all the values. Corresponds to the JSON property data

Returns:



8883
8884
8885
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8883

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:



8888
8889
8890
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8888

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:



8893
8894
8895
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8893

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:



8898
8899
8900
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8898

def merges
  @merges
end

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

Properties of a sheet. Corresponds to the JSON property properties

Returns:



8903
8904
8905
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8903

def properties
  @properties
end

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

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

Returns:



8908
8909
8910
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8908

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:



8914
8915
8916
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8914

def row_groups
  @row_groups
end

#slicers ⇒ Array<Google::Apis::SheetsV4::Slicer>

The slicers on this sheet. Corresponds to the JSON property slicers

Returns:



8919
8920
8921
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8919

def slicers
  @slicers
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8926

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)
  @slicers = args[:slicers] if args.key?(:slicers)
end