target.apidocs.com.google.api.services.sheets.v4.model.SpreadsheetProperties.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-sheets Show documentation

There is a newer version: v4-rev20240423-2.0.0

Show newest version







SpreadsheetProperties (Google Sheets API v4-rev20240319-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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



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













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class SpreadsheetProperties
extends com.google.api.client.json.GenericJson
Properties of a spreadsheet.

  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>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


SpreadsheetProperties() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


SpreadsheetProperties
clone() 


String
getAutoRecalc()
The amount of time to wait before volatile functions are recalculated.



CellFormat
getDefaultFormat()
The default format of all cells in the spreadsheet.



Boolean
getImportFunctionsExternalUrlAccessAllowed()
Whether to allow external url access for image and import functions.



IterativeCalculationSettings
getIterativeCalculationSettings()
Determines whether and how circular references are resolved with iterative calculation.



String
getLocale()
The locale of the spreadsheet in one of the following formats: * an ISO 639-1 language code
 such as `en` * an ISO 639-2 language code such as `fil`, if no 639-1 code exists * a
 combination of the ISO language code and country code, such as `en_US` Note: when updating this
 field, not all locales/languages are supported.



SpreadsheetTheme
getSpreadsheetTheme()
Theme applied to the spreadsheet.



String
getTimeZone()
The time zone of the spreadsheet, in CLDR format such as `America/New_York`.



String
getTitle()
The title of the spreadsheet.



SpreadsheetProperties
set(String fieldName,
   Object value) 


SpreadsheetProperties
setAutoRecalc(String autoRecalc)
The amount of time to wait before volatile functions are recalculated.



SpreadsheetProperties
setDefaultFormat(CellFormat defaultFormat)
The default format of all cells in the spreadsheet.



SpreadsheetProperties
setImportFunctionsExternalUrlAccessAllowed(Boolean importFunctionsExternalUrlAccessAllowed)
Whether to allow external url access for image and import functions.



SpreadsheetProperties
setIterativeCalculationSettings(IterativeCalculationSettings iterativeCalculationSettings)
Determines whether and how circular references are resolved with iterative calculation.



SpreadsheetProperties
setLocale(String locale)
The locale of the spreadsheet in one of the following formats: * an ISO 639-1 language code
 such as `en` * an ISO 639-2 language code such as `fil`, if no 639-1 code exists * a
 combination of the ISO language code and country code, such as `en_US` Note: when updating this
 field, not all locales/languages are supported.



SpreadsheetProperties
setSpreadsheetTheme(SpreadsheetTheme spreadsheetTheme)
Theme applied to the spreadsheet.



SpreadsheetProperties
setTimeZone(String timeZone)
The time zone of the spreadsheet, in CLDR format such as `America/New_York`.



SpreadsheetProperties
setTitle(String title)
The title of the spreadsheet.







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





SpreadsheetProperties
public SpreadsheetProperties()









Method Detail





getAutoRecalc
public String getAutoRecalc()
The amount of time to wait before volatile functions are recalculated.

Returns:
value or null for none








setAutoRecalc
public SpreadsheetProperties setAutoRecalc(String autoRecalc)
The amount of time to wait before volatile functions are recalculated.

Parameters:
autoRecalc - autoRecalc or null for none








getDefaultFormat
public CellFormat getDefaultFormat()
The default format of all cells in the spreadsheet. CellData.effectiveFormat will not be set if
 the cell's format is equal to this default format. This field is read-only.

Returns:
value or null for none








setDefaultFormat
public SpreadsheetProperties setDefaultFormat(CellFormat defaultFormat)
The default format of all cells in the spreadsheet. CellData.effectiveFormat will not be set if
 the cell's format is equal to this default format. This field is read-only.

Parameters:
defaultFormat - defaultFormat or null for none








getImportFunctionsExternalUrlAccessAllowed
public Boolean getImportFunctionsExternalUrlAccessAllowed()
Whether to allow external url access for image and import functions. Read only when true. When
 false, you can set to true.

Returns:
value or null for none








setImportFunctionsExternalUrlAccessAllowed
public SpreadsheetProperties setImportFunctionsExternalUrlAccessAllowed(Boolean importFunctionsExternalUrlAccessAllowed)
Whether to allow external url access for image and import functions. Read only when true. When
 false, you can set to true.

Parameters:
importFunctionsExternalUrlAccessAllowed - importFunctionsExternalUrlAccessAllowed or null for none








getIterativeCalculationSettings
public IterativeCalculationSettings getIterativeCalculationSettings()
Determines whether and how circular references are resolved with iterative calculation. Absence
 of this field means that circular references result in calculation errors.

Returns:
value or null for none








setIterativeCalculationSettings
public SpreadsheetProperties setIterativeCalculationSettings(IterativeCalculationSettings iterativeCalculationSettings)
Determines whether and how circular references are resolved with iterative calculation. Absence
 of this field means that circular references result in calculation errors.

Parameters:
iterativeCalculationSettings - iterativeCalculationSettings or null for none








getLocale
public String getLocale()
The locale of the spreadsheet in one of the following formats: * an ISO 639-1 language code
 such as `en` * an ISO 639-2 language code such as `fil`, if no 639-1 code exists * a
 combination of the ISO language code and country code, such as `en_US` Note: when updating this
 field, not all locales/languages are supported.

Returns:
value or null for none








setLocale
public SpreadsheetProperties setLocale(String locale)
The locale of the spreadsheet in one of the following formats: * an ISO 639-1 language code
 such as `en` * an ISO 639-2 language code such as `fil`, if no 639-1 code exists * a
 combination of the ISO language code and country code, such as `en_US` Note: when updating this
 field, not all locales/languages are supported.

Parameters:
locale - locale or null for none








getSpreadsheetTheme
public SpreadsheetTheme getSpreadsheetTheme()
Theme applied to the spreadsheet.

Returns:
value or null for none








setSpreadsheetTheme
public SpreadsheetProperties setSpreadsheetTheme(SpreadsheetTheme spreadsheetTheme)
Theme applied to the spreadsheet.

Parameters:
spreadsheetTheme - spreadsheetTheme or null for none








getTimeZone
public String getTimeZone()
The time zone of the spreadsheet, in CLDR format such as `America/New_York`. If the time zone
 isn't recognized, this may be a custom time zone such as `GMT-07:00`.

Returns:
value or null for none








setTimeZone
public SpreadsheetProperties setTimeZone(String timeZone)
The time zone of the spreadsheet, in CLDR format such as `America/New_York`. If the time zone
 isn't recognized, this may be a custom time zone such as `GMT-07:00`.

Parameters:
timeZone - timeZone or null for none








getTitle
public String getTitle()
The title of the spreadsheet.

Returns:
value or null for none








setTitle
public SpreadsheetProperties setTitle(String title)
The title of the spreadsheet.

Parameters:
title - title or null for none








set
public SpreadsheetProperties set(String fieldName,
                                 Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public SpreadsheetProperties clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`SpreadsheetProperties`	`clone()`
`String`	`getAutoRecalc()` The amount of time to wait before volatile functions are recalculated.
`CellFormat`	`getDefaultFormat()` The default format of all cells in the spreadsheet.
`Boolean`	`getImportFunctionsExternalUrlAccessAllowed()` Whether to allow external url access for image and import functions.
`IterativeCalculationSettings`	`getIterativeCalculationSettings()` Determines whether and how circular references are resolved with iterative calculation.
`String`	`getLocale()` The locale of the spreadsheet in one of the following formats: * an ISO 639-1 language code such as `en` * an ISO 639-2 language code such as `fil`, if no 639-1 code exists * a combination of the ISO language code and country code, such as `en_US` Note: when updating this field, not all locales/languages are supported.
`SpreadsheetTheme`	`getSpreadsheetTheme()` Theme applied to the spreadsheet.
`String`	`getTimeZone()` The time zone of the spreadsheet, in CLDR format such as `America/New_York`.
`String`	`getTitle()` The title of the spreadsheet.
`SpreadsheetProperties`	`set(String fieldName, Object value)`
`SpreadsheetProperties`	`setAutoRecalc(String autoRecalc)` The amount of time to wait before volatile functions are recalculated.
`SpreadsheetProperties`	`setDefaultFormat(CellFormat defaultFormat)` The default format of all cells in the spreadsheet.
`SpreadsheetProperties`	`setImportFunctionsExternalUrlAccessAllowed(Boolean importFunctionsExternalUrlAccessAllowed)` Whether to allow external url access for image and import functions.
`SpreadsheetProperties`	`setIterativeCalculationSettings(IterativeCalculationSettings iterativeCalculationSettings)` Determines whether and how circular references are resolved with iterative calculation.
`SpreadsheetProperties`	`setLocale(String locale)` The locale of the spreadsheet in one of the following formats: * an ISO 639-1 language code such as `en` * an ISO 639-2 language code such as `fil`, if no 639-1 code exists * a combination of the ISO language code and country code, such as `en_US` Note: when updating this field, not all locales/languages are supported.
`SpreadsheetProperties`	`setSpreadsheetTheme(SpreadsheetTheme spreadsheetTheme)` Theme applied to the spreadsheet.
`SpreadsheetProperties`	`setTimeZone(String timeZone)` The time zone of the spreadsheet, in CLDR format such as `America/New_York`.
`SpreadsheetProperties`	`setTitle(String title)` The title of the spreadsheet.