Skip to main content

Interface: CustomImageOption

Configuration for a custom image upload option.

CustomImageOption defines how user-uploaded images are processed and applied to a product. This includes positioning, scaling, and texture mapping parameters, as well as pricing and compatibility information.

Extends​

Indexable​

[key: string]: unknown

Properties​

accept?​

optional accept: string[]

List of file extensions that are accepted for upload. Restricts the types of images users can upload (e.g., ['jpg', 'png', 'svg']).

code?​

optional code: string

Configuration code for this image option. Used in generating the complete product code when this option is selected.

image?​

optional image: string

Path to the currently selected image. References the image file to be applied to the product.

materialId?​

optional materialId: string

ID of the material to apply the custom image to. Specifies which part of the model should receive the uploaded image.

priceCode?​

optional priceCode: string

Code used for price calculations related to this image option. This code is matched against price lists to determine any additional charges.

scale?​

optional scale: string | number

Scaling factor for the image. Controls how large the image appears on the product.

textureMode?​

optional textureMode: boolean

If true, the image will be treated as a texture rather than a logo. Texture mode applies the image differently, typically covering the entire material.

uAng?​

optional uAng: string | number

Rotation angle around the U axis. Part of 3D texture mapping transformation.

uOffset?​

optional uOffset: string | number

Horizontal offset for image placement on the texture. Controls left/right positioning of the image.

vAng?​

optional vAng: string | number

Rotation angle around the V axis. Part of 3D texture mapping transformation.

visibility-code?​

optional visibility-code: string

Visibility code that determines when this image option is available. Used for conditional display based on other selected options.

vOffset?​

optional vOffset: string | number

Vertical offset for image placement on the texture. Controls up/down positioning of the image.

wAng?​

optional wAng: string | number

Rotation angle around the W axis. Part of 3D texture mapping transformation.