sdk.boardapi.createstandardboard
Home > @kittl/sdk > BoardAPI > createStandardBoard
BoardAPI.createStandardBoard() method
Creates a new non-floating artboard at the specified position with the given dimensions.
This method creates a standard artboard that acts as a container for design elements. The artboard can be positioned relative to existing artboards or at absolute coordinates. If no title is provided, a default title will be generated based on the current artboard count.
Signature:
createStandardBoard(params: CreateBoardParams, opts?: DesignApiOptions): NormalizedBoard;
Parameters
Parameter | Type | Description |
|---|---|---|
params | Configuration parameters for creating the artboard | |
opts | (Optional) Additional options for the design API operation |
Returns:
The newly created Board object with all its properties
Exceptions
When invalid position parameters are provided