Skip to main content

Interface: BlockEngraveSettings

Configuration settings for text engraving options on products. Controls all aspects of how text is rendered onto 3D models for personalization, including font appearance, positioning, and rendering effects.

Properties

adjustFont

adjustFont: boolean

If true, text size adjusts to fit within the designated area


allowFontChoice?

optional allowFontChoice: boolean

If true, users can select different fonts in the interface


allowStyleChoice?

optional allowStyleChoice: boolean

Deprecated

Use allowFontChoice instead


availableFonts?

optional availableFonts: string[]

List of font names that can be selected for engraving


code?

optional code: string

Configuration code used in the product variant code


fontFamilies?

optional fontFamilies: FontFamilies

Map of font families organized by source (Google, custom)


fontFamily?

optional fontFamily: string

Default font family to use before user customization


fontGroupId?

optional fontGroupId: string

ID of the font group to use


fontSize

fontSize: string | number

Font size in pixels or with units (e.g., "12px")


fontStyles?

optional fontStyles: string[]

List of font styles that users can choose (normal, italic, etc.)


invertH

invertH: boolean

If true, creates embossed (raised) text instead of engraved (recessed)


level

level: string | number

Technical parameter for engraving depth rendering


lines

lines: string | number

Number of text lines supported in the engraving


lineSpace

lineSpace: string | number

Spacing between lines in multi-line engravings


materialId?

optional materialId: string

ID of the material to receive the engraving


maxCharacters?

optional maxCharacters: string | number

Maximum allowed character count to prevent oversized engravings


mobileTextureSize

mobileTextureSize: number

Lower resolution for mobile devices to conserve memory


priceCode?

optional priceCode: string

Code used for price calculations


smoothing

smoothing: string | number

Controls how smooth vs. sharp the edges of engraved text appear


strength

strength: string | number

Depth/strength of the engraving effect on the surface


textAlign

textAlign: CanvasTextAlign

Horizontal alignment within the engraving area (left, center, right)


textBaseline?

optional textBaseline: CanvasTextBaseline

Deprecated

Vertical text alignment


textTransform?

optional textTransform: string

Text transformation to apply (uppercase, lowercase, etc.)


textureSize

textureSize: number

Resolution of the engraving texture on desktop devices


useAlbedo

useAlbedo: boolean

If true, modifies the color/appearance of the engraved area


useBump

useBump: boolean

If true, creates the visual effect of depth in the engraving


visibility-code?

optional visibility-code: string

Determines when this option is available based on other selections