Board API Reference
kittl.design.board — create and manage artboards.
Scope: design:state:write
createStandardBoard(params)
Creates a new artboard on the canvas.
Returns: SdkResultAsync<NormalizedStandardBoard>
cloneArtboard(params)
Duplicates an existing artboard including all child objects.
| Property | Type | Required | Description |
|---|---|---|---|
boardId | string | Yes | ID of the artboard to clone |
position | AbsolutePosition | RelativePosition | No | Position for the cloned board |
Returns: SdkResultAsync<NormalizedStandardBoard>
updateArtboard(params)
Modifies properties of an existing artboard. Only specified properties are changed.
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | ID of the artboard to update |
artboard | Partial<ArtboardOptions> | No | Partial updates to artboard options (position, size, fill, etc.) |
title | string | No | New artboard title |
texture | TextureOptions | No | Texture options |
backgroundImage | BackgroundImageOptions | No | Background image options |