sdk.guideapi.createguide
Home > @kittl/sdk > GuideAPI > createGuide
GuideAPI.createGuide() method
Creates a new guide in the design with the specified orientation and position.
This method creates either a horizontal or vertical guide at the specified coordinates. The guide will be added to the specified board, or to a floating board if no boardId is provided. Guides help users align design elements by providing visual reference lines.
Signature:
createGuide(input: CreateGuideInput, opts?: DesignApiOptions): NormalizedGuideObject;
Parameters
Parameter | Type | Description |
|---|---|---|
input | Configuration for creating the guide | |
opts | (Optional) Additional options for the design API operation |
Returns:
The newly created guide object with all computed properties
Exceptions
When orientation and coordinate parameters don't match
When the specified boardId doesn't exist in the design