Class: Google::Apis::SheetsV4::BandedRange

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 banded (alternating colors) range in a sheet.

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) ⇒ BandedRange

Returns a new instance of BandedRange



582
583
584
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 582

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

Instance Attribute Details

#banded_range_id ⇒ Fixnum

The id of the banded range. Corresponds to the JSON property bandedRangeId

Returns:

  • (Fixnum) 


524
525
526
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 524

def banded_range_id
  @banded_range_id
end

#column_properties ⇒ Google::Apis::SheetsV4::BandingProperties

Properties referring a single dimension (either row or column). If both BandedRange.row_properties and BandedRange.column_properties are set, the fill colors are applied to cells according to the following rules:

  • header_color and footer_color take priority over band colors.
  • first_band_color takes priority over second_band_color.
  • row_properties takes priority over column_properties. For example, the first row color takes priority over the first column color, but the first column color takes priority over the second row color. Similarly, the row header takes priority over the column header in the top left cell, but the column header takes priority over the first row color if the row header is not set. Corresponds to the JSON property columnProperties

Returns:



539
540
541
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 539

def column_properties
  @column_properties
end

#range ⇒ Google::Apis::SheetsV4::GridRange

A range on a sheet. All indexes are zero-based. Indexes are half open, e.g the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if "Sheet1" is sheet ID 0, then: Sheet1!A1:A1 == sheet_id: 0, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1 Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2 Sheet1!A:B == sheet_id: 0, start_column_index: 0, end_column_index: 2 Sheet1!A5:B == sheet_id: 0, start_row_index: 4, start_column_index: 0, end_column_index: 2 Sheet1 == sheet_id:0 The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as #REF!. Corresponds to the JSON property range

Returns:



565
566
567
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 565

def range
  @range
end

#row_properties ⇒ Google::Apis::SheetsV4::BandingProperties

Properties referring a single dimension (either row or column). If both BandedRange.row_properties and BandedRange.column_properties are set, the fill colors are applied to cells according to the following rules:

  • header_color and footer_color take priority over band colors.
  • first_band_color takes priority over second_band_color.
  • row_properties takes priority over column_properties. For example, the first row color takes priority over the first column color, but the first column color takes priority over the second row color. Similarly, the row header takes priority over the column header in the top left cell, but the column header takes priority over the first row color if the row header is not set. Corresponds to the JSON property rowProperties

Returns:



580
581
582
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 580

def row_properties
  @row_properties
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



587
588
589
590
591
592
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 587

def update!(**args)
  @banded_range_id = args[:banded_range_id] if args.key?(:banded_range_id)
  @column_properties = args[:column_properties] if args.key?(:column_properties)
  @range = args[:range] if args.key?(:range)
  @row_properties = args[:row_properties] if args.key?(:row_properties)
end