HTML5 Viewer SDK API Documentation 

Namespaces


Class Index

Classes in s7sdk

Class s7sdk.OrientationSetDesc


Extends s7sdk.ItemDesc.

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. Those instances have different frame count, page sizes, labels and metadata.

MediaSetDesc provides two utility methods to convert frame index specific to landscape mode into portrait-specific frame index and back: getPortraitIndex() and getLandscapeIndex().

Class Summary
Constructor Attributes Constructor Name and Description
 
s7sdk.OrientationSetDesc(landscape, portrait)
Field Summary
Field Attributes Field Name and Description
 
MediaSetDesc instance to be used in landscape orientation.
 
MediaSetDesc instance to be used in portrait orientation.
Fields borrowed from class s7sdk.ItemDesc:
name, parent, swatch, type
Method Summary
Method Attributes Method Name and Description
 
getLandscapeIndex(idxPortrait)
returns frame index in landscape mode for a given index from portrait mode
 
getPortraitIndex(idxLandscape)
returns frame index in portrait mode for a given index from landscape mode
Class Detail
s7sdk.OrientationSetDesc(landscape, portrait)
Parameters:
{MediaSetDesc} landscape
landscape MediaSetDesc instance.
{MediaSetDesc} portrait
portrait MediaSetDesc instance.
See:
s7sdk.set.MediaSet
s7sdk.set.MediaSetDesc
Field Detail
landscape
MediaSetDesc instance to be used in landscape orientation.

portrait
MediaSetDesc instance to be used in portrait orientation.
Method Detail
{int} getLandscapeIndex(idxPortrait)
returns frame index in landscape mode for a given index from portrait mode
Parameters:
{int} idxPortrait
index in portrait set.
Returns:
{int} corresponding index in landscape set.

{int} getPortraitIndex(idxLandscape)
returns frame index in portrait mode for a given index from landscape mode
Parameters:
{int} idxLandscape
index in landscape set.
Returns:
{int} corresponding index in portrait set.

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Oct 15 2020 11:59:13 GMT-0000 (UTC)