HTML5 Viewer SDK API Documentation 

Namespaces


Class Index

Classes in s7sdk

Class s7sdk.MediaSetDesc


Extends s7sdk.ItemDesc.

The MediaSetDesc object represents a collection of images, videos, and other assets. It corresponds to the <set> element of the req=set response, The set element is a container of 0 or more items with optional shared targets, maps, and userdata associated with this catalog record.

Class Summary
Constructor Attributes Constructor Name and Description
 
s7sdk.MediaSetDesc(parent, level, type, name, swatch)
Field Summary
Field Attributes Field Name and Description
 
Items that belong to this set.
 
Zero-based set level where 0 corresponds to the top-level set.
 
Optional shared image maps that apply to all immediate children of the set that represent images.
 
Optional shared zoom targets that apply to all immediate children of the set that represent images.
 
Optional user data associated with this catalog record.
 
Optional vtt data associated with all video records.
Fields borrowed from class s7sdk.ItemDesc:
name, parent, swatch, type
Class Detail
s7sdk.MediaSetDesc(parent, level, type, name, swatch)
Parameters:
{MediaSetDesc} parent
parent media set instance.
{Number} level
Zero-based set level where 0 corresponds to the top-level set.
{ItemDescType} type
The type of the item element. The supported types are listed in the ItemDescType enumeration.
{String} name
The name represents the catalog ID of the set element and it corresponds to the n attribute of the <i>, <v> or <set> XML elements of the req=set response.
{SwatchDesc} swatch
swatch associated with this media set.
See:
s7sdk.set.MediaSet
Field Detail
items
Items that belong to this set.

level
Zero-based set level where 0 corresponds to the top-level set.

maps
Optional shared image maps that apply to all immediate children of the set that represent images.

targets
Optional shared zoom targets that apply to all immediate children of the set that represent images.

userdata
Optional user data associated with this catalog record.

vtts
Optional vtt data associated with all video records.

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