Skip to main content

Interface: ElementParameters

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

Base parameters shared by all element types (text, image, SVG). All properties are optional — they merge with defaults.

Extended by

Indexable

[key: string]: unknown

Properties

PropertyTypeDescriptionDefined in
title?string-types/src/element.ts:44
source?string-types/src/element.ts:45
id?string-types/src/element.ts:46
left?number-types/src/element.ts:49
top?number-types/src/element.ts:50
originX?OriginX-types/src/element.ts:51
originY?OriginY-types/src/element.ts:52
angle?number-types/src/element.ts:53
scaleX?number-types/src/element.ts:54
scaleY?number-types/src/element.ts:55
opacity?number-types/src/element.ts:56
flipX?boolean-types/src/element.ts:57
flipY?boolean-types/src/element.ts:58
draggable?booleanAllow user to drag the elementtypes/src/element.ts:62
rotatable?booleanAllow user to rotate the elementtypes/src/element.ts:64
resizable?booleanAllow user to resize the elementtypes/src/element.ts:66
removable?booleanAllow user to remove the elementtypes/src/element.ts:68
copyable?booleanAllow user to duplicate the elementtypes/src/element.ts:70
editable?booleanAllow user to edit the element contenttypes/src/element.ts:72
locked?booleanLock the element (must be unlocked via Manage Layers)types/src/element.ts:74
lockUniScaling?booleanLock uniform (proportional) scalingtypes/src/element.ts:78
uniScalingUnlockable?booleanAllow user to unlock proportional scaling in toolbartypes/src/element.ts:80
minScaleLimit?numberMinimum scale factortypes/src/element.ts:82
boundingBox?BoundingBoxValueBounding box constraint for the elementtypes/src/element.ts:86
z?numberZ-index position (-1 means add on top of stack)types/src/element.ts:90
zChangeable?booleanAllow user to change z-positiontypes/src/element.ts:92
topped?booleanAlways keep element on toptypes/src/element.ts:94
fill?string | falseFill color (false = no fill / use original)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)types/src/element.ts:106
colorLinkGroup?string | falseLink color changes across elements with same group nametypes/src/element.ts:108
colorPrices?Record<string, number>Per-color pricing: { "hexcode": price }types/src/element.ts:110
colorLink3DLayer?string | falseLink color to a 3D model layer nametypes/src/element.ts:112
price?numberPrice for this elementtypes/src/element.ts:116
sku?stringUnique SKU identifiertypes/src/element.ts:118
excludeFromExport?booleanExclude from SVG/image exporttypes/src/element.ts:120
autoCenter?booleanAuto-center in canvas or bounding box when addedtypes/src/element.ts:122
autoSelect?booleanAuto-select element when addedtypes/src/element.ts:124
replace?stringReplace elements with matching replace valuetypes/src/element.ts:126
replaceInAllViews?booleanReplace in all views (not just current)types/src/element.ts:128
relatedViewImages?RelatedViewImage[]Related images to place on other views as a coordinated design settypes/src/element.ts:130
fixed?booleanElement stays when product changestypes/src/element.ts:132
showInColorSelection?booleanShow element colors in color selection paneltypes/src/element.ts:134
patterns?string[]Array of pattern image URLstypes/src/element.ts:136
shadowColor?string-types/src/element.ts:139
shadowBlur?number-types/src/element.ts:140
shadowOffsetX?number-types/src/element.ts:141
shadowOffsetY?number-types/src/element.ts:142
printAreaId?string | nullAssign element to a specific print areatypes/src/element.ts:146