Skip to main content

Interface: PDFVisibleBlock

A visible option block in the PDF configuration summary.

This interface represents a single selected option that appears in the product configuration summary section of generated PDFs. It includes all the information needed to clearly communicate the customer's selections.

Clear, comprehensive option display in PDFs helps ensure that customers and manufacturers share the same understanding of the configured product.

Properties​

blockCode​

blockCode: string

Unique identifier code for this block.

This system reference helps link the displayed option to the underlying data structure in the product configuration.

code​

code: string

Unique identifier code for the selected option.

This system reference identifies the specific choice made for this option, linking it to inventory, pricing, and production systems.

comment?​

optional comment: string

Additional notes about this option selection.

Provides space for clarifying information, special requests, or implementation details related to this specific option.

filters?​

optional filters: Record<string, string[]>

Categorization tags for this option.

These tags help identify the option's attributes or classifications, which can be useful for sorting, filtering, or special handling.

groupIndex​

groupIndex: number

Position index of this block's group.

Determines the display order of option groups in the PDF, ensuring a logical and consistent presentation.

groupOptionIndex​

groupOptionIndex: number

Position index of this option within its group.

Determines the display order of options within their group, maintaining a logical and consistent hierarchy.

isSpecialWidget?​

optional isSpecialWidget: boolean

Indicates if this is a custom widget option.

When true, this option was selected using a special input widget rather than from standard selection options. This typically applies to custom-input options like dimensions, quantities, or uploaded images.

metafields?​

optional metafields: Metafields

Additional custom fields for this option.

These user-defined fields can contain any extra information needed for this option that doesn't fit into the standard properties.

name​

name: string

Display name of the option block.

This is the human-readable label for the option category, such as "Color", "Material", or "Size".

optionSetName?​

optional optionSetName: string

Name of the option set this option belongs to.

Provides additional context about the option's organization in the product's configuration structure.

priceCode?​

optional priceCode: string

Price code for this option.

Used in pricing calculations to determine how this specific option affects the overall product price.

src?​

optional src: string

URL to the option's thumbnail image.

When available, this provides a visual representation of the selected option, enhancing understanding of choices like colors or materials that are better communicated visually.

value​

value: string

Selected value for this option.

This is the human-readable choice the customer made for this option, such as "Arctic White", "Natural Oak", or "Queen Size".