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

Constructor Details

#initialize(**args) ⇒ Sheet

Returns a new instance of Sheet.



8732
8733
8734
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8732

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:



8661
8662
8663
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8661

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:



8666
8667
8668
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8666

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:



8671
8672
8673
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8671

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:



8677
8678
8679
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8677

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:



8682
8683
8684
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8682

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:



8694
8695
8696
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8694

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:



8699
8700
8701
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8699

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:



8704
8705
8706
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8704

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:



8709
8710
8711
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8709

def merges
  @merges
end

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

Properties of a sheet. Corresponds to the JSON property properties

Returns:



8714
8715
8716
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8714

def properties
  @properties
end

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

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

Returns:



8719
8720
8721
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8719

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:



8725
8726
8727
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8725

def row_groups
  @row_groups
end

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

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

Returns:



8730
8731
8732
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8730

def slicers
  @slicers
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 8737

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