DocumentationDynamic Media Viewers Reference Guide

FlyoutViewer flyoutviewer

Last update: Wed Feb 07 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • User

JavaScript API reference for Flyout Viewer.

FlyoutViewer([config])

Constructor; creates a Flyout Viewer instance.

Parameters section-8bc3d1424c8444f193716fc8d9975765

config

{Object} optional JSON configuration object, allows all the viewer settings to pass to the constructor and 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. It is not necessary to have the container element created by the time this method is called. However, the container must exist when init() is run. Required.

  • params - {Object} JSON object with viewer configuration parameters where the property name is either a viewer-specific configuration option or an 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 an appropriate callback. Optional.

    See Event callbacksfor more information about viewer events.

  • localizedTexts - { Object } JSON object with localization data. Optional.

    See Localization of user interface elementsfor more information.

    See the Viewer SDK User Guide and the example for more information about the object's content. Optional.

Returns section-1d3cf85bc7cc4dfe9670e038d02b9101

None.

Example section-9e9332aa86b74a5fb321375c03fdc5b3

var flyoutViewer = new s7viewers.FlyoutViewer({
 "containerId":"s7viewer",
"params":{
 "asset":"Scene7SharedAssets/ImageSet-Views-Sample",
 "serverurl":"http://s7d1.scene7.com/is/image/"
},
"handlers":{
 "initComplete":function() {
  console.log("init complete");
}
},
"localizedTexts":{
"en":{
"FlyoutZoomView.TIP_BUBBLE_OVER":"Mouse over to zoom"
},
"fr":{
"FlyoutZoomView.TIP_BUBBLE_OVER":"Passez la souris sur pour zoomer"
},
defaultLocale:"en"
}
});
recommendation-more-help
b7426f53-aad9-4c00-83fc-664f30f681e8