sdk.textapi.updatetext
Home > @kittl/sdk > TextAPI > updateText
TextAPI.updateText() method
Modifies the content and properties of existing text elements within the design artboard.
This method allows comprehensive updating of text objects including content modification, positioning, and rotation properties. All parameters except textId are optional, allowing for selective updates of specific text properties.
Signature:
updateText(params: UpdateTextParams, opts?: DesignApiOptions): NormalizedRichTextObject;
Parameters
Parameter | Type | Description |
|---|---|---|
params | Configuration parameters for text update | |
opts | (Optional) Optional design API configuration options |
Returns:
The updated text object with applied modifications
Exceptions
When the specified textId does not exist in the design