Class: Google::Apis::SheetsV4::DimensionGroup

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 group over an interval of rows or columns on a sheet, which can contain or be contained within other groups. A group can be collapsed or expanded as a unit on the 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) ⇒ DimensionGroup

Returns a new instance of DimensionGroup



4161
4162
4163
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4161

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

Instance Attribute Details

#collapsed ⇒ Boolean Also known as: collapsed?

True if this group is collapsed. A collapsed group will remain collapsed if an overlapping group at a shallower depth is expanded. collapsed == true does not imply that all dimensions within the group are hidden, since a dimension's visibility can change independently from this group property. However, when this property is updated, all dimensions within it will be set to hidden if collapsed == true, or set to visible if collapsed == false. Corresponds to the JSON property collapsed

Returns:

  • (Boolean) 


4143
4144
4145
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4143

def collapsed
  @collapsed
end

#depth ⇒ Fixnum

The depth of the group, representing how many groups have a range that wholly contains the range of this group. Corresponds to the JSON property depth

Returns:

  • (Fixnum) 


4150
4151
4152
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4150

def depth
  @depth
end

#range ⇒ Google::Apis::SheetsV4::DimensionRange

A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side. Corresponds to the JSON property range

Returns:



4159
4160
4161
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4159

def range
  @range
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4166
4167
4168
4169
4170
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4166

def update!(**args)
  @collapsed = args[:collapsed] if args.key?(:collapsed)
  @depth = args[:depth] if args.key?(:depth)
  @range = args[:range] if args.key?(:range)
end