HTML5 Viewer SDK API Documentation 

Namespaces


Class Index

Classes in s7sdk.event

Class s7sdk.event.RolloverKeyEvent

Dispatched by components such as the ImageMapEffect when rollover actions occur.

Class Summary
Constructor Attributes Constructor Name and Description
 
s7sdk.event.RolloverKeyEvent(type, rolloverKey, boundingBox, href, bubbles, frame, quickViewData)
Field Summary
Field Attributes Field Name and Description
 
Bounding box of the activation target in global coordinates that are used for pop-up positioning.
 
Specifies the index of the frame in the set in case RolloverKeyEvent.TARGET_INDEX event type.
 
Specifies the destination of the link that is us.
<static>  
s7sdk.event.RolloverKeyEvent.HREF_ACTIVATED
The event is sent always when an image map is clicked or tapped.
<static>  
s7sdk.event.RolloverKeyEvent.QUICKVIEW_ACTIVATED
Defines the value of the type property of a quickViewData event object.
 
Specifies the JSON object in case RolloverKeyEvent.QUICKVIEW_ACTIVATED event type.
<static>  
s7sdk.event.RolloverKeyEvent.ROLLOVER_ACTIVATED
Defines the value of the type property of a rolloverActivated event object.
<static>  
s7sdk.event.RolloverKeyEvent.ROLLOVER_DEACTIVATED
Defines the value of the type property of a rolloverDeactivated event object.
 
The rollover key associated with the target or hotspot that triggered the activation.
<static>  
s7sdk.event.RolloverKeyEvent.TARGET_INDEX
Defines the value of the type property of a targetIndex event object.
<static>  
s7sdk.event.RolloverKeyEvent.VIEWER_ACTIVATED
Defines the value of the type property of a viewerActivated event object.
Class Detail
s7sdk.event.RolloverKeyEvent(type, rolloverKey, boundingBox, href, bubbles, frame, quickViewData)
Parameters:
{String} type
Defines the value of the type property.
{String} rolloverKey
The rollover identifier passed from the Image Map data.
{s7sdk.Rectangle} boundingBox
The rectangle bounding the rollover area.
{String} href
Associated url for the rollover area.
{Boolean} bubbles
Defines whether the event bubbles.
{Number} frame
The index of the frame in the set.
{JSON} quickViewData
JSON object representing quick view data from href attribute of the image map.
See:
s7sdk.image.ImageMapEffect
s7sdk.info.InfoPanelPopup
Field Detail
boundingBox
Bounding box of the activation target in global coordinates that are used for pop-up positioning.

frame
Specifies the index of the frame in the set in case RolloverKeyEvent.TARGET_INDEX event type.

href
Specifies the destination of the link that is us.

<static> s7sdk.event.RolloverKeyEvent.HREF_ACTIVATED
The event is sent always when an image map is clicked or tapped. The argument of the event ("href" property) contains raw href attribute value, without any parsing.

<static> s7sdk.event.RolloverKeyEvent.QUICKVIEW_ACTIVATED
Defines the value of the type property of a quickViewData event object. This event is dispatched when given href points to JSON object representing quick view data of the image map..

quickViewData
Specifies the JSON object in case RolloverKeyEvent.QUICKVIEW_ACTIVATED event type.

<static> s7sdk.event.RolloverKeyEvent.ROLLOVER_ACTIVATED
Defines the value of the type property of a rolloverActivated event object. This event is dispatched when it is desirable to activate a rollover given the rolloverKey.

<static> s7sdk.event.RolloverKeyEvent.ROLLOVER_DEACTIVATED
Defines the value of the type property of a rolloverDeactivated event object. This event is dispatched when it is desirable to deactivate a particular rollover given the rolloverKey.

rolloverKey
The rollover key associated with the target or hotspot that triggered the activation.

<static> s7sdk.event.RolloverKeyEvent.TARGET_INDEX
Defines the value of the type property of a targetIndex event object. This event is dispatched when given href points to the internal frame index rather than external URL.

<static> s7sdk.event.RolloverKeyEvent.VIEWER_ACTIVATED
Defines the value of the type property of a viewerActivated event object. This event is dispatched when it is desirable to activate a particular rollover given the rolloverKey.

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