Class 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.
The swatch can either be a solid color or 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.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
s7sdk.SwatchDesc(image, color, label, version, mod, pmod)
|
| Field Attributes | Field Name and Description |
|---|---|
|
Solid color to show in the swatch thumbnail.
|
|
|
Catalog ID or path of the image to show in the swatch thumbnail.
|
|
|
Optional label associated with the solid color swatch.
|
|
|
Optional modifiers associated with the swatch.
|
|
|
Optional post modifiers associated with the swatch.
|
|
|
Swatch image version.
|
Class Detail
s7sdk.SwatchDesc(image, color, label, version, mod, pmod)
- 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.
- See:
- s7sdk.set.MediaSet
Field Detail
color
Solid color to show in the swatch thumbnail. If specified, it takes precedence over the
image attribute.
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.
version
Swatch image version.