setCurrentPageBackground

API reference for the setCurrentPageBackground method.

Updates the background of the user's current page. The background can be a solid color, an image or a video.

Parameters

optsPageBackgroundFill

REQUIRED

The appearance of a page's background.

Properties of opts

assetobject

OPTIONAL

An image or video to use as the fill.

An image asset that fills a path's interior.

typestring

REQUIRED

The type of fill.

This must be "image".

refImageRef

REQUIRED

A unique identifier that points to an image asset in Canva's backend.

A video asset that fills a path's interior.

typestring

REQUIRED

The type of fill.

This must be "video".

refVideoRef

REQUIRED

A unique identifier that points to a video asset in Canva's backend.

colorstring

OPTIONAL

The color of the fill as a hex code.

The hex code must include all six characters and be prefixed with a # symbol.

Example

" #ff0099"

Promise<void>