Describes the page's background
Methods
| Method | Return type | Brief description |
|---|---|---|
getPictureFill() | PictureFill | Get the stretched picture fill of this background, or null if the background fill type
is not PageBackgroundType.PICTURE. |
getSolidFill() | SolidFill | Get the solid fill of this background, or null if the background fill type is not
PageBackgroundType.SOLID. |
getType() | PageBackgroundType | Get the type of this page background. |
isVisible() | Boolean | Whether the background is visible. |
setPictureFill(blobSource) | void | Sets an image from the specified image blob as the page background. |
setPictureFill(imageUrl) | void | Sets the image at the provided URL as the page background. |
setSolidFill(color) | void | Sets the solid fill to the given Color. |
setSolidFill(color, alpha) | void | Sets the solid fill to the given alpha and Color. |
setSolidFill(red, green, blue) | void | Sets the solid fill to the given RGB values. |
setSolidFill(red, green, blue, alpha) | void | Sets the solid fill to the given alpha and RGB values. |
setSolidFill(hexString) | void | Sets the solid fill to the given hex color string. |
setSolidFill(hexString, alpha) | void | Sets the solid fill to the given alpha and hex color string. |
setSolidFill(color) | void | Sets the solid fill to the given ThemeColorType. |
setSolidFill(color, alpha) | void | Sets the solid fill to the given alpha and ThemeColorType. |
setTransparent() | void | Sets the background to transparent. |
Detailed documentation
getPictureFill()
Get the stretched picture fill of this background, or null if the background fill type
is not PageBackgroundType.PICTURE.
Return
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
getSolidFill()
Get the solid fill of this background, or null if the background fill type is not
PageBackgroundType.SOLID.
Return
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()
Get the type of this page background.
Return
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
isVisible()
Whether the background is visible.
Return
Boolean
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
setPictureFill(blobSource)
Sets an image from the specified image blob as the page background. The image is stretched to match the dimensions of the page.
Inserting the image fetches it from the BlobSource once and a copy is stored for
display inside the presentation. Images must be less than 50MB in size, cannot exceed 25
megapixels, and must be in either in PNG, JPEG, or GIF format.
Parameters
| Name | Type | Description |
|---|---|---|
blobSource | BlobSource | The image data. |
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
setPictureFill(imageUrl)
Sets the image at the provided URL as the page background. The image is stretched to match the dimensions of the page.
Inserting the image fetches it from the URL once and a copy is stored for display inside the presentation. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF format.
The provided URL must be publicly accessible and no larger than 2kB. The URL itself is saved
with the image and exposed via PictureFill.getSourceUrl().
Parameters
| Name | Type | Description |
|---|---|---|
imageUrl | String | The URL to download the image from. |
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 |
|---|---|---|
hexString | 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 |
|---|---|---|
hexString | 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 ThemeColorType.
Parameters
| Name | Type | Description |
|---|---|---|
color | ThemeColorType |
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 ThemeColorType.
Parameters
| Name | Type | Description |
|---|---|---|
color | ThemeColorType | |
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