Skip to main content

Type Alias: TakeScreenshot()

TakeScreenshot = (extension?, size?, backgroundColor?, customDimensions?, withAutozoom?, withCameraReset?, customCameraPosition?) => Promise<Nullable<string>>

Captures a screenshot of the current product configuration.

This method generates a high-quality image of the current configuration state, which can be used for thumbnails, sharing, printing, or exporting. The method offers flexible options for image format, size, and appearance.

Under the hood, it clones the existing scene and calls captureImage() to ensure the screenshot doesn't disrupt the user's current view.

Parameters​

extension?​

string

File extension for the output image (default: 'png'). Supported values: 'png', 'jpg', 'jpeg'.

size?​

number

Image width in pixels (default: 3072). Height is calculated based on canvas aspect ratio. Note: On iOS devices, sizes larger than 2048 may cause performance issues.

backgroundColor?​

string

Background color for JPEG images (default: '#fff'). Accepts hex color values. For PNG, this controls transparency.

customDimensions?​

Dimensions

Optional custom dimensions that override the default sizing.

withAutozoom?​

boolean

When true, automatically zooms out to ensure the entire product is visible.

withCameraReset?​

boolean

When true, resets the camera to its initial position before capturing.

customCameraPosition?​

string

JSON string with custom camera positioning data.

Returns​

Promise<Nullable<string>>

A promise resolving to a base64-encoded image string, or null if unsuccessful.

Example​

// Take a 1200px wide PNG screenshot with a white background
window.mimeeqApp.utils.takeScreenshot('png', 1200, '#ffffff')
  .then(imageBase64 => {
    // Use the base64-encoded image
    const img = document.createElement('img');
    img.src = imageBase64;
    document.body.appendChild(img);
  });

// Take a JPEG screenshot with custom dimensions and camera position
window.mimeeqApp.utils.takeScreenshot(
  'jpg',                      // JPEG format
  1800,                       // Width in pixels
  '#f0f0f0',                  // Light gray background
  { width: 1800, height: 1200 }, // Custom dimensions
  true,                       // Auto-zoom to fit product
  true,                       // Reset camera to initial position
  JSON.stringify({            // Custom camera position
    position: {x: -1.5, y: 1.7, z: -5.2},
    alpha: 4.4,
    beta: 1.3,
    target: {x: 0, y: 0.6, z: 0}
  })
);