Class: Google::Apis::SheetsV4::UpdateBordersRequest

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

Updates the borders of a range. If a field is not set in the request, that means the border remains as-is. For example, with two subsequent UpdateBordersRequest:

  1. range: A1:A5 top: RED, bottom: WHITE
  2. range: A1:A5 left: BLUE That would result in A1:A5 having a borders of top: RED, bottom: WHITE, left: BLUE. If you want to clear a border, explicitly set the style to NONE.

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

Returns a new instance of UpdateBordersRequest



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

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

Instance Attribute Details

#bottom ⇒ Google::Apis::SheetsV4::Border

A border along a cell. Corresponds to the JSON property bottom

Returns:



7720
7721
7722
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7720

def bottom
  @bottom
end

#inner_horizontal ⇒ Google::Apis::SheetsV4::Border

A border along a cell. Corresponds to the JSON property innerHorizontal

Returns:



7725
7726
7727
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7725

def inner_horizontal
  @inner_horizontal
end

#inner_vertical ⇒ Google::Apis::SheetsV4::Border

A border along a cell. Corresponds to the JSON property innerVertical

Returns:



7730
7731
7732
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7730

def inner_vertical
  @inner_vertical
end

#left ⇒ Google::Apis::SheetsV4::Border

A border along a cell. Corresponds to the JSON property left

Returns:



7735
7736
7737
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7735

def left
  @left
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:



7761
7762
7763
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7761

def range
  @range
end

#right ⇒ Google::Apis::SheetsV4::Border

A border along a cell. Corresponds to the JSON property right

Returns:



7766
7767
7768
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7766

def right
  @right
end

#top ⇒ Google::Apis::SheetsV4::Border

A border along a cell. Corresponds to the JSON property top

Returns:



7771
7772
7773
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7771

def top
  @top
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7778
7779
7780
7781
7782
7783
7784
7785
7786
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7778

def update!(**args)
  @bottom = args[:bottom] if args.key?(:bottom)
  @inner_horizontal = args[:inner_horizontal] if args.key?(:inner_horizontal)
  @inner_vertical = args[:inner_vertical] if args.key?(:inner_vertical)
  @left = args[:left] if args.key?(:left)
  @range = args[:range] if args.key?(:range)
  @right = args[:right] if args.key?(:right)
  @top = args[:top] if args.key?(:top)
end