HTML5 Viewer SDK API Documentation 

Namespaces


Class Index

Classes in s7sdk

Class s7sdk.MapDesc

The MapDesc corresponds to the <map> element of the req=set response and it represents image maps. Image maps define different areas that function as hotspots in the image. They can be private, associated with a particular asset, or shared, associated with all images in the set. Shared maps apply only to images that are defined at the same set level as the shared maps. That is, shared image maps do not apply recursively to the children of nested image sets.

Class Summary
Constructor Attributes Constructor Name and Description
 
s7sdk.MapDesc(shape, coords, alt, href, rolloverKey, target)
Field Summary
Field Attributes Field Name and Description
 
alt
Optional text to display as a rollover tooltip.
 
The polygon vertices.
 
Optional hyperlink for this area; can be a URL, a JavaScript fragment, or an internal link.
 
Item identifier.
 
The shape specifies the shape of the hotspot area.
 
Optional browser target frame in which to display the web page referenced by href.
Class Detail
s7sdk.MapDesc(shape, coords, alt, href, rolloverKey, target)
Parameters:
shape
The shape of the area. Only poly is supported.
coords
The polygon vertices. Each two consecutive points are interpreted as an X,Y pair.
alt
Optional text to display as a rollover tooltip.
href
Optional hyperlink for this area.
rolloverKey
Item identifier.
target
Browser target frame in which to display the web page referenced by href.
See:
s7sdk.set.MediaSet
Field Detail
alt
Optional text to display as a rollover tooltip.

coords
The polygon vertices. Required.

href
Optional hyperlink for this area; can be a URL, a JavaScript fragment, or an internal link. The internal href links allow changing of frames (pages) within the image set. They are specified as follows:

target:frame

The frame can be either a frame sequence number (the 0-based index of the image in the set), or the exact, full name of the image set item. The target property is ignored if an internal href link is specified.

rolloverKey
Item identifier. Primarly used to display dynamic content from the info server using the InfoPanelPopup component. The InfoPanelPopup component is currently not available in the HTML5 SDK.

shape
The shape specifies the shape of the hotspot area. Only poly shape is supported at this time. Required.

target
Optional browser target frame in which to display the web page referenced by href. Defaults to _self (same browser frame) if not specified.

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Jan 30 2020 16:40:37 GMT+0200 (EET)