Skip to main content

Interface: SimpleProduct

Core product data with configurations, options, and metadata.

This interface represents a complete product definition with all the metadata, configuration options, and visual assets needed to display and configure the product in the configurator. It includes product identity, options, pricing settings, and display preferences.

Properties​

allowScaling?​

optional allowScaling: boolean

Controls whether scaling is allowed in AR view.

When true, the product can be scaled in Augmented Reality view.

blocks?​

optional blocks: OptionSetsBlocks

Configuration blocks and options for this product.

Defines all the customizable options available for this product.

defaultConfigurations?​

optional defaultConfigurations: ModularDefaultConfiguration<string>[]

List of default configurations for modular products.

Defines preset configurations that can be quickly applied to modular products.

disableSyncSettings?​

optional disableSyncSettings: boolean

Controls whether sync options controls are hidden in modular UI.

When true, options to synchronize settings across components are hidden.

filters?​

optional filters: GlobalFilters

Filtering tags and categories for this customer materials.

These filters can be used to categorize and organize options in filter widget.

groups?​

optional groups: BlockGroups

Option groups for this product.

Defines how configuration options are organized into logical groups.

groupsPreview​

groupsPreview: GroupsPreview

Preview settings for option groups.

Controls how option group previews are displayed in the interface.

hasRelated?​

optional hasRelated: boolean

Indicates whether this product has related products.

When true, related products are available and can be displayed.

metadata​

metadata: ProductMetadata

Core information about the product.

Includes name, description, codes, status, and classification data that identifies and categorizes the product.

pricing?​

optional pricing: PricingSettings

Pricing configuration for this product.

Defines how prices are calculated based on configuration choices.

productId​

productId: string

Unique identifier for this product.

This ID uniquely identifies the product within the system.

quickIcons?​

optional quickIcons: QuickIcons

Quick action icons for this product.

Defines shortcuts for common actions specific to this product.

scene3d?​

optional scene3d: Scene3D

Configuration for the 3D scene.

Defines how the 3D visualization is set up, including camera, lighting, and environmental settings.

showDimensions?​

optional showDimensions: boolean

Controls whether dimensions are displayed on the 3D model.

When true, measurements are shown on the 3D visualization.

showExportObj?​

optional showExportObj: boolean

Controls whether the 3D model export functionality is available.

When true, users can export the 3D model of the product.

tabs?​

optional tabs: ProductTab[]

Available tabs for this product.

Defines the tabs that provide additional information and options for this product in the configurator interface.

views?​

optional views: string[]

Available 2D views for this product.

List of view identifiers for 2D visualizations of the product.