sdk.boardapi.updateartboardbackground

Home > @kittl/sdk > BoardAPI > updateArtboardBackground

BoardAPI.updateArtboardBackground() method

Warning: This API is now obsolete.

Use updateArtboard method with backgroundImage parameter instead.

Updates the background image properties of an existing artboard.

This method allows modification of the background image object name/source. The method preserves all existing artboard properties while only updating the specified background image attributes.

Signature:

updateArtboardBackground(params: UpdateArtboardBackgroundParams, opts?: DesignApiOptions): NormalizedBoard;

Parameters

Parameter	Type	Description
params	UpdateArtboardBackgroundParams	Configuration parameters for updating the artboard background
opts	DesignApiOptions	(Optional) Additional options for the design API operation

Returns:

NormalizedBoard

The updated Board object with modified background properties

Exceptions

When the specified artboard ID doesn't exist in the working state

When trying to update background of a floating board