Class s7sdk.ImageDesc
Extends
s7sdk.ItemDesc.
The ImageDesc represents an image and corresponds to the <item> element of the req=set response that contains an <i> element.
The image element points to an image record (name attribute), and may contain a label. Additional record attributes for default image flag
(isDefault), modifier (mod), and post modifier (pmod) are included, if relevant. An image element can contain an
optional userdata element.
This record also includes the image width and height and the version that are used for Image Serving tile requests.
The item might contain optional targets and maps elements that represent private zoom targets and image maps associated with
this record.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
s7sdk.ImageDesc(parent, type, name, swatch, width, height, version, isDefault, mod, pmod, label, maps, targets, userData, mapsuppressed, userdatasuppressed, np)
|
| Field Attributes | Field Name and Description |
|---|---|
|
Image height.
|
|
|
Sub-images.
|
|
|
An optional default image tag.
|
|
|
An optional label associated with the image.
|
|
|
Image maps associated with this image.
|
|
|
This flag (true|false) indicates whether or not hotspots are suppressed for this item (e-catalogs only).
|
|
|
Optional modifiers associated with the image.
|
|
|
Indicates whenever the item aspect ratio is less than 80% of the aspect ratio of the subsequent/previous
item.
|
|
|
Optional post modifiers associated with the image.
|
|
|
Zoom targets associated with this image.
|
|
|
User data is a name/value structure that represents the content stored in the catalog::UserData field.
|
|
|
This flag (true|false) indicates whether or not userdata is suppressed for this item (e-catalogs only).
|
|
|
Image version that is used for tile requests instead of sending an additional CTX request to Image Serving.
|
|
|
Image width.
|
- Fields borrowed from class s7sdk.ItemDesc:
- name, parent, swatch, type
Class Detail
s7sdk.ImageDesc(parent, type, name, swatch, width, height, version, isDefault, mod, pmod, label, maps, targets, userData, mapsuppressed, userdatasuppressed, np)
- Parameters:
- parent
- The parent set.
- type
- The type of the item. In this case, type is alway
img. - name
- The catalog ID or the image path associated with the item.
- swatch
- The swatch associated with the item.
- width
- Image top resolution width.
- height
- Image top resolution height.
- version
- Image version.
- isDefault
- The default image indicator.
- mod
- The modifiers associated with the image.
- pmod
- The post modifiers associated with the image.
- label
- The label associated with the image.
- maps
- Private image maps associated with the image.
- targets
- Private zoom targets associated with the image.
- userData
- Optional userdata associated with the image.
- mapsuppressed
- userdatasuppressed
- np
- Aspect ratio of the first/last item is less tha 80% of the subsequent/previous item.
- See:
- s7sdk.set.MediaSet
Field Detail
height
Image height. It corresponds to the
dy attribute of the <item> element.
images
Sub-images.
isDefault
An optional default image tag. It corresponds to the
isDefault attribute of the <i> element.
It is set to true if no image is found for this ID and Image Serving substituted a default image.
label
An optional label associated with the image. It corresponds to the
l attribute of the <i> element.
maps
Image maps associated with this image.
mapsuppressed
This flag (true|false) indicates whether or not hotspots are suppressed for this item (e-catalogs only).
mod
Optional modifiers associated with the image. It corresponds to the content of the catalog::Modifier for this image.
np
Indicates whenever the item aspect ratio is less than 80% of the aspect ratio of the subsequent/previous
item. This property is only meaningful with first/last items of an e-catalog or unknown set.
pmod
Optional post modifiers associated with the image. It corresponds to the content of the catalog::PostModifier for this image.
targets
Zoom targets associated with this image.
userData
User data is a name/value structure that represents the content stored in the catalog::UserData field.
userdatasuppressed
This flag (true|false) indicates whether or not userdata is suppressed for this item (e-catalogs only).
version
Image version that is used for tile requests instead of sending an additional CTX request to Image Serving.
It corresponds to the
iv attribute of the <item> element.
width
Image width. It corresponds to the
dx attribute of the <item> element.