Access and modify a data source column.
Only use this class with data that's connected to a database.
Methods
| Method | Return type | Brief description |
|---|---|---|
Data
|
Gets the data source associated with the data source column. | |
String
|
Gets the formula for the data source column. | |
String
|
Gets the name for the data source column. | |
Boolean
|
Returns whether the column has an array dependency. | |
Boolean
|
Returns whether the column is a calculated column. | |
void
|
Removes the data source column. | |
Data
|
Sets the formula for the data source column. | |
Data
|
Sets the name of the data source column. |
Detailed documentation
get
Data
Source()
Gets the data source associated with the data source column.
Return
Data
— The data source.
Authorization
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get
Formula()
Gets the formula for the data source column. Returns an empty string if the data source column
is not a calculated column
.
Return
String
— The formula.
Authorization
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get
Name()
Gets the name for the data source column.
Return
String
— The column name.
Authorization
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
has
Array
Dependency()
Returns whether the column has an array dependency.
Return
Boolean
— true
if the column has an array dependency, or false
otherwise.
Authorization
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
is
Calculated
Column()
Returns whether the column is a calculated column.
Return
Boolean
— true
if the column is a calculated column, or false
otherwise.
Authorization
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
remove()
Removes the data source column.
Only supported for calculated columns
.
Authorization
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set
Formula(formula)
Sets the formula for the data source column.
Only supported for calculated columns
.
Parameters
| Name | Type |
|---|---|
formula
|
String
|
Description : The new formula. | |
Return
Data
— The data source column, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set
Name(name)
Sets the name of the data source column.
Only supported for calculated columns
.
Parameters
| Name | Type |
|---|---|
name
|
String
|
Description : The name to set. | |
Return
Data
— The data source column, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
