Skip to main content

Enumeration: GroupPreviewImageSource

Defines source methods for product preview images.

This enum specifies different approaches for determining which images are used as product previews in listings, search results, and galleries. The image source method affects whether previews are static or reflect the current configuration state.

Enumeration Members​

GROUP_IMAGE​

GROUP_IMAGE: "GROUP_IMAGE"

Generate preview based on a specific option group selection.

In GROUP_IMAGE mode, the preview image dynamically changes based on selections within a designated option group. This allows the preview to reflect a specific aspect of the current configuration, such as color or material.

This approach provides more representative previews that give users a better sense of their current configuration's appearance. It's particularly valuable when certain options dramatically change the product's look.

Use cases:

  • Products where color/material selection significantly affects appearance
  • Configurations where seeing current selections in listings improves user experience
  • Product listings that need to show the specific variant the user has configured
  • Saved configurations where accurately representing the saved state is important

STATIC_IMAGE​

STATIC_IMAGE: "STATIC_IMAGE"

Use a predefined static image as the preview.

In STATIC_IMAGE mode, the system displays a fixed, pre-uploaded image that has been explicitly designated as the product preview. This image remains constant regardless of the product's configuration state.

This approach ensures consistent presentation across all contexts and eliminates any performance overhead from generating dynamic previews. It's ideal for products where a single representative image is sufficient or when brand consistency is paramount.

Use cases:

  • Brand-critical products with specific marketing imagery
  • Products where configurations don't significantly change appearance
  • Performance-sensitive implementations where dynamic image generation is costly
  • Catalog pages where consistency in presentation is desired