Skip to main content

Interface: PdfDocumentTabConfiguration

Document tab data for the Configuration section of a PDF.

This interface represents the prepared data for the main configuration summary tab in a product PDF. It includes all selected options, pricing, product images, and other configuration details that form the core of the product specification.

The configuration tab is typically the most important section of product documentation, providing a comprehensive overview of the exact product being ordered.

Extends​

Properties​

CDNPath​

CDNPath: string

Domain for all relative resources url's

Inherited from​

PdfDocumentTabGeneric.CDNPath

content?​

optional content?: string | object

The content to display within this tab.

This can be structured data or text, with the format varying based on the tab type. For text tabs, this contains the description; for other tab types, it may contain specialized structured content.

Inherited from​

PdfDocumentTabGeneric.content

currency​

currency: string

Currency in which price is

Inherited from​

PdfDocumentTabGeneric.currency

customerId​

customerId: string

Customer ID

Inherited from​

PdfDocumentTabGeneric.customerId

optional customerLogo?: string

Absolute URL to logo for header

Inherited from​

PdfDocumentTabGeneric.customerLogo

deliveryTime?​

optional deliveryTime?: string

Product delivery time

Inherited from​

PdfDocumentTabGeneric.deliveryTime

descriptionText?​

optional descriptionText?: string

Product description text.

Provides a textual overview of the product that may include key features, benefits, or general information about the product line.

discount?​

optional discount?: number

Product price discount percentage

Inherited from​

PdfDocumentTabGeneric.discount

elements?​

optional elements?: ModularElement[]

List of components in a modular product.

For modular products, this contains details about all the individual components that make up the configured assembly.

enableForPdf?​

optional enableForPdf?: YesNoValue

Controls whether this tab should be included in PDF exports.

When set to YES, content from this tab will be incorporated when generating PDF documents of the product configuration.

Inherited from​

PdfDocumentTabGeneric.enableForPdf

files?​

optional files?: TabFile[]

List of files to make available in this tab.

Used for DOWNLOADS tab type to provide downloadable resources related to the product, such as manuals or CAD files.

Inherited from​

PdfDocumentTabGeneric.files

filters?​

optional filters?: GlobalFilters

Global filter categorizations.

Provides categorization information that can help organize and filter the product options in a consistent way.

galleryId?​

optional galleryId?: string

The ID of the gallery associated with this tab.

Only used for tabs of type GALLERY, this references the specific gallery to display in this tab.

Inherited from​

PdfDocumentTabGeneric.galleryId

id​

id: string

A unique identifier for this tab.

This ID is used to reference the tab in code and to maintain tab selection state across configuration changes.

Inherited from​

PdfDocumentTabGeneric.id

imageDimensions?​

optional imageDimensions?: Dimensions

Size dimensions of the loaded product image.

This helps with proper layout and scaling of the image within the PDF document while maintaining aspect ratio.

images?​

optional images?: string[]

List of URLs to all generated image shots for the product.

These are high-quality rendered images showing the product with all selected options applied, providing visual confirmation of how the configured product will appear.

Depending on settings they may contain dimensions too.

imageSrc?​

optional imageSrc?: string

URL to the main product visualization image.

This high-quality rendered image shows the product with all selected options applied, providing visual confirmation of how the configured product will appear.

Depending on settings they may contain dimensions too.

isModular?​

optional isModular?: boolean

If true, PDF is generated for modular product

Inherited from​

PdfDocumentTabGeneric.isModular

materials?​

optional materials?: TabMaterial[]

List of materials to display in this tab.

Used for tabs that showcase material options or finishes, providing detailed material information.

Inherited from​

PdfDocumentTabGeneric.materials

pdfVisibilityConfig?​

optional pdfVisibilityConfig?: EmbedTemplatePDFSettings

Visibility settings for PDF elements

Inherited from​

PdfDocumentTabGeneric.pdfVisibilityConfig

popularConfigItemNameType?​

optional popularConfigItemNameType?: PopularConfigItemNameType

Inherited from​

PdfDocumentTabGeneric.popularConfigItemNameType

popularConfigShowPrice?​

optional popularConfigShowPrice?: boolean

Inherited from​

PdfDocumentTabGeneric.popularConfigShowPrice

popularConfigType?​

optional popularConfigType?: PopularConfigType

Type of popular configurations to display.

Used for POPULAR_STATIC tab type to determine how popular configurations are sourced and displayed.

Inherited from​

PdfDocumentTabGeneric.popularConfigType

popularConfigurations?​

optional popularConfigurations?: PopularConfiguration<string>[]

List of popular configurations to display.

Used for POPULAR_STATIC tab type to showcase recommended or frequently used configurations of the product.

Inherited from​

PdfDocumentTabGeneric.popularConfigurations

price?​

optional price?: number

Total price for selected configuration for selected quantity

Inherited from​

PdfDocumentTabGeneric.price

priceType​

priceType: PriceTypeEnum

Type of selected price

Inherited from​

PdfDocumentTabGeneric.priceType

productName​

productName: string

Product name

Inherited from​

PdfDocumentTabGeneric.productName

quantity?​

optional quantity?: number

Selected quantity. In case if quantity is hidden in configurator it will be undefined

Inherited from​

PdfDocumentTabGeneric.quantity

quantityBreaks?​

optional quantityBreaks?: PriceLevel[]

Volume-based pricing tiers.

Shows how the product price varies at different quantity levels, helping customers understand potential volume discounts.

selectedOptions?​

optional selectedOptions?: PDFVisibleBlock[]

List of all selected options for the configuration.

This detailed breakdown shows all the customization choices made for this product configuration, organized by option category.

sku?​

optional sku?: string

SKU code of product if configured

Inherited from​

PdfDocumentTabGeneric.sku

tabName​

tabName: string

The display name for this tab.

This text appears in the tab navigation to identify this tab to users (e.g., "Specifications", "Gallery", "Documents").

Inherited from​

PdfDocumentTabGeneric.tabName

tabType​

tabType: CONFIGURATOR

Identifies this as a configuration tab.

Overrides​

PdfDocumentTabGeneric.tabType

thumbnail?​

optional thumbnail?: string

URL to a smaller product thumbnail.

This may be used for headers, navigation, or secondary placements where the full-size image would be too large.

unitPrice?​

optional unitPrice?: number

Price for single unit

Inherited from​

PdfDocumentTabGeneric.unitPrice

vatType​

vatType: VatType

Price vat type

Inherited from​

PdfDocumentTabGeneric.vatType