setCurrentPageBackground

API reference for the setCurrentPageBackground method.

This version of the API is a preview. Preview APIs are unstable and may change without warning. You can't release public apps using this API until it's stable.

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

Parameters

optsPageBackgroundFillRequired

The appearance of a page's background.

assetobjectOptional

An image or video to use as the fill.

An image asset that fills a path's interior.

typestringRequired

The type of fill.

This must be "image".

refImageRefRequired

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

altTextAltTextOptional

A description of the image content.

Use undefined for content with no description.

textstringRequired

The text content.

decorativeboolean | undefinedRequired

Indicates where the alternative text should be displayed.

If true, the alternative text will only be displayed in the editor.
If false, the alternative text will be displayed in the editor and in view-only mode.

A video asset that fills a path's interior.

typestringRequired

The type of fill.

This must be "video".

refVideoRefRequired

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

altTextAltTextOptional

A description of the image content.

Use undefined for content with no description.

textstringRequired

The text content.

decorativeboolean | undefinedRequired

Indicates where the alternative text should be displayed.

If true, the alternative text will only be displayed in the editor.
If false, the alternative text will be displayed in the editor and in view-only mode.

colorstringOptional

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"

Returns

Promise<void>