eCatalog
CREATED FOR:
- Developer
- User
eCatalog Viewer is a catalog viewer that displays electronic brochures in a spread by spread or page by page manner. The eCatalog lets users navigate through the catalog using additional user interface elements or dedicated thumbnails mode. Users can also zoom in on every page for greater detail.
Viewer type 507.
See System requirements and prerequisites.
This viewer works with ecatalogs and supports optional image maps and social sharing tools. It has zoom tools, catalog navigation tools, full-screen support, thumbnails, and an optional close button. The viewer also supports social sharing tools, Print, Download, and Favorites. It is designed to work on desktops and mobile devices.
Demo URL
Using eCatalog Viewer
eCatalog 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
You can use eCatalog Viewer in pop-up mode using a 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 is achieved by way of custom CSS.
See Command reference common to all viewers - Configuration attributes and Command reference common to all Viewers - URL
Interacting with eCatalog Viewer
eCatalog Viewer supports the following touch gestures that are common in other mobile applications.
When the image is in a reset state, it performs a native page scroll.
When thumbnails are active, it scrolls the list of thumbnails.
It is possible to enable a realistic page flip animation effect for navigating between catalog pages. In such cases, a user can hold and drag a page corner and flip the page.
This viewer also supports both touch input and mouse input on Windows devices with a touch screen and mouse. This support, however, is limited to Chrome, Internet Explorer 11, and Edge web browsers only.
This viewer is fully keyboard accessible as described in Keyboard accessibility and navigation.
Social media sharing tools with eCatalog Viewer
The eCatalog Viewer supports social sharing tools. They are available as a button in the main control bar which expands into a sharing tool bar when a user clicks or taps on it.
The sharing tool bar contains icons for each type of sharing channel supported which includes Facebook, Twitter, email share, embed code share, and link share. When email share, embed share, or link share tools are activated, the viewer displays a modal dialog box with a corresponding data entry form. When Facebook or Twitter is called, the viewer redirects the user to a standard sharing dialog from a social service. Sharing tools are not available in full-screen mode because of web browser security restrictions.
Embedding eCatalog Viewer
Different web pages have different needs for viewer behavior. Sometimes a web page provides a link that, when selected, 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鈥檚 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 eCatalogViewer.html and is located within the html5/ subfolder of your standard IS-Viewers deployment:
<s7viewers_root>/html5/eCatalogViewer.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="none" 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鈥檚 real estate.
The primary use cases are web pages oriented for desktops or tablet devices, and also responsive designed 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 method is the best choice for web pages that have a static layout.
Responsive design embedding assumes that the viewer must 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 layout frameworks like Bootstrap and Foundation.
Otherwise, if the web page sets both the width and the height for the viewer鈥檚 container DIV, the viewer fills just that area and follows the size that the web page layout provides. A good example is embedding the viewer into a modal overlay, where the overlay is sized according to web browser window size.
Fixed size embedding
You add the viewer to a web page by doing the following:
-
Adding the viewer JavaScript file to your web page.
-
Defining the container DIV.
-
Setting the viewer size.
-
Creating and initializing the viewer.
-
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 the viewer API, be sure that you include eCatalogViewer.js. The eCatalogViewer.js file is located under the html5/js/ subfolder of your standard IS-Viewers deployment:
<s7viewers_root>/html5/js/eCatalogViewer.js
You can use a relative path if the viewer is deployed on one of the 51黑料不打烊 Dynamic Media Classic servers and it is served from the same domain. Otherwise, you specify a full path to one of 51黑料不打烊 Dynamic Media Classic servers that have the IS-Viewers installed.
The relative path looks like the following:
<script language="javascript" type="text/javascript" src="/s7viewers/html5/js/eCatalogViewer.js"></script>
include file on your page. Do not reference any additional JavaScript files in the web page code which might be downloaded by the viewer鈥檚 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鈥檚 logic and the location changes between viewer releases. 51黑料不打烊 does not keep older versions of secondary viewer includes on the server.include used by the viewer on the page breaks the viewer functionality in the future when a new product version is deployed.-
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
positionCSS property is set torelativeorabsolute.The following is an example of a defined placeholder DIV element:
<div id="s7viewer" style="position:relative"></div> -
Setting the viewer size
You can set the static size for the viewer by either declaring it for
.s7ecatalogviewertop-level CSS class in absolute units, or by usingstagesizemodifier.You can put sizing in CSS directly on the HTML page. Or, put sizing in a custom viewer CSS file, which is then later assigned to a viewer preset record in Dynamic Media Classic, or passed explicitly using a style command.
See Customizing eCatalog 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.s7ecatalogviewer { width: 640px; height: 480px; }You can set the
stagesizemodifier in the viewer preset record in Dynamic Media Classic. Or, you can pass it explicitly with the viewer initialization code withparamscollection, or as an API call as described in the Command Reference section, like the following:eCatalogViewer.setParam("stagesize", "640,480"); -
Initializing the viewer.
When you have completed the steps above, you create an instance of
s7viewers.eCatalogViewerclass, pass all configuration information to its constructor and callinit()method on a viewer instance. Configuration information is passed to the constructor as a JSON object. At minimum, this object has thecontainerIdfield which holds the name of viewer container ID and nestedparamsJSON object with configuration parameters supported by the viewer. In this case, theparamsobject must have at least the Image Serving URL passed asserverUrlproperty, and the initial asset asassetparameter. 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, however, call the
init()method just before the closingBODYtag, or on the bodyonload()event.At the same time, the container element should not necessarily be part of the web page layout yet. For example, it may be hidden using
display:nonestyle 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 assumeseCatalogVieweris the viewer instance;s7vieweris the name of placeholderDIV;https://s7d1.scene7.com/is/image/is the Image Serving URL, andViewers/Pluralistis the asset:<script type="text/javascript"> var eCatalogViewer = new s7viewers.eCatalogViewer({ "containerId":"s7viewer", "params":{ "asset":"Viewers/Pluralist", "serverurl":"https://s7d1.scene7.com/is/image/" } }).init(); </script>The following code is a complete example of a trivial web page that embeds the eCatalog Viewer with a fixed size:
<!DOCTYPE html> <html> <head> <script type="text/javascript" src="https://s7d1.scene7.com/s7viewers/html5/js/eCatalogViewer.js"></script> <style type="text/css"> #s7viewer.s7ecatalogviewer { width: 640px; height: 480px; } </style> </head> <body> <div id="s7viewer" style="position:relative"></div> <script type="text/javascript"> var eCatalogViewer = new s7viewers.eCatalogViewer({ "containerId":"s7viewer", "params":{ "asset":"Viewers/Pluralist", "serverurl":"https://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鈥檚 container DIV. For purposes of this example, assume that the web page allows the viewer鈥檚 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.
- Adding the viewer JavaScript file to your web page.
- Defining the container DIV.
- 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="https://s7d1.scene7.com/s7viewers/html5/js/eCatalogViewer.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 eCatalogViewer = new s7viewers.eCatalogViewer({
"containerId":"s7viewer",
"params":{
"asset":"Viewers/Pluralist",
"serverurl":"https://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 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="https://s7d1.scene7.com/s7viewers/html5/js/eCatalogViewer.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 eCatalogViewer = new s7viewers.eCatalogViewer({
"containerId":"s7viewer",
"params":{
"asset":"Viewers/Pluralist",
"serverurl":"https://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="https://s7d1.scene7.com/s7viewers/html5/js/eCatalogViewer.js"></script>
<style type="text/css">
#s7viewer.s7ecatalogviewer {
width: 640px;
height: 480px;
}
</style>
</head>
<body>
<div id="s7viewer" style="position:relative"></div>
<script type="text/javascript">
var eCatalogViewer = new s7viewers.eCatalogViewer();
eCatalogViewer.setContainerId("s7viewer");
eCatalogViewer.setParam("serverurl", "https://s7d1.scene7.com/is/image/");
eCatalogViewer.setAsset("Viewers/Pluralist");
eCatalogViewer.init();
</script>
</body>
</html>