target.apidocs.com.google.api.services.sheets.v4.model.DimensionGroup.html Maven / Gradle / Ivy
DimensionGroup (Google Sheets API v4-rev20230526-2.0.0)
com.google.api.services.sheets.v4.model
Class DimensionGroup
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.sheets.v4.model.DimensionGroup
-
public final class DimensionGroup
extends com.google.api.client.json.GenericJson
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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the Google Sheets API. For a detailed explanation see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
DimensionGroup()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
DimensionGroup
clone()
Boolean
getCollapsed()
This field is true if this group is collapsed.
Integer
getDepth()
The depth of the group, representing how many groups have a range that wholly contains the
range of this group.
DimensionRange
getRange()
The range over which this group exists.
DimensionGroup
set(String fieldName,
Object value)
DimensionGroup
setCollapsed(Boolean collapsed)
This field is true if this group is collapsed.
DimensionGroup
setDepth(Integer depth)
The depth of the group, representing how many groups have a range that wholly contains the
range of this group.
DimensionGroup
setRange(DimensionRange range)
The range over which this group exists.
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
getCollapsed
public Boolean getCollapsed()
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.
- Returns:
- value or
null
for none
-
setCollapsed
public DimensionGroup setCollapsed(Boolean 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.
- Parameters:
collapsed
- collapsed or null
for none
-
getDepth
public Integer getDepth()
The depth of the group, representing how many groups have a range that wholly contains the
range of this group.
- Returns:
- value or
null
for none
-
setDepth
public DimensionGroup setDepth(Integer depth)
The depth of the group, representing how many groups have a range that wholly contains the
range of this group.
- Parameters:
depth
- depth or null
for none
-
getRange
public DimensionRange getRange()
The range over which this group exists.
- Returns:
- value or
null
for none
-
setRange
public DimensionGroup setRange(DimensionRange range)
The range over which this group exists.
- Parameters:
range
- range or null
for none
-
set
public DimensionGroup set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public DimensionGroup clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2023 Google. All rights reserved.