Skip to main content

Interface: Actions

Configurator related actions. You can call them to either interact with scene or configuration or get/process some data from observers

AugmentedReality​

generateAR​

generateAR: GenerateAR

Trigger generation of AR model and get shortcode to it

Returns​

On success returns string with ar shortcode

getARShortCodeData​

getARShortCodeData: GetARShortCodeData

Get data for AR short code

Param​

AR short code

Param​

If true, in case paths to models are not yet generated it will return subscription which will resolve with said paths.

Returns​

AR short code data

regenerateAR​

regenerateAR: RegenerateAR

Trigger re-generation of AR model and get shortcode to it in case if generation failed

Param​

Already generated AR data

Returns​

On success returns string with ar shortcode

showAR​

showAR: ShowAR

Open current scene in AR. For desktop application opens modal with generated QR code/link with short code for given scene. On mobile device sets window.location.href to generated url for AR app.

Fires​

@mimeeq-internal-show-ar

Authentication​

havePermissions​

havePermissions: HavePermissions

Check in ConfigurationStore if user posses any of passed permissions

Param​

Array of permission to check

Basket​

prepareCartImage​

prepareCartImage: PrepareCartImage

Returns relative path to CDN for cart product image. In case of error returns null

Param​

Base64 of image

Param​

Cart id

Param​

Cart item id

Returns​

If success, returns relative path to CDN. In case of error returns null

triggerFinishEvent​

triggerFinishEvent: TriggerFinishEvent

Trigger finish button events

Param​

Configurator variant. Can be basket or selector. Depending on event will dispatch different mimmeq event. basket - triggers @mimeeq-add-to-cart event, selector - triggers mimeeq-select-product, other will dispatch mimeeq-show-summary. All events emit with payload details object.

CameraControl​

decreaseZoom​

decreaseZoom: DecreaseZoom

Decrease the zoom level of a 3D scene camera by a configurable amount or a default value, by adjusting the radius of the camera.

Param​

Amount to adjust the radius of the camera.

freezeCanvasScrolling​

freezeCanvasScrolling: FreezeCanvasScrolling

Disable scrolling on canvas. This function modifies the behavior of the camera and input controls in the Babylon.js scene to prevent users from scrolling or zooming the canvas. In case you want to change camera zoom please use increaseZoom, decreaseZoom or setZoom methods. It also sets global variable on window.freezeScroll which is used in useBabylon hook.

increaseZoom​

increaseZoom: IncreaseZoom

Increase the zoom level of a 3D scene camera by a configurable amount or a default value, by adjusting the radius of the camera.

Param​

Amount to adjust the radius of the camera.

restoreCameraPosition​

restoreCameraPosition: RestoreCameraPosition

At 3d restore active camera position to initial state or to provided settings.

Param​

custom camera position

setSceneInputCanvas​

setSceneInputCanvas: SetSceneInputCanvas

Use this to set new canvas as target for all interactions. You can only manipulate one canvas at a time so this should be your primary canvas in most cases.

Param​

Canvas element to attach events to

setZoom​

setZoom: SetZoom

Set specific zoom value for the scene. Retrieves the active camera from the Babylon.js scene and sets new radius of the camera.

Param​

New zoom value

unfreezeCanvasScrolling​

unfreezeCanvasScrolling: UnfreezeCanvasScrolling

Re-enable scrolling on canvas. Undo modifications done by freezeCanvasScrolling, restores the original scrolling and zooming behavior of the canvas, allowing the user to interact with the 3D scene as intended. It also sets global variable on window.freezeScroll to false, which is used in useBabylon() hook.

unregisterSceneCanvasView​

unregisterSceneCanvasView: UnregisterSceneCanvasView

Register new canvas to babylon scene views. It will be using the same camera as primary canvas.

Param​

Canvas element to be registered

zoomOut​

zoomOut: ZoomOut

Zoom out scene to see whole product. Dispatches applyCameraZoomAll webGl state task.

Fires​

@mimeeq#mimeeq-3d-zoom-out-scene

Canvas​

freezeCanvasScrolling​

freezeCanvasScrolling: FreezeCanvasScrolling

Disable scrolling on canvas. This function modifies the behavior of the camera and input controls in the Babylon.js scene to prevent users from scrolling or zooming the canvas. In case you want to change camera zoom please use increaseZoom, decreaseZoom or setZoom methods. It also sets global variable on window.freezeScroll which is used in useBabylon hook.

registerSceneCanvasView​

registerSceneCanvasView: RegisterSceneCanvasView

Register new canvas to babylon scene views. It will be using the same camera as primary canvas.

Param​

HTMLCanvas element to be registered

setSceneInputCanvas​

setSceneInputCanvas: SetSceneInputCanvas

Use this to set new canvas as target for all interactions. You can only manipulate one canvas at a time so this should be your primary canvas in most cases.

Param​

Canvas element to attach events to

unfreezeCanvasScrolling​

unfreezeCanvasScrolling: UnfreezeCanvasScrolling

Re-enable scrolling on canvas. Undo modifications done by freezeCanvasScrolling, restores the original scrolling and zooming behavior of the canvas, allowing the user to interact with the 3D scene as intended. It also sets global variable on window.freezeScroll to false, which is used in useBabylon() hook.

unregisterSceneCanvasView​

unregisterSceneCanvasView: UnregisterSceneCanvasView

Register new canvas to babylon scene views. It will be using the same camera as primary canvas.

Param​

Canvas element to be registered

Exporters​

exportGlb​

exportGlb: ExportGLB

Export scene to glb. It triggers browser download action and returns true

Fires​

@mimeeq#mimeeq-3d-before-export-scene

Fires​

@mimeeq#mimeeq-3d-after-export-scene

exportObj​

exportObj: ExportOBJ

Export scene to obj. It triggers browser download action and returns true. Under the hood it uses exportScene() function with mode parameter 2.

Fires​

@mimeeq#mimeeq-3d-before-export-scene

Fires​

@mimeeq#mimeeq-3d-after-export-scene

exportStl​

exportStl: ExportSTL

Export scene to stl. It triggers browser download action and returns true

Fires​

@mimeeq#mimeeq-3d-before-export-scene

Fires​

@mimeeq#mimeeq-3d-after-export-scene

saveImage​

saveImage: SaveImage

Trigger current scene screenshot download. Default extension is .jpg and width in pixels is 3072px. *

Fires​

@mimeeq#mimeeq-3d-after-export-image *

Fires​

@mimeeq#mimeeq-3d-before-export-image *

Param​

Extension to save image with Extension to save image with, default is .jpg *

Param​

Expected image width in pixels. Height will prevail current canvas ratio. Default is 3072px *

Param​

Background color for JPEG image. If not value is provided it will use current canvas background *

showExportImageModal​

showExportImageModal: ShowExportImageModal

Open image export modal. Under the hood uses useToggle() hook.

Fires​

@mimeeq-internal-show-export-image

showExportModal​

showExportModal: ShowExportModal

Open model export modal. Under the hood uses useToggle() hook.

Fires​

@mimeeq-internal-show-export

showExportPDF​

showExportPDF: ShowExportPDF

Open PDF generator modal. Under the hood uses useToggle() hook to handle modal visibility.

Fires​

@mimeeq-internal-show-export-pdf

Favourites​

createFavouriteCollection​

createFavouriteCollection: CreateFavouriteCollection

Create new favourite collection

Param​

Name of the collection

Param​

Type of the collection

Fires​

@mimeeq#mimeeq-favourites-add-collection

Returns​

If false creation was unsuccessful, otherwise it will return collection id

getFavouriteCollections​

getFavouriteCollections: GetFavouriteCollections

Returns list of all available/existing favourite collections for current user. Dispatches SET_FAV_COLLECTIONS redux action.

getFavouriteItems​

getFavouriteItems: GetFavouriteItems

Returns list of all items in favourites for current user (private and public). Dispatches SET_FAVOURITES redux action

openSaveSceneAs​

openSaveSceneAs: OpenSaveSceneAs

Trigger to open Save Scene as modal on modular product. Under the hood uses useToggle() hook.

Fires​

@mimeeq-internal-show-modular-save-as

saveFavouriteConfiguration​

saveFavouriteConfiguration: SaveFavouriteConfiguration

Update favourite configuration (only for regular products). Retrieves favourite collections from store, filters exisitng favourite collection state (if exists) and updates it selectively (removes redundant items and puts the new ones). Posts data (favourites toPut and toDelete ) to favoriteService /update-favourite-in-configurator endpoint. Calls internally getFavouriteItems() function ro update app state

Param​

Configuration code to update

Param​

Favourite collection ids

Fires​

@mimeeq#mimeeq-favourites-remove-product

Fires​

@mimeeq#mimeeq-favourites-add-product

Returns​

If true save was successful

saveFavouriteScene​

saveFavouriteScene: SaveFavouriteScene

Update actually loaded scene with current state. It checks if entry exists by given shortcode by calling matchFavuorite(). If given entry doesn't exists it returns false. If it exists it calls getFavouriteItems() function to update app state,updateImageModular() function to update scene image and returns true

Fires​

@mimeeq#mimeeq-modular-save-scene

Returns​

If true save was successful

saveFavouriteSceneAs​

saveFavouriteSceneAs: SaveFavouriteSceneAs

Save current scene under new name. Calls favouriteService /add-to-favourites endpoint. Dispatches SET_LOADED_SCENE_NAME Redux action after successful call and returns true. Before calling favouriteService creates product short code calling productService /create-short-code endpoint. If call fails returns false.

Param​

Scene name

Param​

Favourite collection ids

Fires​

@mimeeq#mimeeq-modular-save-scene

Returns​

If true save was successful

History​

goBack​

goBack: HistoryGoBack

Revert last change in configurator. Dispatches SET_CURRENT_HISTORY_ITEM Redux action.

Fires​

@mimeeq#mimeeq-history-go-back

Fires​

@mimeeq#mimeeq-app-url-change

Fires​

@mmq-app-url-change-sandbox

redo​

redo: HistoryRedo

Redo next history action in configurator. Calls updateModularHistory() if modular and dispatches SET_CURRENT_HISTORY_ITEM Redux action.

Fires​

@mimeeq#mimeeq-history-go-forward

Fires​

@mimeeq#mimeeq-app-url-change

Fires​

@mmq-app-url-change-sandbox

reset​

reset: HistoryReset

Go back to initial configuration in configurator. Dispatches CLEAR_HISTORY Redux action.

Fires​

@mimeeq#mimeeq-app-url-change

Fires​

@mimeeq#mimeeq-history-reset

Fires​

@mmq-app-url-change-sandbox

Hotspots​

get3dInformationTemplate​

get3dInformationTemplate: Get3dInformationTemplate

Get data for 3d information template connected to passed meshId

Param​

If of mesh we want to display template for

Returns​

Template data

Modular​

markOptionModular​

markOptionModular: MarkOptionModular

Select option at modular on currently selected product(s). *

Fires​

@mimeeq#mimeeq-modular-select-option-multiple *

Fires​

@mimeeq#mimeeq-modular-select-option *

Param​

Option object to select *

Param​

Id of block *

Param​

Type of widget the block is using *

Param​

If true it will try to match selected option in other blocks within this block group *

Param​

Block name, it's used to run autosync rule *

openFinishModal​

openFinishModal: OpenFinishModal

Call it to open list of all elements on scene and tabs. Checks validity of modal elements with checkModularConfigValidity() and uses useToggle() under the hood.

Fires​

@mimeeq#mimeeq-show-modular-summary

ModularControl​

cancelOperations​

cancelOperations: CancelOperations

Cancel all active operations on models like adding new, clone or move.

Fires​

@mimeeq#mimeeq-modular-abort-adding

checkCanMove​

checkCanMove: CheckCanMove

Check if passed instance can be moved to other place on the scene

Param​

ID of instance to check

Returns​

If true, element can be moved to different point

chooseProductToAdd​

chooseProductToAdd: ChooseProductToAdd

Select passed product as currently being added to scene. It will display add icons on all places you can insert this item.

clearScene​

clearScene: ClearScene

Remove all resources from scene and start from the scratch. Dispatches RESET_MODULAR, CLEAR_MODULAR_PRICES, CLEAR_PRODUCTS, SET_LOADED_SHORTCODE (with null argument), CLEAR_MODULAR_HISTORY (with undefined argument) Redux actions. If there were settings for modular, dispatches mimeeq-internal-clear-scene event product starter config (first time). Otherwise dispatches CLEAR_SCENE Redux action.

Fires​

@mimeeq#mimeeq-modular-clear-scene

copyStyles​

copyStyles: CopyStyles

Activate style copying from currently selected element

Fires​

@mimeeq#mimeeq-modular-set-copy-styles

deselectAllModels​

deselectAllModels: DeselectAllModels

Deselect all models on the scene. Dispatches DELECT_ALL webGl task.

Fires​

@mimeeq#mimeeq-modular-unselect-all

enableClone​

enableClone: EnableClone

Enable clone of currently selected model. Only one product can have active clone at once so activating it for new model will deactivate it for other. Under the hood it checks allowClone product settings prop. If cloning is possible dispatches UPDATE_MODULAR_STATE Redux action and calls selectSnappingPoint() function which handles cloning logic.

Fires​

@mimeeq#mimeeq-modular-set-clone

enableMove​

enableMove: EnableMove

Enable move of currently selected model. Only one product can have active move at once so activating it for new model will deactivate it for other.

Fires​

@mimeeq#mimeeq-modular-set-move

enableReplace​

enableReplace: EnableReplace

Enable replace mode in which it shows list of products which can replace selected element while keeping all connections in place

Fires​

@mimeeq#mimeeq-modular-set-replace

flipProduct​

flipProduct: FlipProduct

Flip/rotate selected product to use different snapping point connection

Fires​

@mimeeq#mimeeq-modular-flip-product

getBoundingBoxPosition2d​

getBoundingBoxPosition2d: GetBoundingBoxPosition2d

Get bounding box position for passed element

Param​

ID of element to get bounding for

Returns​

Record with position and sizing of bounding box or null

getModularShareUrl​

getModularShareUrl: GetModularShareUrl

Generate link to current modular configurator. In not modular configurator returns null

Param​

If true, it will return shortCode only instead of full url

hoverProductForAction​

hoverProductForAction: HoverProductForAction

Show add icons on all places you can place passed item

openLoadSceneModal​

openLoadSceneModal: OpenLoadSceneModal

Trigger this to open Scene picker. Uses scene from myScene state and useToggle() hook.

Fires​

@mimeeq-internal-load-scene

pasteStyles​

pasteStyles: PasteStyles

Paste styles from style source to currently selected element

removeSelected​

removeSelected: RemoveProducts

Remove all selected products from scene. Checks if general settings allow to delete products (isDisableDelete and allowRemove props) and if product was not auto inserted checkIsAutoInserted(). Dispatches REMOVE_PRODUCTS Redux actions with product ids.

Fires​

@mimeeq#mimeeq-modular-remove-product

selectElement​

selectElement: SelectElement

Select product as active. It will highlight it.

Param​

UId of product to select

toggleApplyOptionsForAll​

toggleApplyOptionsForAll: ToggleApplyOptionsForAll

Toggle state for applying all selected options for all products on the scene

toggleApplyOptionsForInstances​

toggleApplyOptionsForInstances: ToggleApplyOptionsForInstances

Toggle state for applying all selected options for all instances of passed product on scene

Param​

ID of product to change state for

toggleGrid​

toggleGrid: ToggleGrid

Toggle grid on scene. Dispatches SET_SCENE_SETUP and SHOW_GRID Redux actions.

Fires​

@mimeeq#mimeeq-modular-show-grid

Fires​

@mimeeq#mimeeq-modular-hide-grid

toggleSlide​

toggleSlide: ToggleSlide

Activate/deactivate slide for currently selected product. Take a note not all products has slide available.

Fires​

@mimeeq#mimeeq-modular-set-slide

triggerFinishEvent​

triggerFinishEvent: TriggerFinishEvent

Trigger finish button events

Param​

Configurator variant. Can be basket or selector. Depending on event will dispatch different mimmeq event. basket - triggers @mimeeq-add-to-cart event, selector - triggers mimeeq-select-product, other will dispatch mimeeq-show-summary. All events emit with payload details object.

OptionSelection​

filterOptions​

filterOptions: FilterOptions

Filter list of options against selected filters

Param​

List of block options

Param​

List of selected filters

Returns​

List of filtered options

markOption​

markOption: MarkOption

Select single option

Param​

Option object to select

Param​

Id of block

Param​

Type of widget the block is using

Param​

If true it will try to match selected option in other blocks within this block group

Param​

Block name of the block

Fires​

@mimeeq#mimeeq-select-option

Fires​

@mimeeq#mimeeq-app-url-change

markOptionByBlockNameAndOptionCode​

markOptionByBlockNameAndOptionCode: MarkOptionByBlockNameAndOptionCode

Marks option by block name and option code.

Param​

Block name of block which option is a part of

Param​

Code of option to be selected

Fires​

@mimeeq#mimeeq-select-option

Fires​

@mimeeq#mimeeq-app-url-change

prepareFilterOptions​

prepareFilterOptions: PrepareFilterOptions

Prepare list of available filters with count of affected options

Param​

List of all filters configured for customer

Param​

List of available options

Param​

List of currently selected filters

Returns​

Map of possible filters

toggleApplyOptionsForAll​

toggleApplyOptionsForAll: ToggleApplyOptionsForAll

Toggle state for applying all selected options for all products on the scene

toggleApplyOptionsForInstances​

toggleApplyOptionsForInstances: ToggleApplyOptionsForInstances

Toggle state for applying all selected options for all instances of passed product on scene

Param​

ID of product to change state for

OptionSelection​

markOptionModular​

markOptionModular: MarkOptionModular

Select option at modular on currently selected product(s). *

Fires​

@mimeeq#mimeeq-modular-select-option-multiple *

Fires​

@mimeeq#mimeeq-modular-select-option *

Param​

Option object to select *

Param​

Id of block *

Param​

Type of widget the block is using *

Param​

If true it will try to match selected option in other blocks within this block group *

Param​

Block name, it's used to run autosync rule *

Other​

addItemToCart​

addItemToCart: AddItemToCart

Adds an item to the specified cart.

Param​

The CartItem object containing details of the item to be added to the cart.

Returns​

A promise that resolves when the item has been successfully added to the cart.

Example usage:

const newItem: CartItem = { ... };
await window.mimeeqApp.actions.addItemToCart(newItem);
console.log('Item added to cart');

createCart​

createCart: CreateCart

Creates a new cart and returns its unique identifier.

Returns​

A promise that resolves to an object containing the new cart ID.

Example usage:

const newCart = await window.mimeeqApp.actions.createCart();
console.log(newCart.cartId);

getCartForPreview​

getCartForPreview: GetCartForPreview

Retrieves the cart data formatted for email preview purposes. This includes details such as customer information, cart items, and pricing.

Param​

The unique identifier for the cart.

Returns​

A promise that resolves to a CartForEmail object containing comprehensive details of the cart, ready for email presentation.

Example usage:

const cartPreview = await window.mimeeqApp.actions.getCartForPreview('cart123');
console.log(cartPreview);

getCartItems​

getCartItems: GetCartItems

Retrieves the items in the specified cart.

Param​

The unique identifier for the cart.

Returns​

A promise that resolves to a GetCartItemsResponse, which is either an array of CartItem or an object indicating the cart is closed.

Example usage:

const cartItems = await window.mimeeqApp.actions.getCartItems('cart123');
console.log(cartItems);

getCartSubmissionForm​

getCartSubmissionForm: GetCartSubmissionFormAction

preSubmitCart​

preSubmitCart: PreSubmitCart

Stores contact information for cart submission without submitting cart.

Param​

The unique identifier for the cart.

Param​

The contact information payload for the submission.

Returns​

A promise that resolves to a boolean saying if it was success or not.

Throws​

Error Will throw an error if cartId or submitData is missing.

recalculateCart​

recalculateCart: RecalculateCart

Recalculates the cart items based on the provided parameters, such as company ID, price type, and price list group.

Param​

The unique identifier for the cart.

Param​

(Optional) The company ID to use for recalculation.

Param​

(Optional) The price type to use for recalculation.

Param​

(Optional) The price list group to use for recalculation.

Param​

(Optional) ID of currently used embed template

Returns​

A promise that resolves to an array of CartItem with updated information.

Example usage:

const updatedCartItems = await window.mimeeqApp.actions.recalculateCart('cart123', 'company789', 'retail', 'groupA');
console.log(updatedCartItems);

removeCartItem​

removeCartItem: RemoveCartItem

Removes a specified item from the cart.

Param​

The unique identifier for the cart.

Param​

The unique identifier for the cart item to be removed.

Returns​

A promise that resolves when the item has been successfully removed from the cart.

Example usage:

await window.mimeeqApp.actions.removeCartItem('cart123', 'item456');
console.log('Item removed from cart');

rotateModel​

rotateModel: RotateModel

Rotate freely movable element by given angle

Param​

Angle by which to rotate model

submitCart​

submitCart: SubmitCart

Submits the cart with the provided contact information.

Param​

The unique identifier for the cart.

Param​

The contact information payload for the submission.

Returns​

A promise that resolves to a CartSubmitResult containing the reference code for the submission.

Example usage:

const submitData: BasketSubmissionData = { ... };
const result = await window.mimeeqApp.actions.submitCart('cart123', submitData);
console.log(result.referenceCode);

PDFGeneration​

generateProductPDF​

generateProductPDF: GenerateProductPDF

Generate PDF with passed pages for current product configuration

Param​

List of tabs to render at PDF

Param​

Method to handle i18n for PDF content

Param​

Custom PDF configuration

Pricing​

setDealer​

setDealer: SetDealer

Call to change currently selected dealer. Dealers are used to fetch price for authenticated users. Price can be different for various dealers.

Param​

Id of dealer to select

setPriceType​

setPriceType: SetPriceType

Changes price type used for price calculations.

Param​

Price type to be selected

setQuantity​

setQuantity: SetQuantity

Set product quantity

Param​

New quantity to be set

Product​

get2dViewImage​

get2dViewImage: Get2dViewImage

Generate 2d view for current configuration

Param​

Id of view to generate

Param​

Configuration code to generate view for. If not provided it will use default code

Param​

Size of the image

Param​

Background color to be used for generated image

Returns​

Image url

get3dInformationTemplate​

get3dInformationTemplate: Get3dInformationTemplate

Get data for 3d information template connected to passed meshId

Param​

If of mesh we want to display template for

Returns​

Template data

getProductCarouselImages​

getProductCarouselImages: GetProductCarouselImages

Get list of objects of 2d images for current product on selected options

Since​

6.0.0

Returns​

Array of objects CarouselItem

getProductThumbnail​

getProductThumbnail: GetProductThumbnail

Get url to product thumbnail for current configuration

Param​

ID of the product

Param​

Thumbnail configuration object

Param​

Configuration code to generate view for. If not provided it will use default code

Param​

Size of the image

Param​

Background color to be used for generated image

Returns​

Image url

setCarouselView​

setCarouselView: SetCarouselView

Change currently visible view on canvas/2d. Dispatches SET_CURRENT_VIEW_ID Redux action.

Param​

id of the view to show. In case of 3d pass empty value

triggerFinishEvent​

triggerFinishEvent: TriggerFinishEvent

Trigger finish button events

Param​

Configurator variant. Can be basket or selector. Depending on event will dispatch different mimmeq event. basket - triggers @mimeeq-add-to-cart event, selector - triggers mimeeq-select-product, other will dispatch mimeeq-show-summary. All events emit with payload details object.

ProductTabs​

getTabFiles​

getTabFiles: GetTabFiles

Get list of available files on Files tab. Some files are added based on configuration code, so it's advised to call this after each configuration code change (unless only static files are used). Calls productService /get-tab-files endpoint to get array of files

Since​

6.0.0

Param​

Id of the tab

Returns​

Array of available files

getTabFinishes​

getTabFinishes: GetTabFinishes

Get tab data for all possible finishes (materials) for the product. Calls optionSetService /get-option-set-by-id endpoint and returns Array with data if available.

Since​

6.0.0

Param​

List of finishes from tab

Returns​

Data for all (if found) finishes from provided list

getTabGallery​

getTabGallery: GetTabGallery

Get list of images for provided galleryId. Calls galleryService /get-gallery-details endpoint.

Since​

6.0.0

Param​

Id of the gallery

Returns​

Record with data about number of columns and list of items at the gallery

getTabPopular​

getTabPopular: GetTabPopular

Get data about provided popular configurations. It also filters out all broken configurations

Since​

6.0.0

Param​

List of popular configurations

Param​

Custom background color to be used on dynamic images

Returns​

List of popular configurations

selectPopularConfig​

selectPopularConfig: SelectPopularConfig

Trigger it to select popular configuration. Dispatches PUSH_ITEM Redux action.

Since​

6.0.0

Param​

Popular configuration item data

Fires​

@mimeeq#mimeeq-select-popular-variant

Fires​

@mimeeq#mimeeq-app-url-change

RelatedProducts​

getRelatedDynamicData​

getRelatedDynamicData: GetRelatedDynamicData

Get list of related items with matched image and options based on currently selected options

Since​

6.0.0

Param​

Raw list of related products

Param​

Custom background color to be used on dynamically created 2d images

Returns​

List of related products with dynamic data generated

getRelatedProducts​

getRelatedProducts: GetRelatedProducts

Get list of related products for current product

Since​

6.0.0

Returns​

Raw Array of related products RelatedItem

selectRelatedProduct​

selectRelatedProduct: SelectRelatedProduct

Call it to select product from related list. Initially clears sessionStorage and dispatches several Redux actions to clear all currently selected product data. Then dispatches events with new data.

Since​

6.0.0

Param​

Id of related product

Param​

Variant code of related product

Param​

Is modular product

Param​

Is product active

Fires​

@mimeeq#mimeeq-open-related-product

Fires​

@mimeeq#mimeeq-app-url-change

SceneControl​

decreaseZoom​

decreaseZoom: DecreaseZoom

Decrease the zoom level of a 3D scene camera by a configurable amount or a default value, by adjusting the radius of the camera.

Param​

Amount to adjust the radius of the camera.

freezeCanvasScrolling​

freezeCanvasScrolling: FreezeCanvasScrolling

Disable scrolling on canvas. This function modifies the behavior of the camera and input controls in the Babylon.js scene to prevent users from scrolling or zooming the canvas. In case you want to change camera zoom please use increaseZoom, decreaseZoom or setZoom methods. It also sets global variable on window.freezeScroll which is used in useBabylon hook.

increaseZoom​

increaseZoom: IncreaseZoom

Increase the zoom level of a 3D scene camera by a configurable amount or a default value, by adjusting the radius of the camera.

Param​

Amount to adjust the radius of the camera.

restoreCameraPosition​

restoreCameraPosition: RestoreCameraPosition

At 3d restore active camera position to initial state or to provided settings.

Param​

custom camera position

setSceneInputCanvas​

setSceneInputCanvas: SetSceneInputCanvas

Use this to set new canvas as target for all interactions. You can only manipulate one canvas at a time so this should be your primary canvas in most cases.

Param​

Canvas element to attach events to

setZoom​

setZoom: SetZoom

Set specific zoom value for the scene. Retrieves the active camera from the Babylon.js scene and sets new radius of the camera.

Param​

New zoom value

toggleDimensions​

toggleDimensions: ToggleDimensions

Toggle dimensions on scene Dispatches SHOW_DIMENSIONS webGl action.

Fires​

@mimeeq#mimeeq-hide-dimensions

Fires​

@mimeeq#mimeeq-show-dimensions

toggleGrid​

toggleGrid: ToggleGrid

Toggle grid on scene. Dispatches SET_SCENE_SETUP and SHOW_GRID Redux actions.

Fires​

@mimeeq#mimeeq-modular-show-grid

Fires​

@mimeeq#mimeeq-modular-hide-grid

unfreezeCanvasScrolling​

unfreezeCanvasScrolling: UnfreezeCanvasScrolling

Re-enable scrolling on canvas. Undo modifications done by freezeCanvasScrolling, restores the original scrolling and zooming behavior of the canvas, allowing the user to interact with the 3D scene as intended. It also sets global variable on window.freezeScroll to false, which is used in useBabylon() hook.

unregisterSceneCanvasView​

unregisterSceneCanvasView: UnregisterSceneCanvasView

Register new canvas to babylon scene views. It will be using the same camera as primary canvas.

Param​

Canvas element to be registered

zoomOut​

zoomOut: ZoomOut

Zoom out scene to see whole product. Dispatches applyCameraZoomAll webGl state task.

Fires​

@mimeeq#mimeeq-3d-zoom-out-scene

Storage​

downloadFile​

downloadFile: DownloadFile

Calling this method will initialize file download Calls storageService /download-file endpoint.

Since​

6.0.0

Param​

Relative path to file

Param​

Name to be set to file during download

Widgets​

imageWidgetAddNewImages​

imageWidgetAddNewImages: ImageWidgetAddNewImages

Add new images to image widget library.

Param​

List of files to upload

Param​

Id of block to select file for

imageWidgetRemoveImages​

imageWidgetRemoveImages: ImageWidgetRemoveImages

Remove files from logo widget library.

Param​

List of file ids to delete from library

imageWidgetSelectImage​

imageWidgetSelectImage: ImageWidgetSelectImage

Select new image for active widget Dispatches SET_IMAGE_WIDGET_SELECTED_IMG Redux action

Param​

Id of image to select

setImageWidgetActiveBlock​

setImageWidgetActiveBlock: SetImageWidgetActiveBlock

Set active block for image widget. Changing active block triggers close/open rules for product.

Param​

Block configuration object

setImageWidgetLibraryState​

setImageWidgetLibraryState: SetImageWidgetLibraryState

Use this to open/close image upload widget for active block. Dispatches SET_IMAGE_WIDGET_OPEN Redux action.

Param​

If library is open