Interface: ApiImageConfig
Configuration for image generation flows in the Mimeeq API.
This interface provides comprehensive control over how product images are generated and processed throughout the configurator. It includes post-processing capabilities and context-specific settings for different image generation scenarios.
Image configuration is crucial for ensuring consistent visual quality across different platforms and use cases while optimizing for performance and bandwidth.
Properties
imageConfigurations?
optionalimageConfigurations:object
Context-specific image generation settings.
This object allows for defining different image generation parameters for various use cases throughout the configurator. Each context can have its own optimized settings for format, size, background, and camera positioning.
This granular control ensures that each use case gets appropriately sized and formatted images without unnecessary processing or bandwidth.
ar?
optionalar:ApiImageConfigSettings
Settings for images in Augmented Reality for standard products.
These images appear in AR previews and launch screens for standard product configurations.
arModular?
optionalarModular:ApiImageConfigSettings
Settings for images in Augmented Reality for modular products.
These images appear in AR previews and launch screens for modular scene arrangements.
basket?
optionalbasket:ApiImageConfigSettings
Settings for product images in the standard shopping basket.
These images typically appear as thumbnails in cart listings and order summaries for standard products.
basketModular?
optionalbasketModular:ApiImageConfigSettings
Settings for product images in the modular shopping basket.
These images show the entire modular scene arrangement in cart listings and order summaries.
favourites?
optionalfavourites:ApiImageConfigSettings
Settings for images in favourites listings for standard products.
These thumbnails represent saved product configurations in favourites collections and listings.
favouritesModular?
optionalfavouritesModular:ApiImageConfigSettings
Settings for images in favourites listings for modular products.
These thumbnails represent saved modular scene arrangements in favourites collections and listings.
finishEventModular?
optionalfinishEventModular:ApiImageConfigSettings
Settings for images in the modular finish event.
These are the primary images generated when completing a modular configuration, often used in events and sharing.
modularLastSession?
optionalmodularLastSession:ApiImageConfigSettings
Settings for images of the last saved modular session.
These images capture the state of a modular scene when session recovery is activated after a page reload.
pdf?
optionalpdf:ApiImageConfigSettings
Settings for images in PDFs for standard products.
These high-quality images appear in generated PDF documentation for standard product configurations.
pdfModular?
optionalpdfModular:ApiImageConfigSettings
Settings for images in PDFs for modular products.
These high-quality images appear in generated PDF documentation for modular scene arrangements.
postprocessImage()?
optionalpostprocessImage: (base64,extension,dimensions) =>Promise<Nullable<string>>
Custom function for applying post-processing effects to generated images.
This function allows for advanced image manipulation after the initial rendering, such as adding watermarks, adjusting dimensions, applying filters, or other custom modifications.
The function receives the raw image data and information about its format and dimensions, and should return the processed image data or null if no image should be returned.
Note: This only affects product images generated from the 3D canvas; material previews, 2D images, and gallery images are not processed.
Parameters
base64
string
The base64-encoded image data
extension
string
The file format ('png', 'jpg', etc.)
dimensions
The width and height of the image
Returns
The processed image data as a base64 string, or null to cancel