Interface: TextParameters

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

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

Extends

• ElementParameters

Indexable

[key: string]: unknown

Properties

Property	Type	Description	Inherited from	Defined in
title?	string	-	ElementParameters.title	types/src/element.ts:44
source?	string	-	ElementParameters.source	types/src/element.ts:45
id?	string	-	ElementParameters.id	types/src/element.ts:46
left?	number	-	ElementParameters.left	types/src/element.ts:49
top?	number	-	ElementParameters.top	types/src/element.ts:50
originX?	OriginX	-	ElementParameters.originX	types/src/element.ts:51
originY?	OriginY	-	ElementParameters.originY	types/src/element.ts:52
angle?	number	-	ElementParameters.angle	types/src/element.ts:53
scaleX?	number	-	ElementParameters.scaleX	types/src/element.ts:54
scaleY?	number	-	ElementParameters.scaleY	types/src/element.ts:55
opacity?	number	-	ElementParameters.opacity	types/src/element.ts:56
flipX?	boolean	-	ElementParameters.flipX	types/src/element.ts:57
flipY?	boolean	-	ElementParameters.flipY	types/src/element.ts:58
draggable?	boolean	Allow user to drag the element	ElementParameters.draggable	types/src/element.ts:62
rotatable?	boolean	Allow user to rotate the element	ElementParameters.rotatable	types/src/element.ts:64
resizable?	boolean	Allow user to resize the element	ElementParameters.resizable	types/src/element.ts:66
removable?	boolean	Allow user to remove the element	ElementParameters.removable	types/src/element.ts:68
copyable?	boolean	Allow user to duplicate the element	ElementParameters.copyable	types/src/element.ts:70
editable?	boolean	Allow user to edit the element content	ElementParameters.editable	types/src/element.ts:72
locked?	boolean	Lock the element (must be unlocked via Manage Layers)	ElementParameters.locked	types/src/element.ts:74
lockUniScaling?	boolean	Lock uniform (proportional) scaling	ElementParameters.lockUniScaling	types/src/element.ts:78
uniScalingUnlockable?	boolean	Allow user to unlock proportional scaling in toolbar	ElementParameters.uniScalingUnlockable	types/src/element.ts:80
minScaleLimit?	number	Minimum scale factor	ElementParameters.minScaleLimit	types/src/element.ts:82
boundingBox?	BoundingBoxValue	Bounding box constraint for the element	ElementParameters.boundingBox	types/src/element.ts:86
z?	number	Z-index position (-1 means add on top of stack)	ElementParameters.z	types/src/element.ts:90
zChangeable?	boolean	Allow user to change z-position	ElementParameters.zChangeable	types/src/element.ts:92
topped?	boolean	Always keep element on top	ElementParameters.topped	types/src/element.ts:94
fill?	string | false	Fill color (false = no fill / use original)	ElementParameters.fill	types/src/element.ts:98
colors?	string | number | false | string[]	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	Link color changes across elements with same group name	ElementParameters.colorLinkGroup	types/src/element.ts:108
colorPrices?	Record<string, number>	Per-color pricing: { "hexcode": price }	ElementParameters.colorPrices	types/src/element.ts:110
colorLink3DLayer?	string | false	Link color to a 3D model layer name	ElementParameters.colorLink3DLayer	types/src/element.ts:112
price?	number	Price for this element	ElementParameters.price	types/src/element.ts:116
sku?	string	Unique SKU identifier	ElementParameters.sku	types/src/element.ts:118
excludeFromExport?	boolean	Exclude from SVG/image export	ElementParameters.excludeFromExport	types/src/element.ts:120
autoCenter?	boolean	Auto-center in canvas or bounding box when added	ElementParameters.autoCenter	types/src/element.ts:122
autoSelect?	boolean	Auto-select element when added	ElementParameters.autoSelect	types/src/element.ts:124
replace?	string	Replace elements with matching replace value	ElementParameters.replace	types/src/element.ts:126
replaceInAllViews?	boolean	Replace in all views (not just current)	ElementParameters.replaceInAllViews	types/src/element.ts:128
relatedViewImages?	RelatedViewImage[]	Related images to place on other views as a coordinated design set	ElementParameters.relatedViewImages	types/src/element.ts:130
fixed?	boolean	Element stays when product changes	ElementParameters.fixed	types/src/element.ts:132
showInColorSelection?	boolean	Show element colors in color selection panel	ElementParameters.showInColorSelection	types/src/element.ts:134
patterns?	string[]	Array of pattern image URLs	ElementParameters.patterns	types/src/element.ts:136
shadowColor?	string	-	ElementParameters.shadowColor	types/src/element.ts:139
shadowBlur?	number	-	ElementParameters.shadowBlur	types/src/element.ts:140
shadowOffsetX?	number	-	ElementParameters.shadowOffsetX	types/src/element.ts:141
shadowOffsetY?	number	-	ElementParameters.shadowOffsetY	types/src/element.ts:142
printAreaId?	string | null	Assign element to a specific print area	ElementParameters.printAreaId	types/src/element.ts:146
fontFamily?	string	-	-	types/src/element.ts:159
fontSize?	number	-	-	types/src/element.ts:160
fontWeight?	string	-	-	types/src/element.ts:161
fontStyle?	string	-	-	types/src/element.ts:162
textAlign?	string	-	-	types/src/element.ts:163
lineHeight?	number	-	-	types/src/element.ts:164
letterSpacing?	number	Additional letter spacing (converted to charSpacing internally)	-	types/src/element.ts:166
textDecoration?	string	-	-	types/src/element.ts:167
stroke?	string | null	-	-	types/src/element.ts:168
strokeWidth?	number	-	-	types/src/element.ts:169
strokeColors?	string[]	Available stroke colors (empty = color wheel)	-	types/src/element.ts:171
maxLength?	number	Maximum allowed characters (0 = unlimited)	-	types/src/element.ts:174
maxLines?	number	Maximum allowed lines (0 = unlimited)	-	types/src/element.ts:176
minFontSize?	number	Minimum font size	-	types/src/element.ts:178
maxFontSize?	number	Maximum font size	-	types/src/element.ts:180
textTransform?	TextTransform	Text transform mode	-	types/src/element.ts:182
chargeAfterEditing?	boolean	Charge price only after text is edited	-	types/src/element.ts:184
textPlaceholder?	boolean	Enable as Names & Numbers text placeholder	-	types/src/element.ts:186
numberPlaceholder?	boolean | number[]	Enable as Names & Numbers number placeholder	-	types/src/element.ts:188
textLinkGroup?	string	Link text content across elements with same group	-	types/src/element.ts:190
widthFontSize?	number	Auto-adjust font size to keep text at this width (0 = disabled). Mutually exclusive with heightFontSize.	-	types/src/element.ts:192
heightFontSize?	number	Auto-adjust font size to keep text at this height (0 = disabled). Mutually exclusive with widthFontSize.	-	types/src/element.ts:194
curved?	boolean	Enable curved text	-	types/src/element.ts:198
curvable?	boolean	Allow user to toggle curved/straight	-	types/src/element.ts:200
curveRadius?	number	Curve radius	-	types/src/element.ts:202
maxCurveRadius?	number	Maximum curve radius in toolbar	-	types/src/element.ts:204
curveReverse?	boolean	Reverse curve direction	-	types/src/element.ts:206
textBox?	boolean	Enable as text box (fixed width, auto-wrap)	-	types/src/element.ts:209
neonText?	boolean	Enable neon text effect	-	types/src/element.ts:211