Class PageBackground

  • You can retrieve the picture or solid fill of a page background usinggetPictureFill() orgetSolidFill(), which returnnull if the background type doesn't match.

  • The type of the page background can be obtained with thegetType() method.

  • You can check if the page background is visible using theisVisible() method.

  • Page backgrounds can be set to a picture from a blob source or a URL using thesetPictureFill() methods.

  • Solid color backgrounds can be set usingsetSolidFill() with various color representations, including Color objects, RGB values, hex strings, or ThemeColorType, with optional alpha transparency.

  • The page background can be set to transparent using thesetTransparent() method.

PageBackground

Describes the page's background

Methods

MethodReturn typeBrief description
getPictureFill()PictureFill|nullGet the stretched picture fill of this background, ornull if the background fill typeis notPageBackgroundType.PICTURE.
getSolidFill()SolidFill|nullGet the solid fill of this background, ornull if the background fill type is notPageBackgroundType.SOLID.
getType()PageBackgroundTypeGet the type of this page background.
isVisible()BooleanWhether the background is visible.
setPictureFill(blobSource)voidSets an image from the specified image blob as the page background.
setPictureFill(imageUrl)voidSets the image at the provided URL as the page background.
setSolidFill(color)voidSets the solid fill to the givenColor.
setSolidFill(color, alpha)voidSets the solid fill to the given alpha andColor.
setSolidFill(red, green, blue)voidSets the solid fill to the given RGB values.
setSolidFill(red, green, blue, alpha)voidSets the solid fill to the given alpha and RGB values.
setSolidFill(hexString)voidSets the solid fill to the given hex color string.
setSolidFill(hexString, alpha)voidSets the solid fill to the given alpha and hex color string.
setSolidFill(color)voidSets the solid fill to the givenThemeColorType.
setSolidFill(color, alpha)voidSets the solid fill to the given alpha andThemeColorType.
setTransparent()voidSets the background to transparent.

Detailed documentation

getPictureFill()

Get the stretched picture fill of this background, ornull if the background fill typeis notPageBackgroundType.PICTURE.

Return

PictureFill|null

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getSolidFill()

Get the solid fill of this background, ornull if the background fill type is notPageBackgroundType.SOLID.

Return

SolidFill|null

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getType()

Get the type of this page background.

Return

PageBackgroundType

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • 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 followingscopes:

  • 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 tomatch the dimensions of the page.

Inserting the image fetches it from theBlobSource once and a copy is stored fordisplay inside the presentation. Images must be less than 50MB in size, cannot exceed 25megapixels, and must be in either in PNG, JPEG, or GIF format.

Parameters

NameTypeDescription
blobSourceBlobSourceThe image data.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • 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 thedimensions of the page.

Inserting the image fetches it from the URL once and a copy is stored for display inside thepresentation. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must bein either in PNG, JPEG, or GIF format.

The provided URL must be publicly accessible and no larger than 2kB. The URL itself is savedwith the image and exposed viaPictureFill.getSourceUrl().

Parameters

NameTypeDescription
imageUrlStringThe URL to download the image from.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setSolidFill(color)

Sets the solid fill to the givenColor.

Parameters

NameTypeDescription
colorColor

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setSolidFill(color, alpha)

Sets the solid fill to the given alpha andColor.

Parameters

NameTypeDescription
colorColor
alphaNumber

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • 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

NameTypeDescription
redInteger
greenInteger
blueInteger

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • 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

NameTypeDescription
redInteger
greenInteger
blueInteger
alphaNumber

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • 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 is represented as'#FFC0CB'.

Parameters

NameTypeDescription
hexStringString

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • 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 is represented as'#FFC0CB'.

Parameters

NameTypeDescription
hexStringString
alphaNumber

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setSolidFill(color)

Sets the solid fill to the givenThemeColorType.

Parameters

NameTypeDescription
colorThemeColorType

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setSolidFill(color, alpha)

Sets the solid fill to the given alpha andThemeColorType.

Parameters

NameTypeDescription
colorThemeColorType
alphaNumber

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • 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 followingscopes:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-11 UTC.