Skip to main content

sdk.boardapi.cloneartboard

Home > @kittl/sdk > BoardAPI > cloneArtboard

BoardAPI.cloneArtboard() method

Clones an existing artboard and creates a new one with the same properties and content.

This method creates an exact copy of an existing artboard, including all its design elements, group structures, and properties. The cloned artboard can be positioned relative to the original or at absolute coordinates. All objects within the artboard are also cloned with new IDs and updated positions to match the new artboard location.

Signature:

cloneArtboard(params: CloneArtboardParams, opts?: DesignApiOptions): NormalizedBoard;

Parameters

Parameter

Type

Description

params

CloneArtboardParams

Configuration parameters for cloning the artboard

opts

DesignApiOptions

(Optional) Additional options for the design API operation

Returns:

NormalizedBoard

The newly cloned Board object with all its properties and a new unique ID