WizartDeploymentKit

Namespace

WizartDeploymentKit

Source:

Classes

CustomProduct
Panorama
Visualizer
WizartEvent

Namespaces

EventBus

Members

(static, constant) EXTERANL_CALLBACKS :ExternalCallback

Description:

  • External callbacks supported by Visualizer.

Source:
Properties:
Name Type Description
FILTER_DETAILS_PAGE_PROPS ExternalCallback

External callbacks supported by Visualizer.

Type:

(static, constant) LAYOUTS :Layout

Description:

  • Layout types supported by Visualizer.

Source:
Properties:
Name Type Description
FULL_SCREEN Layout

Attach the button before the target element.
FILL_PARENT Layout

Attach the button after the target element.
CUSTOM_SIZE Layout

Replace the target element with the button.

Layout types supported by Visualizer.

Type:

(static, constant) MIME_TYPES :MimeType

Description:

  • Define supported MIME types for custom product textures.

Source:
Properties:
Name Type Description
IMAGE_JPEG MimeType

image jpeg format
IMAGE_PNG MimeType

image png format

Define supported MIME types for custom product textures.

Type:

(static, constant) PLACEMENTS :Placement

Description:

  • Defines possible placement options for attaching a button to a target element in the DOM.

Source:
Properties:
Name Type Description
BEFORE Placement

Attach the button before the target element.
AFTER Placement

Attach the button after the target element.
REPLACE Placement

Replace the child elements with the button.
FIRST Placement

Replace the child elements with the button.
LAST Placement

Attach the button as the last child of the target element.

Defines possible placement options for attaching a button to a target element in the DOM.

Type:

(static, constant) POSITIONS :Position

Description:

  • Defines possible placement options for attaching a Visualizer to a target DOM element.

Source:
Properties:
Name Type Description
BEFORE Position

Attach the Visualizer before the target element.
AFTER Position

Attach the Visualizer after the target element.
REPLACE Position

Replace the child elements with the Visualizer.

Defines possible placement options for attaching a Visualizer to a target DOM element.

Type:

(static, constant) PRODUCT_TYPES :ProductType

Description:

  • Define product types supported by Visualizer for custom products.

Source:
Properties:
Name Type Description
WALLPAPER ProductType

Wallpaper product.
WALL_PANEL ProductType

Wall panel product
WALL_MURAL ProductType

Wall mural

Define product types supported by Visualizer for custom products.

Type:

(static, constant) TOOLTIP_DIRECTIONS :TooltipDirection

Description:

  • Tooltip direction.

Source:
Properties:
Name Type Description
TOP TooltipDirection

Tooltip appears above of button.
BOTTOM TooltipDirection

Tooltip appears below of button.

Tooltip direction.

Type:

(static, constant) VISUALIZER_EVENTS :VisualizerEvent

Description:

  • Events produced by Visualizer.

Source:
Properties:
Name Type Description
BACK_BUTTON_CLICK VisualizerEvent

Triggered when the back button is clicked.
GALLERY_OPEN VisualizerEvent

Triggered when the gallery is opened.
GALLERY_CLOSE VisualizerEvent

Triggered when the gallery is closed by the user.
PREDEFINED_INTERIOR_SELECT VisualizerEvent

Triggered when a predefined interior is selected.
USER_SESSION_START VisualizerEvent

Triggered when a user session starts.
USER_SESSION_END VisualizerEvent

Triggered when a user session ends.
PRODUCT_SELECT VisualizerEvent

Triggered when porduct selected in the catalog.
PRODUCT_APPLY VisualizerEvent

Triggered when a product is applied to the surface.
SURFACE_SELECT VisualizerEvent

Triggered when a surface is selected.
PRODUCT_DETAIL_OPEN VisualizerEvent

Triggered when a product detail page is opened.
PRODUCT_DETAIL_CLOSE VisualizerEvent

Triggered when a product detail page is closed.
ADD_TO_CART VisualizerEvent

Triggered when a product is added to the shopping cart.
CART_PRODUCT_COUNT_INCREASE VisualizerEvent

Triggered when a cart product count increased
CART_PRODUCT_CART_DECREASE VisualizerEvent

Triggered when a cart product count decreased
REMOVE_FROM_CART VisualizerEvent

Triggered when a product is removed from the shopping cart.
ADD_TO_FAVORITES VisualizerEvent

Triggered when a product is added to favorites.
REMOVE_FROM_FAVORITES VisualizerEvent

Triggered when a product is removed from favorites.
BRAND_SELECT VisualizerEvent

Triggered when a brand is selected.
COLLECTION_SELECT VisualizerEvent

Triggered when a collection is selected.
HISTORY_OPEN VisualizerEvent

Triggered when the user opens their history section.
HISTORY_CLOSE VisualizerEvent

Triggered when the user closes their history section.
FAVORITES_OPEN VisualizerEvent

Triggered when the favorites section is opened.
FAVORITES_CLOSE VisualizerEvent

Triggered when the favorites section is closed.
SHOPPING_CART_OPEN VisualizerEvent

Triggered when the shopping cart is opened.
SHOPPING_CART_CLOSE VisualizerEvent

Triggered when the shopping cart is closed.
CHECKOUT_OPTIONS_OPEN VisualizerEvent

Triggered when proceed to checkout is clicked.
CHECKOUT_OPTIONS_CLOSE VisualizerEvent

Triggered when checkout options is closed.
CART_REMINDER_OPEN VisualizerEvent

Triggered when cart reminder is opened.
DOWNLOAD_MENU_OPEN VisualizerEvent

Triggered when the download menu is opened.
DOWNLOAD_RESULT VisualizerEvent

Triggered when the result is downloaded.
CLEAR_SURFACE VisualizerEvent

Triggered when the clear surface button is clicked.
ZOOM_IMAGE VisualizerEvent

Triggered when an image is zoomed in.
CUSTOM_INTERIOR_SELECTION_START VisualizerEvent

Triggered when the selection of a custom interior begins.
CUSTOM_INTERIOR_UPLOAD VisualizerEvent

Triggered when a custom interior is uploaded.
CUSTOM_INTERIOR_DELETE VisualizerEvent

Triggered when a custom interior is deleted.
CUSTOM_INTERIOR_SELECT VisualizerEvent

Triggered when a custom interior is selected.
GALLERY_FILTER_APPLY VisualizerEvent

Triggered when filters are applied in the gallery.
USER_INIT VisualizerEvent

Triggered during user initialization.
FAVORITES_STATE_CHANGE VisualizerEvent

Triggered when favorites state changed.
SHOPPING_CART_STATE_CHANGE VisualizerEvent

Triggered when shoping cart state changed.
SHOPPING_CART_STATE VisualizerEvent

Triggered when DeploymentKit ask Visualizer about shopping cart state.

Events produced by Visualizer.

Type:

Methods

(static) addTooltip(buttonElement, options)

Description:

  • Adds tooltip to the button.

Source:
Example
WizartDeploymentKit.addTooltip(openVisualizerButton.element, { direction: WizartDeploymentKit.TOOLTIP_DIRECTION.BOTTOM });
Parameters:
Name Type Description
buttonElement HTMLElement
options TooltipOptions

The tooltip settings.

(static) createButton(options) → {Button}

Description:

  • Creates and inserts a predefined Wizart button element into the DOM.

Source:
Example
const targetElement = document.getElementById('button-open');
const openVisualizerButton = WizartDeploymentKit.createButton({targetElement: targetElement, text: 'See product in your room'});
openVisualizerButton.onClick(() => visualizer.show());
Parameters:
Name Type Description
options ButtonOptions

The options for the Visualizer instance.
Returns:

The created button instance.

Type
Button

(static) formatBase64ImageSrc(base64, mimeTypeopt) → {string}

Description:

  • Formats a base64-encoded string as a complete image source URL for use in HTML image tags.

Source:
Example
const imageUrl = formatBase64ImageSrc("iVBORw0KGgoAAAANSUhEUgAA...", WizartDeploymentKit.MIME_TYPE.IMAGE_PNG);
// Returns: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
Parameters:
Name Type Attributes Default Description
base64 string

The base64-encoded image data.
mimeType MimeTipe <optional>
 MIME_TYPES.IMAGE_PNG

The MIME type of the image (e.g., "image/png" or "image/jpeg"). Defaults to PNG if not specified.
Returns:

A formatted data URL combining the specified MIME type and base64 image data, ready for use as a src attribute in image elements.

Type
string