com.google.api.services.sheets.v4.model

Class SheetProperties

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.SheetProperties

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SheetProperties
extends 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

GenericData.Flags

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

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
SheetProperties()

Method Summary

Modifier and Type	Method and Description
SheetProperties	clone()
DataSourceSheetProperties	getDataSourceSheetProperties() Output only.
GridProperties	getGridProperties() Additional properties of the sheet if this sheet is a grid.
Boolean	getHidden() True if the sheet is hidden in the UI, false if it's visible.
Integer	getIndex() The index of the sheet within the spreadsheet.
Boolean	getRightToLeft() True if the sheet is an RTL sheet instead of an LTR sheet.
Integer	getSheetId() The ID of the sheet.
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.
String	getTitle() The name of the sheet.
SheetProperties	set(String fieldName, Object value)
SheetProperties	setDataSourceSheetProperties(DataSourceSheetProperties dataSourceSheetProperties) Output only.
SheetProperties	setGridProperties(GridProperties gridProperties) Additional properties of the sheet if this sheet is a grid.
SheetProperties	setHidden(Boolean hidden) True if the sheet is hidden in the UI, false if it's visible.
SheetProperties	setIndex(Integer index) The index of the sheet within the spreadsheet.
SheetProperties	setRightToLeft(Boolean rightToLeft) True if the sheet is an RTL sheet instead of an LTR sheet.
SheetProperties	setSheetId(Integer sheetId) The ID of the sheet.
SheetProperties	setSheetType(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(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, 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

Constructor Detail

SheetProperties

public SheetProperties()

Method Detail

getDataSourceSheetProperties

public DataSourceSheetProperties getDataSourceSheetProperties()

Output only. If present, the field contains DATA_SOURCE sheet specific properties.

Returns:

value or null for none

setDataSourceSheetProperties

public SheetProperties setDataSourceSheetProperties(DataSourceSheetProperties dataSourceSheetProperties)

Output only. If present, the field contains DATA_SOURCE sheet specific properties.

Parameters:

dataSourceSheetProperties - dataSourceSheetProperties or null for none

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. If this sheet is a DATA_SOURCE sheet, this field is output only but contains the properties that reflect how a data source sheet is rendered in the UI, e.g. row_count.

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. If this sheet is a DATA_SOURCE sheet, this field is output only but contains the properties that reflect how a data source sheet is rendered in the UI, e.g. row_count.

Parameters:

gridProperties - gridProperties or null for none

getHidden

public 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(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 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(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 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(Boolean rightToLeft)

True if the sheet is an RTL sheet instead of an LTR sheet.

Parameters:

rightToLeft - rightToLeft or null for none

getSheetId

public 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(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 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(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 String getTitle()

The name of the sheet.

Returns:

value or null for none

setTitle

public SheetProperties setTitle(String title)

The name of the sheet.

Parameters:

title - title or null for none

set

public SheetProperties set(String fieldName,
                           Object value)

Overrides:

set in class GenericJson

clone

public SheetProperties clone()

Overrides:

clone in class GenericJson