You're viewing help content for version:

The default Quickview is used in ecommerce experiences whereby a pop-up is displayed with product information to drive a purchase. However, you can trigger custom content to display in the pop-ups. Depending on the viewer you are using, this functionality lets users click on a hotspot, or a thumbnail image, or on an image map to see information or related content.

Quickviews are supported by the following viewers in Dynamic Media:

  • Interactive Images  (clickable hotspots)
  • Interactive Video  (clickable thumbnail images during video playback)
  • Carousel Banners  (clickable hotspots or image maps)

While the functionality of each viewer differs, the process of creating a Quickview is the same across all three supported viewers.

To use Quickviews to create custom pop-ups,

  1. Create a Quickview for an uploaded asset.

    You typically create a Quickview the same time you edit an asset for use with the viewer you are using.


    Viewer you are using Complete these steps to create the Quickview
    Interactive Images Adding hotspots to an image banner.
    Interactive Videos Adding interactivity to your video.
    Carousel Banners Adding Hotspots or Image Maps to a Banner.
  2. Obtain the viewer embed code to Integrate the viewer within your website.

    Viewer you are using
    Complete these steps to integrate the viewer with your website
    Interactive image Integrating an interactive image with your website.
    Interactive video
    Integrating an interactive video with your website.
    Carousel banner Adding a carousel banner to your website page.
  3. The viewer you are using now needs to know how to use the Quickview.

    To do this the viewer uses a handler called QuickViewActive.

    Suppose you were using the following sample embed code on your web page for an interactive image:



    The handler is loaded into the viewer using setHandlers:

    viewerInstance.setHandlers({ handler 1, handler 2}, ...

    Using the sample embed code example from above, we have the following code:

        quickViewActivate": function(inData) {
            var sku=inData.sku;
            var genericVariable1=inData.genericVariable1;
            var genericVariable2=inData.genericVariable2;
  4. You now need to configure the quickViewActivate handler.

    The quickViewActivate handler controls the Quickviews in the viewer. The handler contains the variable list and function calls for use with the Quickview. The embed code provides mapping for the SKU variable set in the Quickview as well as a sample loadQuickView function call.

    Variable mapping
    Map variables for use in your web page to the SKU value and generic variables contained in the Quickview:

    var variable1= inData.quickviewVariable

    The provided embed code has a sample mapping for the SKU variable:

    var sku=inData.sku

    Map additional variables from the Quickview too, as in the following:

    var variable2= inData.quickviewVariable2
    var variable3= inData.quickviewVariable3

    Function call
    The handler also requires a function call for the Quickview to work. The function is assumed to be accessible by your host page. The embed code provides a sample function call:


    The sample function call assumes the function loadQuickView() exists and is accessible.

  5. Do the following:

    • Uncomment the setHandlers section of the embed code.
    • Map any additional variables contained in the Quickview.
      • Update the loadQuickView(sku,var1,var2) call if you are adding additional variables.
    • Create a simple loadQuickView () function on page, outside of the viewer.
      For example, the following writes the value of sku to the browser console:


    function loadQuickView(sku){
        console.log ("quickview sku value is " + sku);
    • Upload a test HTML page to a webserver and open.
      With the variables from the Quickview mapped and the function call in place, the browser console writes the variable value to the browser console using the sample function provided.
  6. You can now use a function to invoke a simple pop-up in the Quickview. The following example uses a DIV for a popup.

  7. Style the pop-up DIV in the following manner. Add your own additional styling as desired.

    <style type="text/css">
            position: absolute;
            z-index: 99999999;
            display: none;
  8. Place the pop-up DIV in the body of your HTML page.

    One of the elements is set with an ID that is updated with sku value when the user invokes a Quickview. The example also includes a simple button to hide the pop-up again after it becomes visible.

    <div id="quickview_div" >
            <tr><td><input id="btnClosePopup" type="button" value="Close"        onclick='document.getElementById("quickview_div").style.display="none"' /><br /></td></tr>
            <tr><td>SKU</td><td><input type="text" id="txtSku" name="txtSku"></td></tr>
  9. Add a function to update the sku value in the pop-up; make the pop-up visible by replacing the simple function created in step 5. with the following:

    <script type="text/javascript">
        function loadQuickView(sku){
            document.getElementById("txtSku").setAttribute("value",sku); // write sku value
            document.getElementById("quickview_div").style.display="block"; // show popup
  10. Upload a test HTML page to your webserver and open. The viewer displays the pop-up DIV when a user invokes a Quickview.

  11. How to display the custom pop-up in full screen mode
    Some viewers, such as the Interactive Video viewer, support display in fullscreen mode. However, using the pop-up as described in the previous steps causes it to display behind the viewer while in full screen mode.

    To have the pop-up display in both standard and full screen modes, you attach the pop-up to the viewer container. To accomplish this, you can use a second handler method, initComplete

    The initComplete hander is invoked after the viewer is initialized.

    "initComplete":function() { code block }
  12. To attach the pop-up--described in the previous steps--to the viewer, use the following code:

    "initComplete":function() {
        var popup = document.getElementById('quickview_div');
        var sdkContainerId = s7interactivevideoviewer.getComponent("container").getInnerContainerId();
        var inner_container = document.getElementById(sdkContainerId);

    In the code above, we have done the following:

    • Identified our custom pop-up.
    • Removed it from the DOM.
    • Identified the viewer container.
    • Attached the pop-up to the viewer container.
  13. Your entire setHandlers code should now look similar to the following (Interactive Video viewer was used):

        "quickViewActivate": function(inData) {
            var sku=inData.sku;
        "initComplete":function() {
            var popup = document.getElementById('quickview_div'); // get custom quick view container
            popup.parentNode.removeChild(popup); // remove it from current DOM
            var sdkContainerId = s7interactivevideoviewer.getComponent("container").getInnerContainerId();
            var inner_container = document.getElementById(sdkContainerId);
  14. After the handlers are loaded, you initialize the viewer:


    This example uses the Interactive image viewer.


    After you embed the viewer into your host page, be sure that the viewer instance is created and the handlers are loaded before the viewer is invoked using init().