Skip to main content

Type Alias: SaveImage

SaveImage = (extension, size, backgroundColor?, withDimensions?) => Promise<void>

Function

Captures and saves the current product view as a high-quality image.

This action creates a professional product image of the current configuration from the current camera angle. It's like taking a screenshot, but with higher quality and more control over the output format and resolution - perfect for creating marketing materials, design presentations, or sharing design concepts.

Business value:

  • Creates professional product imagery without photography
  • Generates consistent product visuals for catalogs and websites
  • Enables sharing of custom configurations with clients or team members
  • Supports creation of marketing materials for configured products

Dispatches mimeeq-3d-before-export-image

Parameters​

extension​

string

The image format to save ('png', 'jpg', or 'jpeg')

size​

number

The width of the output image in pixels (height will adjust automatically)

backgroundColor?​

string

The color for image background (for formats without transparency)

withDimensions?​

boolean

Returns​

Promise<void>

Example​

// Create a high-resolution PNG image for a presentation
window.mimeeqApp.actions.saveImage('png', 2048);

// Create a JPEG with white background for a product catalog
window.mimeeqApp.actions.saveImage('jpg', 1200, '#FFFFFF');

// Add a "download product image" button to your interface
document.getElementById('download-image').addEventListener('click', () => {
  window.mimeeqApp.actions.saveImage('png', 1800);
});