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



3172
3173
3174
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3172

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:



3119
3120
3121
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3119

def bottom
  @bottom
end

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

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

Returns:



3160
3161
3162
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3160

def inner_horizontal
  @inner_horizontal
end

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

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

Returns:



3124
3125
3126
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3124

def inner_vertical
  @inner_vertical
end

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

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

Returns:



3170
3171
3172
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3170

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:



3155
3156
3157
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3155

def range
  @range
end

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

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

Returns:



3129
3130
3131
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3129

def right
  @right
end

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

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

Returns:



3165
3166
3167
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3165

def top
  @top
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3177
3178
3179
3180
3181
3182
3183
3184
3185
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3177

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