Skip to main content

Type Alias: Get2dViewImage()

Get2dViewImage = (viewId?, configurationCode?, size?, backgroundColor?) => Promise<string>

Function

Generates an image URL for a specific 2D view of the current configuration.

This method creates a URL to a rendered image of the product from a specific viewpoint. It can generate images for any available 2D view, with options for custom configuration codes, sizes, and background colors.

These dynamically generated images can be used in custom interfaces, documentation, or wherever a visual representation of the configured product is needed.

Parameters​

viewId?​

string

ID of the view to generate (empty string for default view)

configurationCode?​

string

Optional specific configuration code to visualize

size?​

ThumbnailSize

Optional image size identifier (e.g., 'x425', 'x1024')

backgroundColor?​

string

Optional background color for the image

Returns​

Promise<string>

A promise resolving to the URL of the generated image, or empty string if unsuccessful

Example​

// Get the front view image of the current configuration
const frontViewUrl = await window.mimeeqApp.actions.get2dViewImage('front');
document.getElementById('product-image').src = frontViewUrl;

// Get a high-resolution side view with custom background for a specific configuration
const sideViewUrl = await window.mimeeqApp.actions.get2dViewImage(
  'side',               // View ID
  'Width-a4&Color-b7',  // Configuration code
  'x1024',              // Size
  '#F5F5F5'             // Background color
);