- Dynamic Media Viewers Reference Guide
- Viewer library examples
- System requirements
- Installing multiple viewers on the same server
- Viewers release notes
- Viewers release notes (5.16.5)
- Archive
- Viewers release notes (5.16.1)
- Viewers release notes (5.15.3)
- Viewers release notes (5.14.1)
- Viewers release notes (5.13.1)
- Viewers release notes (5.12.1)
- Viewers release notes (5.10.1)
- Viewers release notes (5.8.2)
- Viewers release notes (5.5.2)
- Viewers release notes (5.4.2)
- Viewers release notes (5.2.3)
- Viewers release notes (5.2.2)
- Viewers release notes (5.1.1)
- Viewers release notes (5.0.1)
- Viewers release notes (4.9.2)
- Compatibility notes
- Keyboard accessibility and navigation
- Viewer SDK Tutorial
- Viewers for AEM Assets and Dynamic Media Classic
- Viewers for AEM Assets and Dynamic Media Classic
- Basic Zoom
- Basic Zoom Viewer
- Command reference - Configuration attributes
- JavaScript API reference for Basic Zoom Viewer
- Event callbacks
- Customize the Basic Zoom Viewer
- Support for Adobe Analytics tracking
- Assistive technology support
- Localization of user interface elements
- Full screen support
- Viewer SDK namespace
- eCatalog
- eCatalog
- Command reference - Configuration-attributes
- Command reference – Configuration attributes
- Closebutton
- ControlBar.transition
- direction
- EmailShare.emailurl
- EmbedShare.embedsizes
- FavoritesEffect.expiration
- FavoritesMenu.bearing
- FavoritesView.align
- FavoritesView.favoritesThumbView
- FavoritesView.fmt
- FavoritesView.iscommand
- FavoritesView.maxloadradius
- FavoritesView.textpos
- ImageMapEffect.mapTips
- ImageMapEffect.mode
- ImageMapEffect.rollover
- InfoPanelPopup.infoServerUrl
- InfoPanelPopup.showhidetransition
- InfoPanelPopup.template
- InitialFrame
- PageView.doubleclick
- PageView.enableHD
- PageView.fmt
- PageView.frametransition
- PageView.iconEffect
- PageView.iscommand
- PageView.maxloadradius
- PageView.pageturnstyle
- PageView.singleclick
- PageView.transition
- PageView.zoomstep
- portraitFrames
- Print.printquality
- SocialShare.bearing
- TableOfContents.bearing
- TableOfContents.maxitems
- TableOfContents.showdefault
- ThumbnailGridView.align
- ThumbnailGridView.enabledragging
- ThumbnailGridView.fmt
- ThumbnailGridView.maxloadradius
- ThumbnailGridView.scrollbar
- ThumbnailGridView.textpos
- JavaScript API reference for eCatalog Viewer
- Event callbacks
- Customize the eCatalog Viewer
- Customize the eCatalog Viewer
- Add Favorite button
- Close button
- Download
- Email share
- Embed share
- Facebook share
- Favorites menu
- Favorites effect
- Favorites view
- First page button
- Focus highlight
- Full screen button
- Icon effect
- Image map effect
- Info panel popup
- Large next page button
- Last page button
- Large previous page button
- Link share
- Main control bar
- Main viewer area
- Next page button
- Page indicator
- Page view
- Previous page button
- Remove Favorite button
- Secondary control bar
- Social share
- Table of contents
- Thumbnails
- Thumbnails button
- Tooltips
- Twitter share
- View All Favorites button
- Zoom in button
- Zoom out button
- Zoom reset button
- Support for Adobe Analytics tracking
- Assistive technology support
- Localization of user interface elements
- Image map support
- Managing page labels
- Full screen support
- Print feature
- Download
- Favorites feature
- Viewer SDK namespace
- eCatalog Search
- eCatalog Search
- Command reference - Configuration attributes
- Command reference – Configuration attributes
- Closebutton
- ControlBar.transition
- direction
- EmailShare.emailurl
- EmbedShare.embedsizes
- FavoritesEffect.expiration
- FavoritesMenu.bearing
- FavoritesView.align
- FavoritesView.favoritesThumbView
- FavoritesView.fmt
- FavoritesView.iscommand
- FavoritesView.maxloadradius
- FavoritesView.textpos
- ImageMapEffect.mapTips
- ImageMapEffect.mode
- ImageMapEffect.rollover
- InfoPanelPopup.infoServerUrl
- InfoPanelPopup.showhidetransition
- InfoPanelPopup.template
- InitialFrame
- PageView.doubleclick
- PageView.enableHD
- PageView.fmt
- PageView.frametransition
- PageView.iconEffect
- PageView.iscommand
- PageView.maxloadradius
- PageView.pageturnstyle
- PageView.singleclick
- PageView.transition
- PageView.zoomstep
- portraitFrames
- Print.printquality
- SearchPanel.align
- SearchPanel.fmt
- SearchPanel.iscommand
- SearchPanel.maxloadradius
- SearchPanel.textpos
- searchServerUrl
- SocialShare.bearing
- TableOfContents.bearing
- TableOfContents.maxitems
- TableOfContents.showdefault
- ThumbnailGridView.align
- ThumbnailGridView.enabledragging
- ThumbnailGridView.fmt
- ThumbnailGridView.maxloadradius
- ThumbnailGridView.scrollbar
- ThumbnailGridView.textpos
- JavaScript API reference for eCatalog Search Viewer
- Event callbacks
- Customize the eCatalog Search Viewer
- Customize the eCatalog Search Viewer
- Add Favorite button
- Close button
- Download
- Email share
- Embed share
- Facebook share
- Favorites effect
- Favorites menu
- Favorites view
- First page button
- Focus highlight
- Full screen button
- Icon effect
- Info panel popup
- Image map effect
- Large next page button
- Large previous page button
- Last page button
- Link share
- Main control bar
- Main viewer area
- Next page button
- Page indicator
- Page view
- Previous page button
- Remove Favorite button
- Search button
- Search effect
- Search results panel
- Secondary control bar
- Social share
- Table of contents
- Thumbnails
- Thumbnails button
- Tooltips
- Twitter share
- View All Favorites button
- Zoom in button
- Zoom out button
- Zoom reset button
- Support for Adobe Analytics tracking
- Assistive technology support
- Localization of user interface elements
- Image map support
- Managing page labels
- Print feature
- Full screen support
- Download
- Search feature
- Viewer SDK namespace
- Flyout
- Flyout
- Command reference - Configuration attributes
- Command reference – Configuration attributes
- FlyoutZoomView.flyouttransition
- FlyoutZoomView.fmt
- FlyoutZoomView.frametransition
- FlyoutZoomView.highlightmode
- FlyoutZoomView.imagereload
- FlyoutZoomView.iscommand
- FlyoutZoomView.overlay
- FlyoutZoomView.preloadtiles
- FlyoutZoomView.tip
- FlyoutZoomView.zoomfactor
- Swatches.align
- Swatches.buttonsnapmode
- Swatches.direction
- Swatches.enabledragging
- Swatches.iscommand
- Swatches.maxloadradius
- Swatches.pagemode
- Swatches.partialswatches
- Swatches.scrollstep
- JavaScript API reference for Flyout Viewer
- Event callbacks
- Customize the Flyout Viewer
- Support for Adobe Analytics tracking
- Assistive technology support
- Localization of user interface elements
- Viewer SDK namespace
- Inline Zoom
- Inline Zoom
- Command reference - Configuration attributes
- Command reference – Configuration attributes
- FlyoutZoomView.flyouttransition
- FlyoutZoomView.fmt
- FlyoutZoomView.frametransition
- FlyoutZoomView.imagereload
- FlyoutZoomView.iscommand
- FlyoutZoomView.preloadtiles
- FlyoutZoomView.tip
- FlyoutZoomView.zoomfactor
- Swatches.align
- Swatches.buttonsnapmode
- Swatches.direction
- Swatches.enabledragging
- Swatches.iscommand
- Swatches.maxloadradius
- Swatches.pagemode
- Swatches.partialswatches
- Swatches.scrollstep
- JavaScript API reference for Inline Zoom Viewer
- Event callbacks
- Customize the Inline Zoom Viewer
- Support for Adobe Analytics tracking
- Assistive technology support
- Localization of user interface elements
- Viewer SDK namespace
- Mixed Media
- Mixed Media
- Command reference - Configuration attributes
- Command reference – Configuration attributes
- closebutton
- ControlBar.transition
- FlyoutZoomView.fmt
- FlyoutZoomView.imagereload
- FlyoutZoomView.preloadtiles
- FlyoutZoomView.tip
- SpinView.doubleclick
- SpinView.enableHD
- SpinView.fmt
- SpinView.iconeffect
- SpinView.iscommand
- SpinView.lockdirection
- SpinView.maxloadradius
- SpinView.sensitivity
- SpinView.singleclick
- SpinView.transition
- SpinView.zoomstep
- Swatches.align
- Swatches.buttonsnapmode
- Swatches.direction
- Swatches.enabledragging
- Swatches.fmt
- Swatches.iscommand
- Swatches.maxloadradius
- Swatches.pagemode
- Swatches.partialswatches
- Swatches.scrollstep
- Swatches.textpos
- swatchoverlay
- VideoPlayer.autoplay
- VideoPlayer.iconeffect
- VideoPlayer.initialbitrate
- VideoPlayer.loop
- VideoPlayer.mutevolume
- VideoPlayer.playback
- VideoPlayer.posterimage
- VideoPlayer.preload
- VideoPlayer.progressivebitrate
- VideoPlayer.singleclick
- VideoPlayer.ssl
- VideoPlayer.waiticon
- VideoScrubber.showtime
- VideoScrubber.timepattern
- VideoTime.timepattern
- zoomMode
- ZoomView.doubleclick
- ZoomView.enableHD
- ZoomView.fmt
- ZoomView.iconeffect
- ZoomView.iscommand
- ZoomView.reset
- ZoomView.rgn
- ZoomView.rgnN
- ZoomView.singleclick
- ZoomView.transition
- ZoomView.zoomstep
- JavaScript API reference for Mixed Media Viewer
- Event callbacks
- Customize the Mixed Media Viewer
- Customize the Mixed Media Viewer
- Caption button
- Close button
- Color swatches
- Control bar
- Flyout Zoom View
- Focus highlight
- Full screen button
- Main swatches
- Main viewer area
- Mutable volume
- Play/Pause button
- Set indicator
- Spin left button
- Spin right button
- Spin view
- Spin view icon effect
- Tooltips
- Video full screen button
- Video player
- Video player icon effect
- Video scrubber
- Video time
- Zoom in button
- Zoom out button
- Zoom reset button
- Zoom view
- Zoom view icon effect
- Support for Adobe Analytics tracking
- Assistive technology support
- HTTPS video delivery
- Localization of user interface elements
- Full Screen Support
- Viewer SDK namespace
- Spin
- Video
- Video
- Command reference - Configuration attributes
- Command reference – Configuration attributes
- ControlBar.transition
- EmailShare.emailurl
- EmbedShare.embedsizes
- SocialShare.bearing
- VideoPlayer.autoplay
- VideoPlayer.iconeffect
- VideoPlayer.initialbitrate
- VideoPlayer.loop
- VideoPlayer.mutevolume
- VideoPlayer.playback
- VideoPlayer.posterimage
- VideoPlayer.preload
- VideoPlayer.progressivebitrate
- VideoPlayer.singleclick
- VideoPlayer.ssl
- VideoPlayer.waiticon
- VideoScrubber.chaptertimepattern
- VideoScrubber.showchaptertime
- VideoScrubber.showchaptertitle
- VideoScrubber.timepattern
- VideoTime.timepattern
- Command reference - URL
- JavaScript API reference to Video Viewer
- Event callbacks
- Customize the Video Viewer
- Support for Adobe Analytics tracking
- Assistive technology support
- HTTP video delivery
- Localization of user interface elements
- Full screen support
- External video support
- Viewer SDK namespace
- Zoom
- Zoom
- Command reference - Configuration attributes
- Command reference – Configuration attributes
- closebutton
- Swatches.align
- Swatches.buttomsnapmode
- Swatches.direction
- Swatches.enabledragging
- Swatches.fmt
- Swatches.iscommand
- Swatches.maxloadradius
- Swatches.pagemode
- Swatches.partialswatches
- Swatches.scrollstep
- swatchoverlay
- ZoomView.doubleclick
- ZoomView.enableHD
- ZoomView.fmt
- ZoomView.frametransition
- ZoomView.iconeffect
- ZoomView.iscommand
- ZoomView.reset
- ZoomView.singleclick
- ZoomView.transition
- ZoomView.zoomstep
- JavaScript API reference for Zoom Viewer
- Event callbacks
- Customize the Zoom Viewer
- Support for Adobe Analytics tracking
- Assistive technology support
- Localization of user interface elements
- Full Screen Support
- Viewer SDK namespace
- Viewers for AEM Assets only
- Viewers for AEM Assets only
- Carousel
- Carousel
- Command reference - Configuration attributes
- Command reference - URL
- JavaScript API reference for Carousel Viewer
- Event callbacks
- Customize the Carousel Viewer
- Support for Adobe Analytics tracking
- Assistive technology support
- Localization of user interface elements
- Hotspot and Image maps support
- Preload image
- Viewer SDK namespace
- Interactive Image
- Interactive Image
- Command reference - Configuration attributes
- Command reference - URL
- JavaScript API reference for Interactive Image Viewer
- Event callbacks
- Customize the Interactive Image Viewer
- Support for analytics tracking
- Assistive technology support
- Localization of user interface elements
- Hotspot support
- Preload image
- Viewer SDK namespace
- Interactive Video
- Interactive Video
- Command reference - Configuration attributes
- Command reference – Configuration attributes
- CallToAction.align
- CallToAction.direction
- CallToAction.enabledragging
- CallToAction.fmt
- CallToAction.maxloadradius
- CallToAction.scrollbar
- CallToAction.textpos
- callToActionRecap
- ControlBar.transition
- InteractiveSwatches.autoscroll
- InteractiveSwatches.direction
- InteractiveSwatches.displaymode
- InteractiveSwatches.enabledragging
- InteractiveSwatches.fmt
- InteractiveSwatches.maxloadradius
- InteractiveSwatches.scrollstep
- InteractiveSwatches.textpos
- SocialShare.bearing
- VideoPlayer.autoplay
- VideoPlayer.iconeffect
- VideoPlayer.initialbitrate
- VideoPlayer.loop
- VideoPlayer.mutevolume
- VideoPlayer.playback
- VideoPlayer.posterimage
- VideoPlayer.preload
- VideoPlayer.progressivebitrate
- VideoPlayer.singleclick
- VideoPlayer.ssl
- VideoPlayer.waiticon
- VideoScrubber.chaptertimepattern
- VideoScrubber.showchaptertime
- VideoScrubber.showchaptertitle
- VideoScrubber.timepattern
- VideoTime.timepattern
- Command reference - URL
- JavaScript API reference for Interactive Video Viewer
- Event callbacks
- Customize the Interactive Video Viewer
- Support for Adobe Analytics tracking
- Assistive technology support
- HTTPS video delivery
- Interactive data support
- Localization of user interface elements
- Full screen support
- Viewer SDK namespace
- Smart Crop Video
- Smart Crop Video
- Command reference - Configuration attributes
- Command reference – Configuration attributes
- ControlBar.transition
- EmailShare.emailurl
- EmbedShare.embedsizes
- SocialShare.bearing
- SmartCropVideoPlayer.autoplay
- SmartCropVideoPlayer.iconeffect
- SmartCropVideoPlayer.initialbitrate
- SmartCropVideoPlayer.loop
- SmartCropVideoPlayer.mutevolume
- SmartCropVideoPlayer.playback
- SmartCropVideoPlayer.posterimage
- SmartCropVideoPlayer.preload
- SmartCropVideoPlayer.progressivebitrate
- SmartCropVideoPlayer.singleclick
- SmartCropVideoPlayer.ssl
- SmartCropVideoPlayer.waiticon
- VideoScrubber.chaptertimepattern
- VideoScrubber.showchaptertime
- VideoScrubber.showchaptertitle
- VideoScrubber.timepattern
- VideoTime.timepattern
- Command reference - URL
- JavaScript API reference for Smart Crop Video Viewer
- Event Callbacks
- Customize the Smart Crop Video Viewer
- Support for Adobe Analytics tracking
- HTTPS video delivery
- Assistive technology support
- Localization of user interface elements
- Full screen support
- External video support
- Viewer SDK namespace
- Video360
- Video360
- Command reference - Configuration attributes
- Command reference – Configuration attributes
- ControlBar.transition
- EmbedShare.embedsizes
- SocialShare.bearing
- Video360Player.autoplay
- Video360Player.iconeffect
- Video360Player.initialbitrate
- Video360Player.loop
- Video360Player.mutevolume
- Video360Player.playback
- Video360Player.posterimage
- Video360Player.preload
- Video360Player.progressivebitrate
- Video360Player.singleclick
- Video360Player.ssl
- Video360Player.vrrender
- Video360Player.waiticon
- VideoScrubber.timepattern
- VideoTime.timepattern
- Command reference - URL
- JavaScript API reference for Video360 Viewer
- Event callbacks
- Customize the Video360 Viewer
- Support for Adobe Analytics tracking
- HTTPS video delivery
- Assistive technology support
- Localization of user interface elements
- Full screen support
- External video support
- Viewer SDK namespace
- Command reference common to all viewers - Configuration attributes
- Command reference common to all viewers - URL
getComponent
JavaScript API reference for eCatalog Viewer
getComponent(componentId)
Returns a reference to the Viewer SDK component that is used by the viewer. The web page can use this method to extend or customize the behavior of the out-of-box viewer. Call this method only after the initComplete viewer callback has run, otherwise the component may not be created yet by the viewer logic.
Parameters
*componentID* - {String} an ID of the Viewer SDK component used by the viewer. This viewer supports the following component IDs:
| Component ID |
Viewer SDK component class name |
|---|---|
| parameterManager |
s7sdk.ParameterManager |
| container |
s7sdk.common.Container |
| mediaSet |
s7sdk.set.MediaSet |
| pageView |
s7sdk.set.PageView |
| primaryControls |
s7sdk.common.ControlBar |
| secondaryControls |
s7sdk.common.ControlBar |
| gridView |
s7sdk.set.ThumbnailGridView |
| tableOfContents |
s7sdk.set.TableOfContents |
| infoPanelPopup |
s7sdk.info.InfoPanelPopup |
| imageMapEffect |
s7sdk.image.ImageMapEffect |
| leftButton |
s7sdk.common.PanLeftButton |
| rightButton |
s7sdk.common.PanRightButton |
| zoomInButton |
s7sdk.common.ZoomInButton |
| zoomOutButton |
s7sdk.common.ZoomOutButton |
| zoomResetButton |
s7sdk.common.ZoomResetButton |
| secondaryZoomResetButton |
s7sdk.common.ZoomResetButton |
| thumbnailPageButton |
s7sdk.common.ThumbnailPageButton |
| fullScreenButton |
s7sdk.common.FullScreenButton |
| toolBarLeftButton |
s7sdk.common.PanLeftButton |
| toolBarRightButton |
s7sdk.common.PanRightButton |
| firstPageButton |
s7sdk.common.PanLeftButton |
| secondaryFirstPageButton |
s7sdk.common.PanLeftButton |
| lastPageButton |
s7sdk.common.PanRightButton |
| secondaryLastPageButton |
s7sdk.common.PanRightButton |
| closeButton |
s7sdk.common.CloseButton |
| socialShare |
s7sdk.share.SocialShare |
| twitterShare |
s7sdk.share.TwitterShare |
| facebookShare |
s7sdk.share.FacebookShare |
| linkShare |
s7sdk.share.LinkShare |
| emailShare |
s7sdk.share.EmailShare |
| embedShare |
s7sdk.share.EmbedShare |
| |
s7sdk.share.Print |
| download |
s7sdk.common.Download |
| favoritesEffect |
s7sdk.favorites.FavoritesEffect |
| favoritesView |
s7sdk.favorites.FavoritesView |
| favoritesMenu |
s7sdk.favorites.FavoritesMenu |
| addFavoriteButton |
s7sdk.favorites.AddFavoriteButton |
| removeFavoriteButton |
s7sdk.favorites.RemoveFavoriteButton |
| viewAllFavoriteButton |
s7sdk.favorites.ViewAllFavoriteButton |
| searchButton |
s7sdk.common.SearchButton |
| searchPanel |
s7sdk.search.SearchPanel |
| searchManager |
s7sdk.search.SearchManager |
| searchEffect |
s7sdk.search.SearchEffect |
When working with SDK APIs it is important to use correct fully qualified SDK namespace as described in Viewer SDK namespace.
See the Viewer SDK API documentation for more information about a particular component.
Returns
{Object} a reference to Viewer SDK component. The method returns null if the componentId is not a supported viewer component or if the component was not yet created by the viewer logic.
Example
<instance>.setHandlers({
"initComplete":function() {
var pageView = <instance>.getComponent("pageView");
}
})
Business.Adobe.com resources
Resources
Adobe Account
Change language
Copyright © 2023 Adobe. All Rights Reserved.
