Interface: ImageParameters

Defined in: types/src/element.ts:220

Additional parameters for image elements. Merges on top of ElementParameters.

Extends

• ElementParameters

Indexable

[key: string]: unknown

Properties

Property	Type	Default value	Description	Inherited from	Defined in
title?	string	undefined	-	ElementParameters.title	types/src/element.ts:44
source?	string	undefined	-	ElementParameters.source	types/src/element.ts:45
id?	string	undefined	-	ElementParameters.id	types/src/element.ts:46
left?	number	undefined	-	ElementParameters.left	types/src/element.ts:49
top?	number	undefined	-	ElementParameters.top	types/src/element.ts:50
originX?	OriginX	undefined	-	ElementParameters.originX	types/src/element.ts:51
originY?	OriginY	undefined	-	ElementParameters.originY	types/src/element.ts:52
angle?	number	undefined	-	ElementParameters.angle	types/src/element.ts:53
scaleX?	number	undefined	-	ElementParameters.scaleX	types/src/element.ts:54
scaleY?	number	undefined	-	ElementParameters.scaleY	types/src/element.ts:55
opacity?	number	undefined	-	ElementParameters.opacity	types/src/element.ts:56
flipX?	boolean	undefined	-	ElementParameters.flipX	types/src/element.ts:57
flipY?	boolean	undefined	-	ElementParameters.flipY	types/src/element.ts:58
draggable?	boolean	undefined	Allow user to drag the element	ElementParameters.draggable	types/src/element.ts:62
rotatable?	boolean	undefined	Allow user to rotate the element	ElementParameters.rotatable	types/src/element.ts:64
resizable?	boolean	undefined	Allow user to resize the element	ElementParameters.resizable	types/src/element.ts:66
removable?	boolean	undefined	Allow user to remove the element	ElementParameters.removable	types/src/element.ts:68
copyable?	boolean	undefined	Allow user to duplicate the element	ElementParameters.copyable	types/src/element.ts:70
editable?	boolean	undefined	Allow user to edit the element content	ElementParameters.editable	types/src/element.ts:72
locked?	boolean	undefined	Lock the element (must be unlocked via Manage Layers)	ElementParameters.locked	types/src/element.ts:74
lockUniScaling?	boolean	undefined	Lock uniform (proportional) scaling	ElementParameters.lockUniScaling	types/src/element.ts:78
uniScalingUnlockable?	boolean	undefined	Allow user to unlock proportional scaling in toolbar	ElementParameters.uniScalingUnlockable	types/src/element.ts:80
minScaleLimit?	number	undefined	Minimum scale factor	ElementParameters.minScaleLimit	types/src/element.ts:82
boundingBox?	BoundingBoxValue	undefined	Bounding box constraint for the element	ElementParameters.boundingBox	types/src/element.ts:86
z?	number	undefined	Z-index position (-1 means add on top of stack)	ElementParameters.z	types/src/element.ts:90
zChangeable?	boolean	undefined	Allow user to change z-position	ElementParameters.zChangeable	types/src/element.ts:92
topped?	boolean	undefined	Always keep element on top	ElementParameters.topped	types/src/element.ts:94
fill?	string | false	undefined	Fill color (false = no fill / use original)	ElementParameters.fill	types/src/element.ts:98
colors?	string | number | false | string[]	undefined	Available colors for colorization. - false: no colorization - string: single hex enables color picker - string[]: array of hex colors shows color swatches - number: number of colors (legacy)	ElementParameters.colors	types/src/element.ts:106
colorLinkGroup?	string | false	undefined	Link color changes across elements with same group name	ElementParameters.colorLinkGroup	types/src/element.ts:108
colorPrices?	Record<string, number>	undefined	Per-color pricing: { "hexcode": price }	ElementParameters.colorPrices	types/src/element.ts:110
colorLink3DLayer?	string | false	undefined	Link color to a 3D model layer name	ElementParameters.colorLink3DLayer	types/src/element.ts:112
price?	number	undefined	Price for this element	ElementParameters.price	types/src/element.ts:116
sku?	string	undefined	Unique SKU identifier	ElementParameters.sku	types/src/element.ts:118
excludeFromExport?	boolean	undefined	Exclude from SVG/image export	ElementParameters.excludeFromExport	types/src/element.ts:120
autoCenter?	boolean	undefined	Auto-center in canvas or bounding box when added	ElementParameters.autoCenter	types/src/element.ts:122
autoSelect?	boolean	undefined	Auto-select element when added	ElementParameters.autoSelect	types/src/element.ts:124
replace?	string	undefined	Replace elements with matching replace value	ElementParameters.replace	types/src/element.ts:126
replaceInAllViews?	boolean	undefined	Replace in all views (not just current)	ElementParameters.replaceInAllViews	types/src/element.ts:128
relatedViewImages?	RelatedViewImage[]	undefined	Related images to place on other views as a coordinated design set	ElementParameters.relatedViewImages	types/src/element.ts:130
fixed?	boolean	undefined	Element stays when product changes	ElementParameters.fixed	types/src/element.ts:132
showInColorSelection?	boolean	undefined	Show element colors in color selection panel	ElementParameters.showInColorSelection	types/src/element.ts:134
patterns?	string[]	undefined	Array of pattern image URLs	ElementParameters.patterns	types/src/element.ts:136
shadowColor?	string	undefined	-	ElementParameters.shadowColor	types/src/element.ts:139
shadowBlur?	number	undefined	-	ElementParameters.shadowBlur	types/src/element.ts:140
shadowOffsetX?	number	undefined	-	ElementParameters.shadowOffsetX	types/src/element.ts:141
shadowOffsetY?	number	undefined	-	ElementParameters.shadowOffsetY	types/src/element.ts:142
printAreaId?	string | null	undefined	Assign element to a specific print area	ElementParameters.printAreaId	types/src/element.ts:146
filter?	string | false | null	undefined	Image filter name (e.g. 'grayscale', 'sepia')	-	types/src/element.ts:222
colorMode?	ColorBlendMode	undefined	Colorization blend mode	-	types/src/element.ts:224
scaleMode?	ScaleMode	undefined	Scale mode when fitting into container	-	types/src/element.ts:226
resizeToW?	string | number	undefined	Resize image to this width (0 = no resize)	-	types/src/element.ts:228
resizeToH?	string | number	undefined	Resize image to this height (0 = no resize)	-	types/src/element.ts:230
uploadZone?	boolean	undefined	Use image as upload zone (clickable area for adding media)	-	types/src/element.ts:233
uploadZoneMovable?	boolean	undefined	Allow user to move the upload zone	-	types/src/element.ts:235
uploadZoneRemovable?	boolean	undefined	Allow user to remove the upload zone	-	types/src/element.ts:237
svgFill?	string | false | string[]	undefined	SVG fill color(s) for coloring SVG paths	-	types/src/element.ts:240
imageProxy?	boolean	true	Allow proxy loading for this element. Set false to always render the full-resolution original regardless of imageProxyMaxDimension.	-	types/src/element.ts:249
proxySource?	string	undefined	URL of a server-hosted downscaled variant (hybrid proxy loading). When set together with originalWidth/originalHeight, the canvas loads only this variant — the full-resolution source is never downloaded client-side; print export always uses source. Set by the uploads module from the upload response. If the variant fails to load, the original loads with client-side proxying as fallback.	-	types/src/element.ts:258
originalWidth?	number	undefined	Natural pixel width of the full-resolution original image	-	types/src/element.ts:260
originalHeight?	number	undefined	Natural pixel height of the full-resolution original image	-	types/src/element.ts:262
originalFileSize?	number	undefined	File size in bytes of the original image (when known)	-	types/src/element.ts:264