sdk.imageapi.updateimage
Home > @kittl/sdk > ImageAPI > updateImage
ImageAPI.updateImage() method
Updates an existing image object in the design by updating its properties.
This method allows for in-place modification of existing image objects without recreating them. Currently supports position updates (left and top coordinates), with the ability to extend to other properties in the future.
**Update Behavior:** - Only specified properties are updated; all other properties remain unchanged - Position updates are applied directly to the existing object - Changes are tracked in the patch system for undo/redo functionality - Object maintains its current board assignment and hierarchy
Signature:
updateImage(params: UpdateImageParams, opts?: DesignApiOptions): NormalizedIllustrationImageObject;
Parameters
Parameter | Type | Description |
|---|---|---|
params | Configuration parameters for updating the image | |
opts | (Optional) Additional options for the design API operation |
Returns:
NormalizedIllustrationImageObject
Promise that resolves to the updated image object with updated properties
Exceptions
When the specified image ID doesn't exist in the design