sdk.boardapi.updateartboard
Home > @kittl/sdk > BoardAPI > updateArtboard
BoardAPI.updateArtboard() method
Updates properties of an existing artboard.
This method allows partial updates to any artboard property including nested artboard options. Only the specified properties in the parameters will be modified; all other properties remain unchanged.
Signature:
updateArtboard(params: UpdateArtboardParams, opts?: DesignApiOptions): NormalizedBoard;
Parameters
Parameter | Type | Description |
|---|---|---|
params | Configuration parameters for updating the artboard | |
opts | (Optional) Additional options for the design API operation |
Returns:
The updated Board object with modified properties
Exceptions
When the specified artboard ID doesn't exist in the working state
When trying to update a floating board