Board API Reference
kittl.design.board — create and manage artboards.
Scope: design:state:write
createStandardBoard(params)
Creates a new artboard on the canvas. See CreateBoardParams.
| Property | Type | Required | Description |
|---|---|---|---|
position | AbsolutePosition | RelativePosition | Yes | Placement on the canvas |
size | { width: number; height: number } | Yes | Board dimensions |
title | string | No | Board title |
Returns: SdkResultAsync<NormalizedBoard>
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 | Yes | Position for the cloned board |
Returns: SdkResultAsync<NormalizedBoard>
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 |
updateArtboardBackground(params)
Updates the background image source of a board.
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Board ID |
objectName | string | Yes | Stored image source |
See UpdateArtboardBackgroundParams for the published input and the board signatures for the result type.