HTML5 Viewer SDK API Documentation 

Namespaces

All Classes

Class Index


s7sdk.CapabilityState

Manages a set of capability states.


s7sdk.CarouselViewCapabilityState

The CarouselViewCapabilityState can be used to determine the current state of the CarouselView component.


s7sdk.common.Button

The Button base class manages the core logic and behavior for the various button sub-classes that are provided with the SDK.


s7sdk.common.CloseButton

The CloseButton is used to close the viewer's browser window when the window is opened using JavaScript.


s7sdk.common.ClosedCaptionButton

The ClosedCaptionButton is a two state button that is used to enable or disable closed captioning in a video.


s7sdk.common.Container

The Container component can be used as a parent component for other UI components that are part of the viewer application.


s7sdk.common.ControlBar

The ControlBar is a convenience component which acts as container to a set of UI elements like buttons and such.


s7sdk.common.Download

The Download is a button component which allows to download a PDF file associated with the catalog asset to the local system.


s7sdk.common.FullScreenButton

The FullScreenButton can be associated with a Container component to enter and exit full screen mode.


s7sdk.common.PanDownButton

You can associate the PanDownButton with a ZoomView component to pan down the current image in the viewer.


s7sdk.common.PanLeftButton

You can associate the PanLeftButton with a ZoomView component to pan left the current image in the viewer.


s7sdk.common.PanRightButton

You can associate the PanRightButton with a ZoomView component to pan right on the current image in the viewer.


s7sdk.common.PanUpButton

You can associate the PanUpButton with a ZoomView component to pan up the current image in the viewer.


s7sdk.common.PlayPauseButton

The PlayPauseButton is a two state button that is typically used for toggling between playing (or replaying) and pausing of the video playback in the VideoPlayer component.


s7sdk.common.ScrollLeftRightButton

The ScrollLeftRightButton is a two state button that is used to controlBar scrolling.


s7sdk.common.ScrubberSwatchesButton

The ScrubberSwatchesButton is a two state button that is typically used for toggling between the PageScrubber and Swatches components in eCatalog applications.


s7sdk.common.SearchButton

The SearchButton is a two state button that is used to show and hide search UI.


s7sdk.common.ThumbnailPageButton

The ThumbnailPageButton is a two state button that is typically used for toggling between the PageView and ThumbnailGridView components in eCatalog applications.


s7sdk.common.TwoStateButton

The TwoStateButton base class manages the core logic and behavior for the various two state button sub-classes that are provided with the SDK.


s7sdk.common.WebVtt

WebVtt is a class for parsing WebVtt content which could be used for various purpose


s7sdk.common.WebVttItem

WebVttItem represents a WebVtt cue.


s7sdk.common.ZoomInButton

You can associate the ZoomInButton with a ZoomView component to zoom in the viewer.


s7sdk.common.ZoomOutButton

You can associate the ZoomOutButton with a ZoomView component to zoom out the view.


s7sdk.common.ZoomResetButton

You can associate the ZoomResetButton with a ZoomView component to reset the zoom state of the view.


s7sdk.Enum

Collection of enumerated types.


s7sdk.event.AssetEvent

Dispatched every time a new asset is selected.

s7sdk.event.CapabilityStateEvent

Dispatched whenever the component capability is changed.

s7sdk.event.ControlComponentEvent

A ComponentUpdatedEvent is dispatched by components when either setCSS or setModifier is called on a component.

s7sdk.event.FavoritesEvent


s7sdk.event.FlyoutEvent

FlyoutEvent is dispatched every time the flyout view is shown or hidden.

s7sdk.event.FrameEvent

FrameEvent is dispatched every time the currently active frame changes.

s7sdk.event.InteractiveDataEvent

This event is dispatched for notifying availability of Interactive Data or when the interactive section is updated.

s7sdk.event.InteractiveSwatchesEvent

This event is dispatched by the InteractiveSwatches component to notify a action taken place due to user selection.

s7sdk.event.PopupEvent

This event is dispatched when a popup panel is closed.

s7sdk.event.ResizeEvent

Dispatched when a component or window changes its size.

s7sdk.event.RolloverKeyEvent

Dispatched by components such as the ImageMapEffect when rollover actions occur.

s7sdk.event.ScrollEvent

Dispatched every time the scroll position has changed.

s7sdk.event.SearchEvent

This event is dispatched by SearchManager and SearchPanel components when new search is submitted by the user or search request is processed and search response is generated.

s7sdk.event.SliderEvent

Dispatched by slider based components whenever particular actions have occurred.

s7sdk.event.SocialEvent

A SocialEvent is dispatched by components from s7sdk.share package whenever sharing components are activated by the user.

s7sdk.event.StatusEvent

This event is sent when internal component state changes as more asset data is loaded the server by the component.

s7sdk.event.SwatchEvent

Dispatched every time the current page changes.

s7sdk.event.UserEvent

A UserEvent is dispatched by the SDK Viewer components when a user-initiated action occurs.

s7sdk.event.VideoEvent

A VideoEvent is dispatched by VideoPlayer component whenever video playback state changes.

s7sdk.event.ZoomPanEvent

Dispatched by NavigationView when the user has moved the view rectangle.

s7sdk.event.ZoomRgnEvent

Dispatched by ZoomView and SpinView when the viewport rectangle changes.

s7sdk.event.ZoomTargetEvent

Dispatched whenever a zoom target has been selected.

s7sdk.favorites.AddFavoriteButton

The AddFavoriteButton is a toggle button normally used inside FavoritesMenu component.


s7sdk.favorites.FavoriteDesc

This is a single favorite instance added to particular frame in a catalog.


s7sdk.favorites.FavoritesEffect

The FavoritesEffect is an effect component which implements storing, rendering and editing capabilities for "favorites" feature.


s7sdk.favorites.FavoritesMenu

The FavoritesMenu is used as container for "favorites" buttons.


s7sdk.favorites.FavoritesView

The FavoritesView component is used to render the list of favorites added to the current catalog as thumbnails.


s7sdk.favorites.RemoveFavoriteButton

The RemoveFavoriteButton is a toggle button normally used inside FavoritesMenu component.


s7sdk.favorites.ViewAllFavoriteButton

The ViewAllFavoriteButton is a toggle button normally used inside FavoritesMenu component.


s7sdk.image.FlyoutZoomView

The FlyoutZoomView is an image viewing component that displays an image served by Adobe Scene7 Image Serving.


s7sdk.image.HotSpotEffect

The HotSpotEffect component is an effects component designed to add functionality to the ZoomView and SpinView components.


s7sdk.image.ImageMapEffect

The ImageMapEffect component is an effects component designed to add functionality to the ZoomView, SpinView and PageView components.


s7sdk.image.NavigationView

The NavigationView is an image viewing component that displays a thumbnail image served by Adobe Scene7 Image Serving.


s7sdk.image.PanoramicView

The PanoramicView is an image viewing component that displays a spherical panoramic image served by Adobe Scene7 Image Serving.


s7sdk.image.ZoomTargets

The ZoomTargets are essentially hyperlinks to specific regions in the image.


s7sdk.image.ZoomView

The ZoomView is an image viewing component that displays an image served by Adobe Scene7 Image Serving.


s7sdk.ImageDesc

The ImageDesc represents an image and corresponds to the <item> element of the req=set response that contains an <i> element.


s7sdk.info.InfoPanelPopup

InfoPanelPopup is a component that displays an info panel pop-up, normally on top of another image viewing component or in dedicated page area, typically in response to a dispatched RolloverKeyEvent event.


s7sdk.InteractiveSwatchDesc

This is a single interactive swatch instance added to an InteractiveSwatches component.


s7sdk.ItemDesc

The ItemDesc is a base class of every set element.


s7sdk.ItemDescType

Asset types for ItemDesc.


s7sdk.Logger

The Logger is a special component that, like the ParameterManager, is part of the HTML5 Viewers SDK core and as such included in the Utils.js.


s7sdk.MapDesc

The MapDesc corresponds to the <map> element of the req=set response and it represents image maps.


s7sdk.MapDescShape

Shapes of image maps.


s7sdk.MediaSetDesc

The MediaSetDesc object represents a collection of images, videos, and other assets.


s7sdk.MediaSetParser

Static functions for handling MediaSet (req=set ImageServing) responses.

s7sdk.model.AttributeSelectorModel

The AttributeSelectorModel is a collection of property models that all fall under a particular CSS selector.

s7sdk.model.ClassSelectorModel

The ClassSelectorModel is a collection of property models that all fall under a particular CSS selector.

s7sdk.model.ComponentModifierModel

Base component model class.

s7sdk.model.CSSBackgroundModel

Background model groupds image, color, size and repeat

s7sdk.model.CSSBorderModel

Border model groups width, color, style and radius

s7sdk.model.CSSBoxShadowModel

BoxShadow model groupds image, color, size and repeat

s7sdk.model.CSSFontModel


s7sdk.model.CSSPositionModel

Postion model groups CSS properties that deal with position and will be represented by one widget, like: position, top, bottom, etc.

s7sdk.model.CSSPropertyModel

Base CSSProperty model class.

s7sdk.model.CSSSizeModel

Size model groups CSS properties that deal with size and will be represented by one widget, like width and height.

s7sdk.model.CSSSpriteModel

Sprite model

s7sdk.model.ModifierConstraint


s7sdk.model.ModifierModel

Model that wraps and manages Modifier objects

s7sdk.model.SelectorModel

The SelectorModel represents a "simple selector" that can take part in a chain of other SelectorModel instances to form a full selector.

s7sdk.model.SelectorModel.Specificity


s7sdk.Observable

All classes interested in the notification must implement methods that are part of this interface.

s7sdk.OrientationSetDesc

The OrientationSetDesc contains two instances of MediaSetDesc produced by MediaSet component from the same req=set Image Serving response, one for landscape orientation and another for portrait.


s7sdk.PageViewCapabilityState

The PageViewCapabilityState can be used to determine the current state of the PageView component.


s7sdk.ParameterManager

The ParameterManager is a special component that is part of the HTML5 Viewers SDK core and as such included in the Utils.js.


s7sdk.Point2D

Point2D class.

s7sdk.Rectangle

Rectangle class.

s7sdk.search.SearchEffect

The SearchEffect component is an effects component which renders search result regions on top of the page image, it is designed to work with the PageView component only.


s7sdk.search.SearchManager

The SearchManager is a non-visual component which implements parsing of the search text input, communication with the search server and processing of search results returned by the search server.


s7sdk.search.SearchPanel

The SearchPanel component provides UI for entering and submitting search text and also renders search results as scrollable thumbnails.


s7sdk.search.SearchResultsDesc

This class represents a complete response of the search server for a particular search query.


s7sdk.search.SearchResultsFrameDesc

This class represents a single frame, or spread in the catalog which has at least one search hit.


s7sdk.search.SearchResultsPageDesc

This class represents a single page within a catalog frame which contains at least one search hit.


s7sdk.set.CallToAction

The CallToAction component is used to render the list of swatches that are associated with interactive actions, the close button and the optional title.


s7sdk.set.CarouselView

The CarouselView is an image viewing component that displays images served by Adobe Scene7 Image Serving that are combined into an image set.


s7sdk.set.InteractiveSwatches

The InteractiveSwatches component is used to render the list of swatches that are associated with interactive actions.


s7sdk.set.InteractiveThumbnailGridView

The InteractiveThumbnailGridView component is used to render the list of swatches that are associated with interactive actions.


s7sdk.set.MediaSet

The MediaSet component retrieves an image set definition from Image Serving and parses the set into a DOM-like structure whose elements describe the set.


s7sdk.set.PageScrubber

The PageScrubber is a navigation type of component that provides ability to scrub through the images of a set.


s7sdk.set.PageView

The PageView is an image viewing component that displays images served by Adobe Scene7 Image Serving that are combined into an eCatalog set.


s7sdk.set.SetIndicator

The SetIndicator component provides the ability to show a series of 'page' indicators.


s7sdk.set.SpinView

The SpinView is an image viewing component that displays a spin set served by Adobe Scene7 Image Serving.


s7sdk.set.Swatches

The Swatches component renders a collection of thumbnail images called swatches.


s7sdk.set.Swatches2

The Swatches2 component renders a collection of SwatchImageRenderer images.


s7sdk.set.TableOfContents

The TableOfContents is a composite component which consists of a button and a drop-down list which contains MediaSetDesc element indexes and labels.


s7sdk.set.ThumbnailGridView

The ThumbnailGridView component renders a collection of thumbnail images in a grid layout.


s7sdk.share.EmailShare

The EmailShare component allows user to share content via email.


s7sdk.share.EmbedShare

The EmbedShare component allows user to create embed code for the application, select, copy it to clipboard and use it for embedding the content into other web page.


s7sdk.share.FacebookShare

The FacebookShare component allows user to share content to Facebook.


s7sdk.share.LinkShare

The LinkShare.


s7sdk.share.Print

The Print is a component which allows to print catalog contents.


s7sdk.share.SocialShare

The SocialShare is used as container for social buttons.


s7sdk.share.TwitterShare

The TwitterShare component allows user to share content to Twitter.


s7sdk.SpinCapabilityState

Manages a set of spin capabilities.


s7sdk.SwatchDesc

The SwatchDesc object corresponds to the <s> element of the req=set response and represents a swatch that is associated with the item.


s7sdk.TargetDesc

The TargetDesc corresponds to the <targets> element of the req=set response and it represents zoom targets.


s7sdk.TrackingManager

The TrackingManager component emits user-initiated events that are suitable for tracking purposes.


s7sdk.Util

Scene7 utility functions for Viewer SDK.

s7sdk.Util.css

CSS file management utilities

s7sdk.Util.lib

JavaScript library management functions

s7sdk.video.MutableVolume

The MutableVolume is a composite user interface component that combines the vertical volume control with a mute button.


s7sdk.video.VideoPlayer

The VideoPlayer is a video viewing component that displays a MP4 or Adaptive Video Set video served by Adobe Scene7.


s7sdk.video.VideoScrubber

The VideoScrubber is a component that is used to display the current playback time of a video or audio file relative to its duration, and to allow a user to "scrub" a video or audio file to commence playback at any time position he chooses.


s7sdk.video.VideoTime

The VideoTime component can be associated with a VideoPlayer component to display the duration and elapsed time in a video.


s7sdk.VideoCapabilityState

Manages a set of video capabilities.


s7sdk.VideoDesc

The VideoDesc corresponds to the <item> element of the req=set response that contains a <v> element and it represents a video asset.


s7sdk.VideoDescType

Types for the name field of VideoDescType.


s7sdk.VideoSetDesc

The VideoSetDesc object represents a collection videos.


s7sdk.VisibilityManager

The VisibilityManager is a static manager component that manages the visibility of all its attached components based on the click event of a reference component.


s7sdk.ZoomCapabilityState

Manages a set of zoom capabilities.


Documentation generated by JsDoc Toolkit 2.4.0 on Wed Sep 05 2018 15:32:54 GMT-0000 (UTC)