Interface: OptionSetOption
Represents a selectable option within an option set.
This interface extends GenericOptionSetOption with display properties and is used to represent an individual option that can be selected by the user in the product configurator. Each option belongs to a specific block and can have various visual properties, pricing rules, and custom settings.
Extends
Properties
additionalPriceCode?
optionaladditionalPriceCode:string
Additional price code for complex pricing scenarios. Used when multiple price factors need to be considered for a single option.
Inherited from
GenericOptionSetOption.additionalPriceCode
arMaterial3dId?
optionalarMaterial3dId: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.
Inherited from
GenericOptionSetOption.arMaterial3dId
blockCode?
optionalblockCode:string
Unique code for the block this option belongs to. Used in generating configuration codes and for block identification.
Alias
blockName
Inherited from
GenericOptionSetOption.blockCode
blockId?
optionalblockId:string
Identifier for the block this option belongs to. Links this option to its containing block in the UI.
Inherited from
GenericOptionSetOption.blockId
blockName?
optionalblockName:string
Display name of the block this option belongs to. Used for UI presentation and user feedback.
Inherited from
GenericOptionSetOption.blockName
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.
Inherited from
colorSettings?
optionalcolorSettings: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.
Inherited from
GenericOptionSetOption.colorSettings
comment?
optionalcomment:string
Optional comment or description for this option. May contain additional information or instructions related to this option.
engraveSettings?
optionalengraveSettings: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.
Inherited from
GenericOptionSetOption.engraveSettings
filters?
optionalfilters:Filters
Map of parent/child filters for option visibility logic. Controls when this option is shown or hidden based on other selected options.
Inherited from
GenericOptionSetOption.filters
hideInOptionPanel?
optionalhideInOptionPanel: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.
Inherited from
GenericOptionSetOption.hideInOptionPanel
hideInPdf?
optionalhideInPdf:boolean
If true, this option will be hidden in PDF exports.
Options marked with this flag won't appear in generated documentation.
Inherited from
GenericOptionSetOption.hideInPdf
id
id:
string
Unique identifier for this option. Used as the primary reference for this option throughout the system.
Inherited from
imageSettings?
optionalimageSettings: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.
Inherited from
GenericOptionSetOption.imageSettings
inputSettings?
optionalinputSettings: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.
Inherited from
GenericOptionSetOption.inputSettings
isDisabled?
optionalisDisabled:boolean
If true, this option cannot be selected by users.
Disabled options appear in the UI but are not selectable (typically shown grayed out).
Inherited from
GenericOptionSetOption.isDisabled
isHidden?
optionalisHidden: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.
Inherited from
GenericOptionSetOption.isHidden
isSpecialWidget?
optionalisSpecialWidget: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.
Inherited from
GenericOptionSetOption.isSpecialWidget
material3dId?
optionalmaterial3dId:string
ID of the 3D material to apply when this option is selected. Associates this option with a specific material in the 3D model.
Inherited from
GenericOptionSetOption.material3dId
metafields?
optionalmetafields: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.
Inherited from
GenericOptionSetOption.metafields
name
name:
string
The display name of the option shown to users.
optionSetId?
optionaloptionSetId:string
Identifier for the option set this option belongs to. Links this option to its parent option set.
Inherited from
GenericOptionSetOption.optionSetId
ordinal?
optionalordinal:number
The display order of this option relative to other options. Controls the sequence in which options appear in the configurator.
Inherited from
GenericOptionSetOption.ordinal
priceCode?
optionalpriceCode:string
Code used for price calculations related to this option. This code is matched against price lists to determine pricing.
Inherited from
GenericOptionSetOption.priceCode
printOnDemandSettings?
optionalprintOnDemandSettings: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.
Inherited from
GenericOptionSetOption.printOnDemandSettings
src?
optionalsrc:string
Relative path to the image representing this option. Used for thumbnail generation and image display in the configurator.
Inherited from
thumbnail?
optionalthumbnail:string
Absolute path to this option's thumbnail image (210px size). Pre-generated thumbnail for efficiency in the UI.