CarouselViewer
JavaScript API reference for Carousel Viewer.
CarouselViewer([config])
Constructor, creates an HTML 5 Carousel Viewer instance.
Parameters
config |
{object} optional JSON configuration object, allows all the viewer settings to pass to the constructor to avoid calling individual setter methods. Contains the following properties:
-
containerId - {String} ID of the DOM container (normally a DIV ) that the viewer is inserted into. By the time this method is called, it is not necessary to have the container element created. However, the container must exist when init() is run. Required.
-
params - {Object} JSON object with viewer configuration parameters where the property name is either viewer-specific configuration option or SDK modifier, and the value of that property is a corresponding settings value. Required.
-
handlers - {Object} JSON object with viewer event callbacks, where the property name is the name of supported viewer event and the property value is a JavaScript function reference to appropriate callback. Optional. See Event callbacks for more information about viewer events.
-
localizedTexts - {Object} JSON object with localization data. See Localization of user interface elements and the example for more information about the object's content. Optional
|
Returns
None.
Example
var carouselViewer = new s7viewers.CarouselViewer({
"containerId":"s7viewer",
"params":{
"asset":"/content/dam/dm-public-facing-live-demo-page/04_shoppable_carousel/05_shoppable_banner",
"serverurl":"https://adobedemo62-h.assetsadobe.com/is/image"
},
"handlers":{
"initComplete":function() {
console.log("init complete");
}
},
"localizedTexts":{
"en":{
"PanLeftButton.TOOLTIP":"Left"
},
"fr":{
"PanLeftButton.TOOLTIP":"Gauchiste"
},
defaultLocale:"en"
}
});