SheetProperties (Google Sheets API v4 (Rev. 612) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.sheets.v4.model.SheetProperties

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class SheetProperties
extends com.google.api.client.json.GenericJson
```
Properties of a 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
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

SheetProperties()

Constructors
Constructor and Description
`SheetProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SheetProperties`	`clone()`
`GridProperties`	`getGridProperties()` Additional properties of the sheet if this sheet is a grid.
`java.lang.Boolean`	`getHidden()` True if the sheet is hidden in the UI, false if it's visible.
`java.lang.Integer`	`getIndex()` The index of the sheet within the spreadsheet.
`java.lang.Boolean`	`getRightToLeft()` True if the sheet is an RTL sheet instead of an LTR sheet.
`java.lang.Integer`	`getSheetId()` The ID of the sheet.
`java.lang.String`	`getSheetType()` The type of sheet.
`Color`	`getTabColor()` The color of the tab in the UI.
`ColorStyle`	`getTabColorStyle()` The color of the tab in the UI.
`java.lang.String`	`getTitle()` The name of the sheet.
`SheetProperties`	`set(java.lang.String fieldName, java.lang.Object value)`
`SheetProperties`	`setGridProperties(GridProperties gridProperties)` Additional properties of the sheet if this sheet is a grid.
`SheetProperties`	`setHidden(java.lang.Boolean hidden)` True if the sheet is hidden in the UI, false if it's visible.
`SheetProperties`	`setIndex(java.lang.Integer index)` The index of the sheet within the spreadsheet.
`SheetProperties`	`setRightToLeft(java.lang.Boolean rightToLeft)` True if the sheet is an RTL sheet instead of an LTR sheet.
`SheetProperties`	`setSheetId(java.lang.Integer sheetId)` The ID of the sheet.
`SheetProperties`	`setSheetType(java.lang.String sheetType)` The type of sheet.
`SheetProperties`	`setTabColor(Color tabColor)` The color of the tab in the UI.
`SheetProperties`	`setTabColorStyle(ColorStyle tabColorStyle)` The color of the tab in the UI.
`SheetProperties`	`setTitle(java.lang.String title)` The name of the sheet.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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

- Constructor Detail
  - SheetProperties
```
public SheetProperties()
```
- Method Detail
  - getGridProperties
```
public GridProperties getGridProperties()
```
    Additional properties of the sheet if this sheet is a grid. (If the sheet is an object sheet, containing a chart or image, then this field will be absent.) When writing it is an error to set any grid properties on non-grid sheets.
    
    Returns:
    
    value or null for none
  - setGridProperties
```
public SheetProperties setGridProperties(GridProperties gridProperties)
```
    Additional properties of the sheet if this sheet is a grid. (If the sheet is an object sheet, containing a chart or image, then this field will be absent.) When writing it is an error to set any grid properties on non-grid sheets.
    
    Parameters:
    
    gridProperties - gridProperties or null for none
  - getHidden
```
public java.lang.Boolean getHidden()
```
    True if the sheet is hidden in the UI, false if it's visible.
    
    Returns:
    
    value or null for none
  - setHidden
```
public SheetProperties setHidden(java.lang.Boolean hidden)
```
    True if the sheet is hidden in the UI, false if it's visible.
    
    Parameters:
    
    hidden - hidden or null for none
  - getIndex
```
public java.lang.Integer getIndex()
```
    The index of the sheet within the spreadsheet. When adding or updating sheet properties, if this field is excluded then the sheet is added or moved to the end of the sheet list. When updating sheet indices or inserting sheets, movement is considered in "before the move" indexes. For example, if there were 3 sheets (S1, S2, S3) in order to move S1 ahead of S2 the index would have to be set to 2. A sheet index update request is ignored if the requested index is identical to the sheets current index or if the requested new index is equal to the current sheet index + 1.
    
    Returns:
    
    value or null for none
  - setIndex
```
public SheetProperties setIndex(java.lang.Integer index)
```
    The index of the sheet within the spreadsheet. When adding or updating sheet properties, if this field is excluded then the sheet is added or moved to the end of the sheet list. When updating sheet indices or inserting sheets, movement is considered in "before the move" indexes. For example, if there were 3 sheets (S1, S2, S3) in order to move S1 ahead of S2 the index would have to be set to 2. A sheet index update request is ignored if the requested index is identical to the sheets current index or if the requested new index is equal to the current sheet index + 1.
    
    Parameters:
    
    index - index or null for none
  - getRightToLeft
```
public java.lang.Boolean getRightToLeft()
```
    True if the sheet is an RTL sheet instead of an LTR sheet.
    
    Returns:
    
    value or null for none
  - setRightToLeft
```
public SheetProperties setRightToLeft(java.lang.Boolean rightToLeft)
```
    True if the sheet is an RTL sheet instead of an LTR sheet.
    
    Parameters:
    
    rightToLeft - rightToLeft or null for none
  - getSheetId
```
public java.lang.Integer getSheetId()
```
    The ID of the sheet. Must be non-negative. This field cannot be changed once set.
    
    Returns:
    
    value or null for none
  - setSheetId
```
public SheetProperties setSheetId(java.lang.Integer sheetId)
```
    The ID of the sheet. Must be non-negative. This field cannot be changed once set.
    
    Parameters:
    
    sheetId - sheetId or null for none
  - getSheetType
```
public java.lang.String getSheetType()
```
    The type of sheet. Defaults to GRID. This field cannot be changed once set.
    
    Returns:
    
    value or null for none
  - setSheetType
```
public SheetProperties setSheetType(java.lang.String sheetType)
```
    The type of sheet. Defaults to GRID. This field cannot be changed once set.
    
    Parameters:
    
    sheetType - sheetType or null for none
  - getTabColor
```
public Color getTabColor()
```
    The color of the tab in the UI.
    
    Returns:
    
    value or null for none
  - setTabColor
```
public SheetProperties setTabColor(Color tabColor)
```
    The color of the tab in the UI.
    
    Parameters:
    
    tabColor - tabColor or null for none
  - getTabColorStyle
```
public ColorStyle getTabColorStyle()
```
    The color of the tab in the UI. If tab_color is also set, this field takes precedence.
    
    Returns:
    
    value or null for none
  - setTabColorStyle
```
public SheetProperties setTabColorStyle(ColorStyle tabColorStyle)
```
    The color of the tab in the UI. If tab_color is also set, this field takes precedence.
    
    Parameters:
    
    tabColorStyle - tabColorStyle or null for none
  - getTitle
```
public java.lang.String getTitle()
```
    The name of the sheet.
    
    Returns:
    
    value or null for none
  - setTitle
```
public SheetProperties setTitle(java.lang.String title)
```
    The name of the sheet.
    
    Parameters:
    
    title - title or null for none
  - set
```
public SheetProperties set(java.lang.String fieldName,
                           java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public SheetProperties clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Google Sheets API v4 (revision 612)

Class SheetProperties

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

SheetProperties

Method Detail

getGridProperties

setGridProperties

getHidden

setHidden

getIndex

setIndex

getRightToLeft

setRightToLeft

getSheetId

setSheetId

getSheetType

setSheetType

getTabColor

setTabColor

getTabColorStyle

setTabColorStyle

getTitle

setTitle

set

clone