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.



4836
4837
4838
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4836

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

Instance Attribute Details

#collapsed ⇒ Boolean Also known as: collapsed?

This field is true if this group is collapsed. A collapsed group remains collapsed if an overlapping group at a shallower depth is expanded. A true value 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 are set to hidden if this field is true, or set to visible if this field is false. Corresponds to the JSON property collapsed

Returns:

  • (Boolean) 


4818
4819
4820
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4818

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) 


4825
4826
4827
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4825

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:



4834
4835
4836
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4834

def range
  @range
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4841
4842
4843
4844
4845
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4841

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