Skip to main content

Interface: GenericOptionSetOption

Base interface for option set options with core functionality.

This interface contains the fundamental properties and settings for a product option, including identifiers, pricing information, and configuration for special widgets like engraving, custom images, or colors.

GenericOptionSetOption serves as the foundation for the OptionSetOption interface, providing the common structure and functionality shared by all product options.

Extended by​

Properties​

additionalPriceCode?​

optional additionalPriceCode: string

Additional price code for complex pricing scenarios. Used when multiple price factors need to be considered for a single option.

arMaterial3dId?​

optional arMaterial3dId: string

ID of the material to use in AR mode when this option is selected. May differ from standard material for optimization in AR experiences.

blockCode?​

optional blockCode: string

Unique code for the block this option belongs to. Used in generating configuration codes and for block identification.

Alias​

blockName

blockId?​

optional blockId: string

Identifier for the block this option belongs to. Links this option to its containing block in the UI.

blockName?​

optional blockName: string

Display name of the block this option belongs to. Used for UI presentation and user feedback.

code​

code: string

Configuration code for this option, used in generating the complete product code. This code becomes part of the full configuration code that identifies the product variant.

colorSettings?​

optional colorSettings: CustomColorOption

Configuration for custom color selection functionality. Only applicable when the parent block uses a COLOR widget type. Contains settings for color selection and application.

engraveSettings?​

optional engraveSettings: EngravingOption

Configuration for text engraving functionality. Only applicable when the parent block uses an ENGRAVE widget type. Contains settings for how text should be engraved on the product.

filters?​

optional filters: Filters

Map of parent/child filters for option visibility logic. Controls when this option is shown or hidden based on other selected options.

hideInOptionPanel?​

optional hideInOptionPanel: boolean

If true, this option will be hidden in the option panel. The option will still be available but not visible in the standard UI.

hideInPdf?​

optional hideInPdf: boolean

If true, this option will be hidden in PDF exports. Options marked with this flag won't appear in generated documentation.

id​

id: string

Unique identifier for this option. Used as the primary reference for this option throughout the system.

imageSettings?​

optional imageSettings: CustomImageOption

Configuration for custom image upload functionality. Only applicable when the parent block uses an IMAGE widget type. Contains settings for how uploaded images should be applied to the product.

inputSettings?​

optional inputSettings: InputOption

Configuration for input field functionality. Only applicable when the parent block uses a TEXT or NUMBER widget type. Contains settings for validation and formatting of user input.

isDisabled?​

optional isDisabled: boolean

If true, this option cannot be selected by users. Disabled options appear in the UI but are not selectable (typically shown grayed out).

isHidden?​

optional isHidden: boolean

If true, this option is hidden from users but can still be selected programmatically. Hidden options don't appear in the UI but can be part of the configuration.

isSpecialWidget?​

optional isSpecialWidget: boolean

If true, this is a special widget with custom code and model structure. Special widgets may require additional processing or have unique behaviors. Examples include complex configurators or custom visualization widgets.

material3dId?​

optional material3dId: string

ID of the 3D material to apply when this option is selected. Associates this option with a specific material in the 3D model.

metafields?​

optional metafields: Metafields

Custom parameters that can be dynamically added to this option. These can store additional business logic or display settings. Metafields provide flexible extension points for product-specific behaviors.

optionSetId?​

optional optionSetId: string

Identifier for the option set this option belongs to. Links this option to its parent option set.

ordinal?​

optional ordinal: number

The display order of this option relative to other options. Controls the sequence in which options appear in the configurator.

priceCode?​

optional priceCode: string

Code used for price calculations related to this option. This code is matched against price lists to determine pricing.

printOnDemandSettings?​

optional printOnDemandSettings: PrintOnDemandOption

Configuration for print-on-demand functionality. Only applicable when the parent block uses a PRINT_ON_DEMAND widget type. Contains settings for image placement, sizing, and printing parameters.

src?​

optional src: string

Relative path to the image representing this option. Used for thumbnail generation and image display in the configurator.

thumbnail?​

optional thumbnail: string

Absolute path to this option's thumbnail image (210px size). Pre-generated thumbnail for efficiency in the UI.