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



5446
5447
5448
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5446

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:



5393
5394
5395
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5393

def bottom
  @bottom
end

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

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

Returns:



5434
5435
5436
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5434

def inner_horizontal
  @inner_horizontal
end

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

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

Returns:



5398
5399
5400
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5398

def inner_vertical
  @inner_vertical
end

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

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

Returns:



5444
5445
5446
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5444

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:



5429
5430
5431
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5429

def range
  @range
end

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

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

Returns:



5403
5404
5405
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5403

def right
  @right
end

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

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

Returns:



5439
5440
5441
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5439

def top
  @top
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5451
5452
5453
5454
5455
5456
5457
5458
5459
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 5451

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