Skip to main content

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.

PropertyTypeRequiredDescription
boardIdstringYesID of the artboard to clone
positionAbsolutePosition | RelativePositionNoPosition for the cloned board

Returns: SdkResultAsync<NormalizedStandardBoard>

updateArtboard(params)

Modifies properties of an existing artboard. Only specified properties are changed.

PropertyTypeRequiredDescription
idstringYesID of the artboard to update
artboardPartial<ArtboardOptions>NoPartial updates to artboard options (position, size, fill, etc.)
titlestringNoNew artboard title
textureTextureOptionsNoTexture options
backgroundImageBackgroundImageOptionsNoBackground image options