Skip to main content

Interface: EmbedTemplatePDFSettings

Configuration settings for PDF generation and export in the configurator.

This interface defines which elements should be included or excluded when generating PDF documents of product configurations. These settings control the content, formatting, and appearance of exported PDFs, allowing for customized documentation that matches specific business needs.

PDF exports are commonly used for sharing configurations with clients, sending to manufacturing, creating quotes, or archiving design decisions.

Properties​

fontFamily​

fontFamily: string

Specifies the font family to use throughout the PDF document.

This setting determines which typeface is used for all text in the PDF, allowing for brand consistency or improved readability. The value should be a valid font family name or a comma-separated list of fallback fonts.

Font selection affects both the appearance and professionalism of the generated document, and should ideally match brand guidelines when possible.

hideDeliveryInfo​

hideDeliveryInfo: boolean

When true, hides the delivery information in the PDF.

This setting removes estimated delivery times or shipping information from the PDF document. This may be appropriate when delivery times are variable, negotiable, or determined by factors outside the configurator's scope.

Consider hiding delivery info for preliminary quotes or when delivery details will be addressed separately from the product configuration.

hideDescription​

hideDescription: boolean

When true, hides the product description in the PDF.

This setting removes the detailed product description text from the PDF document. This can create a more concise document focused on the visual and technical aspects of the configuration.

Consider hiding descriptions when they contain marketing language not relevant to the technical specification, or when trying to create a more compact document.

hidePrice​

hidePrice: boolean

When true, hides all pricing information in the PDF.

This setting removes all price-related data from the PDF, creating a document focused purely on the product configuration without financial details. This is useful for technical specifications or when sharing designs where pricing is sensitive or negotiable.

Consider hiding prices for preliminary design sharing, technical documentation, or when the same PDF might be used across different price regions.

hideProductName​

hideProductName: boolean

When true, hides the product name in the PDF.

This setting removes the product name from the PDF document. This might be useful in specific contexts where the product identity is already established or where the focus should be purely on the configuration details.

Typically, product names should be visible in most use cases for clear identification of what's being configured.

hideQuantity​

hideQuantity: boolean

When true, hides the quantity information in the PDF.

This setting removes the quantity value from the PDF document, which may be desirable for preliminary quotes or when quantity will be determined later in the sales process.

Consider hiding quantity when focusing on design aspects rather than order details, or when the same PDF might be used for different quantity scenarios.

hideQuantityBreaks​

hideQuantityBreaks: boolean

When true, hides the quantity break pricing tables in the PDF.

This setting removes the tiered pricing information that shows how prices change at different quantity levels. This might be preferred for simplified quotes or when volume discounts shouldn't be exposed to certain audiences.

Consider hiding quantity breaks for end-customer facing PDFs while keeping them visible for dealer or internal documentation.

hideSku​

hideSku: boolean

When true, hides the product SKU code in the PDF.

This setting removes the Stock Keeping Unit code from the PDF document. SKUs are unique identifiers that are often useful for ordering and inventory purposes but may not be relevant for all audiences.

Consider hiding SKUs in customer-facing documents while keeping them visible in internal or dealer-facing documentation.

showLogo: boolean

When true, displays the company logo in the PDF header.

This setting adds the configured company logo to the PDF document, providing brand identity and professional presentation. The logo is typically pulled from the customer's settings.

Including the logo enhances brand recognition and gives the PDF a more official, branded appearance for customer-facing documentation.