Skip to main content

Interface: PrintOnDemandOption

Configuration for a print-on-demand customization option.

PrintOnDemandOption defines all aspects of a print-on-demand capability, including target material, image constraints, print area specifications, and quality requirements. This represents the complete configuration for a customizable printed area on a product.

Extends​

Indexable​

[key: string]: unknown

Properties​

accept​

accept: string[]

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

arTextureSize​

arTextureSize: number

The resolution of the texture used for print preview in AR experiences. Optimized for AR performance and visual quality.

code​

code: string

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

conversionSettings​

conversionSettings: object[]

Settings for image conversion and processing. Controls how uploaded images are processed before printing.

key​

key: string

value​

value: string

description?​

optional description: any

Description of the print area or instructions for users. Can contain formatting or plain text guidance.

fullScreenView?​

optional fullScreenView: boolean

If true, the print editor will open in full-screen mode. Provides more space for detailed design work.

image?​

optional image: string

Path to a currently selected image. References the image file to be applied as the main design element.

images?​

optional images: PrintOnDemandImage[]

User-uploaded or selected images in the design. Contains all image assets that have been added to the print.

layers?​

optional layers: PrintOnDemandLayer[]

Background and printable area layers for the design. Defines the visual structure of the print canvas.

materialId​

materialId: string

ID of the material to apply the print to. Specifies which part of the model should receive the printed design.

maxLogos​

maxLogos: number

Maximum number of logos/images that can be added to the design. Limits how many separate images a user can place in the print area.

measurementType​

measurementType: string

Unit of measurement for the print area ("mm", "in", etc.). Defines how real-world dimensions are expressed.

mobileTextureSize​

mobileTextureSize: number

The resolution of the texture used for print preview on mobile devices. Typically lower than desktop to conserve memory on mobile devices.

opaque?​

optional opaque: boolean

If true, the print material is opaque and blocks the underlying material. If false, the print may have transparent areas showing the base material.

openAs?​

optional openAs: string

Specifies how the editor should be opened (e.g., "modal", "inline"). Controls the UI presentation of the print editor.

realHeight​

realHeight: number

Actual height of the printable area in the specified measurement units. Represents the physical size of the print area on the product.

realWidth​

realWidth: number

Actual width of the printable area in the specified measurement units. Represents the physical size of the print area on the product.

requiredDPI​

requiredDPI: number

Minimum dots-per-inch resolution required for acceptable print quality. Used to validate uploaded images and warn about low-resolution assets.

showQuality?​

optional showQuality: boolean

If true, quality indicators will be shown for uploaded images. Provides visual feedback about image resolution suitability.

textureSize​

textureSize: number

The resolution of the texture used for print preview on desktop devices. Higher values create sharper previews but require more memory.

visibility-code?​

optional visibility-code: string

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