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.



8929
8930
8931
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8929

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:



8858
8859
8860
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8858

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:



8863
8864
8865
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8863

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:



8868
8869
8870
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8868

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:



8874
8875
8876
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8874

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:



8879
8880
8881
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8879

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:



8891
8892
8893
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8891

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:



8896
8897
8898
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8896

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:



8901
8902
8903
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8901

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:



8906
8907
8908
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8906

def merges
  @merges
end

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

Properties of a sheet. Corresponds to the JSON property properties

Returns:



8911
8912
8913
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8911

def properties
  @properties
end

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

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

Returns:



8916
8917
8918
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8916

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:



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

def row_groups
  @row_groups
end

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

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

Returns:



8927
8928
8929
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8927

def slicers
  @slicers
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 8934

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