Show Menu
TOPICS×

Spin

Spin Viewer is an image viewer that provides a 360-degree view of the image or even multi-dimensional view if appropriate spin set is being used. It has zoom and spin tools, full screen support, and an optional close button. It is designed to work on desktops and mobile devices.
Images which use IR (Image Rendering) or UGC (User-Generated Content) are not supported by this viewer.
Viewer type 503.

Using Spin Viewer

Spin Viewer represents a main JavaScript file and a set of helper files (a single JavaScript include with all Viewer SDK components used by this particular viewer, assets, CSS) downloaded by the viewer in runtime.
Spin Viewer can be used both in pop-up mode using production-ready HTML page provided with IS-Viewers or in embedded mode, where it is integrated into target web page using documented API.
Configuration and skinning are similar to that of the other viewers. All skinning can be achieved via custom CSS.

Interacting with Spin Viewer

Spin Viewer supports the following touch gestures that are common in other mobile applications. When the viewer cannot process a user's swipe gesture it forwards the event to the web browser to perform a native page scroll. This allows the user to navigate through the page even if the viewer occupies most of the device screen area.
Gesture
Description
Double tap
Zooms in one level until maximum magnification is reached. The next double tap gesture resets the viewer to the initial viewing state.
Pinch
Zooms in or out on the image.
Horizontal swipe or flick
If the image is in a reset state it spins through the set horizontally.
If the image is zoomed in, it moves the image horizontally. If image is moved to the view edge and a swipe is still done in that direction, the gesture performs a native page scroll.
Vertical swipe or flick
If the image is in a reset state it changes the vertical view angle in case a multi-dimensional spin set is used. In a one-dimensional spin set, or when a multi-dimensional spin set is on the last or the first axis, so that the vertical swipe does not result in a vertical view angle change, the gesture performs a native page scroll.
If the image is zoomed in, it moves the image vertically. If image is moved to the view edge and a swipe is still done in that direction, the gesture performs a native page scroll.
The viewer also supports both touch input and mouse input on Windows devices with touchscreen and mouse. This support, however, is limited to Chrome, Internet Explorer 11, and Edge web browsers only.
This viewer is fully keyboard accessible.

Embedding Spin Viewer

Different web pages have different needs for viewer behavior. Sometimes a web page provides a link that, when clicked, opens the viewer in a separate browser window. In other cases, it is necessary to embed the viewer right in the hosting page. In the latter case, the web page may have a static page layout, or use responsive design that displays differently on different devices or for different browser window sizes. To accommodate these needs, the viewer supports three primary operation modes: pop-up, fixed size embedding, and responsive design embedding.
About pop-up mode
In pop-up mode, the viewer is opened in a separate web browser window or tab. It takes the entire browser window area and adjusts in case the browser is resized, or a mobile device's orientation is changed.
Pop-up mode is the most common for mobile devices. The web page loads the viewer using window.open() JavaScript call, properly configured A HTML element, or any other suitable method.
It is recommended that you use an out-of-the-box HTML page for pop-up operation mode. In this case, it is called SpinViewer.html and is located within the html5/ subfolder of your standard IS-Viewers deployment:
<s7viewers_root>/html5/SpinViewer.html
You can achieve visual customization by applying custom CSS.
The following is an example of HTML code that opens the viewer in a new window:
<a 
href="http://s7d1.scene7.com/s7viewers/html5/SpinViewer.html?asset=Scene7SharedAssets/SpinSet_Sample&stagesize=500,400" 
target="_blank">Open popup viewer</a>

About fixed size embedding mode and responsive design embedding mode
In the embedded mode, the viewer is added to the existing web page, which may already have some customer content not related to the viewer. The viewer normally occupies only a part of a web page's real estate.
The primary use cases are web pages oriented for desktops or tablet devices, and also responsive design pages that adjust layout automatically depending on the device type.
Fixed size embedding is used when the viewer does not change its size after initial load. This is the best choice for web pages that have a static layout.
Responsive design embedding assumes that the viewer may need to resize at runtime in response to the size change of its container DIV . The most common use case is adding a viewer to a web page that uses a flexible page layout.
In responsive design embedding mode, the viewer behaves differently depending on the way web page sizes its container DIV . If the web page sets only the width of the container DIV , leaving its height unrestricted, the viewer automatically chooses its height according to the aspect ratio of the asset that is used. This functionality ensures that the asset fits perfectly into the view without any padding on the sides. This use case is the most common for web pages using responsive design layout frameworks like Bootstrap, Foundation, and so on.
Otherwise, if the web page sets both the width and the height for the viewer's container DIV , the viewer fills just that area and follows the size that the web page layout provides. A good example may be embedding the viewer into a modal overlay, where the overlay is sized according to web browser window size.
Fixed size embedding
You add the Spin Viewer to a web page by doing the following:
  1. Adding the viewer JavaScript file to your web page.
  2. Defining the container DIV .
  3. Setting the viewer size.
  4. Creating and initializing the viewer.
  5. Adding the viewer JavaScript file to your web page.
    Creating a viewer requires that you add a script tag in the HTML head. Before you can use viewer API, be sure that you include SpinViewer.js . SpinViewer.js is located under the html5/js/ subfolder of your standard IS-Viewers deployment:
    <s7viewers_root>/html5/js/SpinViewer.js
    You can use a relative path if the viewer is deployed on one of the Adobe Scene7 servers and it is served from the same domain. Otherwise, you specify a full path to one of Adobe Scene7 servers that have the IS-Viewers installed.
    The relative path looks like the following:
     <script language="javascript" type="text/javascript" src="/s7viewers/html5/js/SpinViewer.js"></script>
    
    
    You should only reference the main viewer JavaScript include file on your page. You should not reference any additional JavaScript files in the web page code which might be downloaded by the viewer's logic in runtime. In particular, do not directly reference HTML5 SDK Utils.js library loaded by the viewer from /s7viewers context path (so-called consolidated SDK include ). The reason is that the location of Utils.js or similar runtime viewer libraries is fully managed by the viewer's logic and the location changes between viewer releases. Adobe does not keep older versions of secondary viewer includes on the server.
    As a result, putting a direct reference to any secondary JavaScript include used by the viewer on the page breaks the viewer functionality in the future when a new product version is deployed.
  6. Defining the container DIV.
    Add an empty DIV element to the page where you want the viewer to appear. The DIV element must have its ID defined because this ID is passed later to the viewer API.
    The placeholder DIV is a positioned element, meaning that the position CSS property is set to relative or absolute .
    The following is an example of a defined placeholder DIV element:
    <div id="s7viewer" style="position:relative"></div>
    
    
  7. Setting the viewer size
    You can set the static size for the viewer by either declaring it for .s7spinviewer top-level CSS class in absolute units, or by using stagesize modifier.
    You can put sizing in CSS directly on the HTML page, or in a custom viewer CSS file, which is then later assigned to a viewer preset record in Scene7 Publishing System, or passed explicitly using a style command.
    See Customizing Spin Viewer for more information about styling the viewer with CSS.
    The following is an example of defining a static viewer size in HTML page:
    #s7viewer.s7spinviewer { 
     width: 640px; 
     height: 480px; 
    }
    
    
    You can set the stagesize modifier either in the viewer preset record in Scene7 Publishing System, or pass it explicitly with the viewer initialization code with params collection, or as an API call as described in the Command Reference section, like the following:
     spinViewer.setParam("stagesize", 
    "640,480");
    
    
    A CSS-based approach is recommended and is used in this example.
  8. Creating and initializing the viewer.
    When you have completed the steps above, you create an instance of s7viewers.SpinViewer class, pass all configuration information to its constructor and call init() method on a viewer instance. Configuration information is passed to the constructor as a JSON object. At minimum, this object has containerId field that holds the name of viewer container ID and nested params JSON object with configuration parameters that the viewer supports. In this case of params object, it must have at least the Image Serving URL passed as serverUrl property and initial asset as asset parameter. JSON-based initialization API lets you create and start the viewer with single line of code.
    It is important to have the viewer container added to the DOM so that the viewer code can find the container element by its ID. Some browsers delay building DOM until the end of the web page. For maximum compatibility, call the init() method just before the closing BODY tag, or on the body onload() event.
    At the same time, the container element should not necessarily be a part of the web page layout just yet. For example, it may be hidden using the display:none style assigned to it. In this case, the viewer delays its initialization process until the moment when the web page brings the container element back to the layout. When this action occurs, the viewer load automatically resumes.
    The following is an example of creating a viewer instance, passing the minimum necessary configuration options to the constructor and calling the init() method. The example assumes spinViewer is the viewer instance, s7viewer is the name of placeholder DIV , http://s7d1.scene7.com/is/image/ is the Image Serving URL, and Scene7SharedAssets/SpinSet_Sample is the asset.
    <script type="text/javascript"> 
    var spinViewer = new s7viewers.SpinViewer({ 
     "containerId":"s7viewer", 
    "params":{ 
     "asset":"Scene7SharedAssets/SpinSet_Sample", 
     "serverurl":"http://s7d1.scene7.com/is/image/" 
    } 
    }).init(); 
    </script>
    
    
    The following code is a complete example of a trivial web page that embeds the Spin Viewer with a fixed size:
    <!DOCTYPE html> 
    <html> 
    <head> 
    <script type="text/javascript" src="http://s7d1.scene7.com/s7viewers/html5/js/SpinViewer.js"></script> 
    <style type="text/css"> 
    #s7viewer.s7spinviewer { 
     width: 640px; 
     height: 480px; 
    } 
    </style> 
    </head> 
    <body> 
    <div id="s7viewer" style="position:relative"></div> 
    <script type="text/javascript"> 
    var spinViewer = new s7viewers.SpinViewer({ 
     "containerId":"s7viewer", 
    "params":{ 
     "asset":"Scene7SharedAssets/SpinSet_Sample", 
     "serverurl":"http://s7d1.scene7.com/is/image/" 
    } 
    }).init(); 
    </script> 
    </body> 
    </html>
    
    
Responsive design embedding with unrestricted height
With responsive design embedding, the web page normally has some kind of flexible layout in place that dictates the runtime size of the viewer's container DIV . For purposes of this example, assume that the web page allows the viewer's container DIV to take 40% of the web browser window size, leaving its height unrestricted. The resulting web page HTML code looks like the following:
<!DOCTYPE html> 
<html> 
<head> 
<style type="text/css"> 
.holder { 
 width: 40%; 
} 
</style> 
</head> 
<body> 
<div class="holder"></div> 
</body> 
</html>

Adding the viewer to such a page is similar to fixed size embedding, with the only difference being that you do not need to explicitly define viewer size.
  1. Adding the viewer JavaScript file to your web page.
  2. Defining the container DIV.
  3. Creating and initializing the viewer.
All the steps above are the same as with fixed size embedding. Add the container DIV to the existing " holder" DIV . The following code is a complete example. You can see how the viewer size changes when the browser is resized, and how the viewer aspect ratio matches the asset.
<!DOCTYPE html> 
<html> 
<head> 
<script type="text/javascript" src="http://s7d1.scene7.com/s7viewers/html5/js/SpinViewer.js"></script> 
<style type="text/css"> 
.holder { 
 width: 40%; 
} 
</style> 
</head> 
<body> 
<div class="holder"> 
<div id="s7viewer" style="position:relative"></div> 
</div> 
<script type="text/javascript"> 
var spinViewer = new s7viewers.SpinViewer({ 
 "containerId":"s7viewer", 
"params":{ 
 "asset":"Scene7SharedAssets/SpinSet_Sample", 
 "serverurl":"http://s7d1.scene7.com/is/image/" 
} 
}).init(); 
</script> 
</body> 
</html>

The following examples page illustrates more real-life use cases of responsive design embedding with unrestricted height:
Flexible size embedding with width and height defined
In case of flexible-size embedding with width and height defined, the web page styling is different. That is, it provides both sizes to the " holder" DIV and centers it in the browser window. Also, the web page sets the size of the HTML and BODY element to 100%:
<!DOCTYPE html> 
<html> 
<head> 
<style type="text/css"> 
html, body { 
 width: 100%; 
 height: 100%; 
} 
.holder { 
 position: absolute; 
 left: 20%; 
 top: 20%; 
 width: 60%; 
height: 60%; 
} 
</style> 
</head> 
<body> 
<div class="holder"></div> 
</body> 
</html>

The remaining embedding steps are identical to responsive design embedding with unrestricted height. The resulting example is the following:
<!DOCTYPE html> 
<html> 
<head> 
<script type="text/javascript" src="http://s7d1.scene7.com/s7viewers/html5/js/SpinViewer.js"></script> 
<style type="text/css"> 
html, body { 
 width: 100%; 
 height: 100%; 
} 
.holder { 
 position: absolute; 
 left: 20%; 
 top: 20%; 
 width: 60%; 
height: 60%; 
} 
</style> 
</head> 
<body> 
<div class="holder"> 
<div id="s7viewer" style="position:relative"></div> 
</div> 
<script type="text/javascript"> 
var spinViewer = new s7viewers.SpinViewer({ 
 "containerId":"s7viewer", 
"params":{ 
 "asset":"Scene7SharedAssets/SpinSet_Sample", 
 "serverurl":"http://s7d1.scene7.com/is/image/" 
} 
}).init(); 
</script> 
</body> 
</html>

Embedding using Setter-based API
Instead of using JSON-based initialization it is possible to use setter-based API and no-args constructor. With that API constructor does not take any parameters and configuration parameters is specified using setContainerId() , setParam() , and setAsset() API methods with separate JavaScript calls.
The following example shows fixed size embedding with setter-based API:
<!DOCTYPE html> 
<html> 
<head> 
<script type="text/javascript" src="http://s7d1.scene7.com/s7viewers/html5/js/SpinViewer.js"></script> 
<style type="text/css"> 
#s7viewer.s7spinviewer { 
 width: 640px; 
 height: 480px; 
} 
</style> 
</head> 
<body> 
<div id="s7viewer" style="position:relative"></div> 
<script type="text/javascript"> 
var spinViewer = new s7viewers.SpinViewer(); 
spinViewer.setContainerId("s7viewer"); 
spinViewer.setParam("serverurl", "http://s7d1.scene7.com/is/image/"); 
spinViewer.setAsset("Scene7SharedAssets/SpinSet_Sample"); 
spinViewer.init(); 
</script> 
</body> 
</html>