Global

Type Definitions

ButtonOptions

Source:
Properties:
Name Type Attributes Default Description
targetElement HTMLElement

The DOM element where the button will be attached.
rounded boolean <optional>
 false

Whether the button should have rounded corners.
placement PLACEMENTS <optional>
 PLACEMENTS.LAST

Positioning of the button relative to the target element.
text string <optional>
 'Visualizer Button'

Text displayed on the button.
mainColor string <optional>
 BRAND_MAIN_COLOR

Main color of the button, typically used for the background.
secondColor string <optional>
 BRAND_SECOND_COLOR

Secondary color, used for text or accents.
borderSize number <optional>
 1

Border width for the button, in pixels.
svgElement SVGElement <optional>

Optional SVG icon to include in the button.
Type:
  • Object

ExternalCallback

Source:
See:
Type:
  • FILTER_DETAILS_PAGE_PROPS

FavoritesState

Source:
Type:

IntegrationSettings

Source:
Properties:
Name Type Attributes Default Description
uploadPhoto boolean <optional>
 true

Enables or disables the custom photo upload feature.
showCatalog boolean <optional>
 true

Shows or hides the product catalog section in the Visualizer.
showBackToWebsiteButton boolean <optional>
 true

Enables or disables the "Back to Website" button.
twoWaySyncFavorites boolean <optional>
 false

Enables or disables two way sync for favorites.
userId string <optional>

Identifier for the user interacting with the Visualizer, for tracking user sessions.
locale string <optional>

Sets the localization language for the Visualizer (e.g., "en" for English).
context string <optional>

Contextual information relevant to the current Visualizer session.
Type:
  • Object

LayingPatternCode

Source:
Type:
  • 'no_offset' | '1_2_offset' | '1_3_offset' | 'random_offset' | 'basket_weave' | 'chevron' | 'herringbone' | 'double_herringbone' | '1_2_offset_horizontal' | 'no_pattern'

Layout

Source:
See:
Type:
  • FULL_SCREEN | FILL_PARENT | CUSTOM_SIZE

LayoutSettings

Source:
Properties:
Name Type Attributes Default Description
targetElement HTMLElement

Target element for the Visualizer iframe.
layout number <optional>
 LAYOUTS.FULL_SCREEN

Layout type (from LAYOUT).
position number <optional>
 POSITION.REPLACE

Position (from POSITION).
width number <optional>

Width for custom layout.
height number <optional>

Height for custom layout.
Type:
  • Object

MimeType

Source:
See:
  • WizartDeploymentKit.MIME_TYPE for options descriptions.
Type:
  • IMAGE_JPEG | IMAGE_PNG

OptionalProperties

Source:
Properties:
Name Type Attributes Description
overlap boolean <optional>

Indicates if the product's design allows overlap.
pattern_offset number <optional>

The offset for the pattern in specified units.
repeatable boolean <optional>

Indicates if the product pattern is repeatable.
customized_size boolean <optional>

Indicates if the product can have a customized size.
preview_path string <optional>

The path to a preview image for the product.
link string <optional>

A URL link related to the product (e.g., product details).
brand_name string <optional>

A product brand name.
collection_name string <optional>

A product collection name.
Type:
  • Object

PanoramaOptions

Source:
Properties:
Name Type Attributes Description
token string

Authentication token.
layoutSettings LayoutSettings

Settings for the iframe layout.
sceneData PanoramaSceneData

Scene data (required).
onCloseCallback string <optional>

Stringified callback fired on close.
Type:
  • Object

PanoramaSceneData

Source:
Properties:
Name Type Attributes Description
vendorCode string

Product vendor code (required).
interiorName string

Room / interior name (required).
layingPatternCode LayingPatternCode <optional>

Tile laying pattern. Possible values (required):

  • no_offset – No offset
  • 1_2_offset – 1/2 offset
  • 1_3_offset – 1/3 offset
  • random_offset – Random offset
  • basket_weave – Basket weave
  • chevron – Chevron
  • herringbone – Herringbone
  • double_herringbone – Double herringbone
  • 1_2_offset_horizontal – 1/2 offset horizontal
  • no_pattern – No pattern
Type:
  • Object

Placement

Source:
See:
Type:
  • BEFORE | AFTER | REPLACE | FIRST | LAST

Position

Source:
See:
Type:
  • BEFORE | AFTER | REPLACE

ProductType

Source:
See:
Type:
  • WALLPAPER | WALL_PANEL | WALL_MURAL

SceneData

Source:
Properties:
Name Type Attributes Description
openInRoom string <optional>

UUID of the room to open by default in the Visualizer.
openWithProduct string <optional>

Identifier for a product to be preselected in the Visualizer (e.g., "Decal 01 2d").
openWithCustomProduct CustomProduct <optional>

CustomProduct instance to be preselected in the Visualizer.
openWithCollection string <optional>

Name of the collection to preselect in the product catalog (e.g., "Carpet Rolls").
Type:
  • Object

ShoppingCartProduct

Source:
Properties:
Name Type Description
vendor_code VendorCode
quantity number

ShoppingCartState

Source:
Type:

TooltipDirection

Source:
See:
Type:
  • TOP | BOTTOM

TooltipOptions

Source:
Properties:
Name Type Attributes Default Description
mainColor string

HTML color cede.
secondColor string

HTML color code.
direction TooltipDirection <optional>
 WizartDeploymentKit.TOOLTIP_DIRECTION.TOP

side where tooltip will appear.
borderSize number <optional>
 1

value for border-width.
text Array.<string> <optional>
 ['Photograph your wall.', 'Choose a pattern.', 'See it in your space digitally.']

Tooltip items text.
Type:
  • Object

VendorCode

Description:

  • Product sku.

Source:

Product sku.

Type:
  • string

VisualizerEvent

Description:

  • Events produced by Visualizer.

Source:
See:

Events produced by Visualizer.

Type:
  • BACK_BUTTON_CLICKED | GALLERY_OPENED | GALLERY_CLOSE | PREDEFINED_INTERIOR_SELECT | USER_SESSION_START | USER_SESSION_END | PRODUCT_SELECT | PRODUCT_APPLY | SURFACE_SELECT | PRODUCT_DETAIL_OPEN | PRODUCT_DETAIL_CLOSE | ADD_TO_CART | CART_PRODUCT_COUNT_INCREASE | CART_PRODUCT_CART_DECREASE | REMOVE_FROM_CART | ADD_TO_FAVORITES | REMOVE_FROM_FAVORITES | BRAND_SELECT | COLLECTION_SELECT | HISTORY_OPEN | HISTORY_CLOSE | FAVORITES_OPEN | FAVORITES_CLOSE | SHOPPING_CART_OPEN | SHOPPING_CART_CLOSE | DOWNLOAD_MENU_OPEN | DOWNLOAD_RESULT | CLEAR_SURFACE | ZOOM_IMAGE | CUSTOM_INTERIOR_SELECTION_START | CUSTOM_INTERIOR_UPLOAD | CUSTOM_INTERIOR_DELETE | CUSTOM_INTERIOR_SELECT | GALLERY_FILTER_APPLY | USER_INIT | CHECKOUT_OPTIONS_OPEN | CHECKOUT_OPTIONS_CLOSE | CART_REMINDER_OPEN | FAVORITES_STATE_CHANGE | SHOPPING_CART_STATE_CHANGE

VisualizerOptions

Source:
Properties:
Name Type Attributes Default Description
token string

Authentication token for the Visualizer.
layoutSettings LayoutSettings

Settings for the Visualizer's layout.
integrationSettings IntegrationSettings <optional>
 {}

Additional integration settings.
sceneData SceneData <optional>
 {}

Initial data to load in the Visualizer.
load boolean <optional>
 true

Whether to load the iframe on Visualizer instance creation.
Type:
  • Object