HTML5 Viewer SDK API Documentation 

Namespaces


Class Index

Classes in s7sdk

Class s7sdk.InteractiveSwatchDesc

This is a single interactive swatch instance added to an InteractiveSwatches component. The InteractiveSwatchDesc object corresponds to a swatch that is associated with the item and an action. The swatch point to an image record. Additional record attributes for modifier (mod) and post modifier (pmod) are included if relevant; however, they are ignored by the SDK components.

Class Summary
Constructor Attributes Constructor Name and Description
 
s7sdk.InteractiveSwatchDesc(image, color, label, version, mod, pmod, href, target)
Field Summary
Field Attributes Field Name and Description
 
Solid color to show in the swatch thumbnail.
 
Hyperlink associated with the swatch, could be a URL, a JavaScript fragment, or an internal link
 
Catalog ID or path of the image to show in the swatch thumbnail.
 
Optional label associated with the solid color swatch.
 
mod
Optional modifiers associated with the swatch.
 
Optional post modifiers associated with the swatch.
 
Optional target associated with the swatch for navigating to a URL
 
Swatch image version.
Class Detail
s7sdk.InteractiveSwatchDesc(image, color, label, version, mod, pmod, href, target)
Parameters:
image
The catalog ID or path of the image to display in the thumbnail.
color
The packed hexadecimal RGB color value (0xrrggbb) to use for solid color swatches.
label
The optional text label to use with the solid color swatches.
version
The image version.
mod
The modifiers associated with the swatch image.
pmod
The post modifiers associated with the swatch image.
href
The Hyperlink for this swatch. The hyperlink is a URL, QuickView or a JavaScript fragment.
target
Optional target to navigate to a URL, e.g. _blank for a new window, default to _self for current window.
See:
s7sdk.set.MediaSet
s7sdk.common.WebVtt
Field Detail
color
Solid color to show in the swatch thumbnail. If specified, it takes precedence over the image attribute.

href
Hyperlink associated with the swatch, could be a URL, a JavaScript fragment, or an internal link

image
Catalog ID or path of the image to show in the swatch thumbnail.

label
Optional label associated with the solid color swatch.

mod
Optional modifiers associated with the swatch.

pmod
Optional post modifiers associated with the swatch.

target
Optional target associated with the swatch for navigating to a URL

version
Swatch image version.

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