Skip to main content

Interface: EngravingOption

Configuration for an engraving option within a block.

EngravingOption connects an engraving capability to a specific block and material, including pricing information and the text content to be engraved. This represents an instance of text engraving that has been applied to a product.

Properties​

blockId?​

optional blockId: string

ID of the block this engraving option belongs to. Links this engraving to its containing configuration block.

code?​

optional code: string

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

materialId?​

optional materialId: string

ID of the material to apply the engraving to. Specifies which part of the model should receive the engraved text.

name?​

optional name: string

Display name for this engraving option. Used in the UI and product specifications.

priceCode?​

optional priceCode: string

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

rawText?​

optional rawText: string

settings?​

optional settings: EngravingSettings

Detailed settings controlling how the engraving is rendered. Contains all visual and technical parameters for the engraving.

text?​

optional text: string[]

Array of text strings to be engraved. For multi-line engravings, each array element represents one line.