Global Parameters for Hot Spots


enableHotspots

Descriptionenables or disables hot spots
Syntaxboolean
Defaulttrue
ContextFSI Viewer

You can set this value to false if hot spots have been defined, but should not be displayed.


hotspotCallbackFunction

Descriptioncallback function for hot spots
Syntaxstring/ function
Default""
ContextFSI Viewer

The name of a custom JavaScript callback function in window scope to call each time a hot spot mouse action occurs.

Alternatively you can pass the function directly as a JavaScript parameter.


Example of a callback function prototype:


Callback Function Prototype:
function onFSIViewerHSAction(strAction, viewer, idViewer, idHotspot, node, param, angle) {
  if (strAction == "click") {
    alert("clicked on hot spot " + idHotspot);
  }
}



AttributeDescription
actiona string representing the action "mouseover", "mouseout", "mousedown" or "click"
viewerthe FSI Viewer viewer instance calling the method
idViewerthe value of the "id" attribute of the viewer's <div> tag
idHotspotthe 0-based id of the hotspot
nodethe <div> node containing the hot spot content
paramthe content of the "actionParameter" parameter of the hot spot
anglethe hot spot's perimeterAngle value (the angle at which it's visible best)



hotspotLineColor1

Descriptionlighter color of the hot spot marker lines
Syntax6-digit hex color
Default#FFFF00
ContextFSI Viewer

The lighter color of the hot spot marker lines.


hotspotLineColor2

Descriptiondarker color of the hot spot marker lines
Syntax6-digit hex color
Default#000000
ContextFSI Viewer

The darker color of the hot spot marker lines.


hotspotDotColor1

Descriptionlighter color of the hot spot marker lines
Syntax6-digit hex color
Default#FFFF00
ContextFSI Viewer

The lighter color of the hot spot marker circle's gradient.


hotspotDotColor2

Descriptiondarker color of the hot spot marker lines
Syntax6-digit hex color
Default#000000
ContextFSI Viewer

The darker color of the hot spot marker circle's gradient.


decodeHTMLEntitiesInHotSpotTexts

Descriptionenables html entities in the hotspots text
SyntaxBoolean
Defaultfalse
ContextFSI Viewer

When enabled, basic HTML entities will be enabled in the hotspot text.


hotspotDotRadius

Descriptionradius of the hot spot marker circle in px
Syntaxfloat
Default4.0
ContextFSI Viewer

The radius of the hot spot marker circle in px.