Describes the page element's background
Methods
Method | Return type | Brief description |
---|---|---|
get | Solid | Get the solid fill of this background, or null if the fill type is not Fill . |
get | Fill | Get the type of this fill. |
is | Boolean | Whether the background is visible. |
set | void | Sets the solid fill to the given Color . |
set | void | Sets the solid fill to the given alpha and Color . |
set | void | Sets the solid fill to the given RGB values. |
set | void | Sets the solid fill to the given alpha and RGB values. |
set | void | Sets the solid fill to the given hex color string. |
set | void | Sets the solid fill to the given alpha and hex color string. |
set | void | Sets the solid fill to the given Theme . |
set | void | Sets the solid fill to the given alpha and Theme . |
set | void | Sets the background to transparent. |
Detailed documentation
getSolidFill()
Get the solid fill of this background, or null
if the fill type is not Fill
.
Return
Solid
— The solid fill setting, or null
if this fill type is not solid.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getType()
isVisible()
Whether the background is visible.
Return
Boolean
— true
if the background is visible; false
otherwise.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setSolidFill(color)
setSolidFill(color, alpha)
Sets the solid fill to the given alpha and Color
.
Parameters
Name | Type | Description |
---|---|---|
color | Color | |
alpha | Number |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setSolidFill(red, green, blue)
Sets the solid fill to the given RGB values.
Parameters
Name | Type | Description |
---|---|---|
red | Integer | |
green | Integer | |
blue | Integer |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setSolidFill(red, green, blue, alpha)
Sets the solid fill to the given alpha and RGB values.
Parameters
Name | Type | Description |
---|---|---|
red | Integer | |
green | Integer | |
blue | Integer | |
alpha | Number |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setSolidFill(hexString)
Sets the solid fill to the given hex color string.
The hex string must be in the format '#RRGGBB'. For example, pink would be represented as '#FFC0CB'.
Parameters
Name | Type | Description |
---|---|---|
hex | String |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setSolidFill(hexString, alpha)
Sets the solid fill to the given alpha and hex color string.
The hex string must be in the format '#RRGGBB'. For example, pink would be represented as '#FFC0CB'.
Parameters
Name | Type | Description |
---|---|---|
hex | String | |
alpha | Number |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setSolidFill(color)
Sets the solid fill to the given Theme
.
Parameters
Name | Type | Description |
---|---|---|
color | Theme |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setSolidFill(color, alpha)
Sets the solid fill to the given alpha and Theme
.
Parameters
Name | Type | Description |
---|---|---|
color | Theme | |
alpha | Number |
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
setTransparent()
Sets the background to transparent.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations