Skip to main content

Global Hot Spots Parameters

enableHotspots​

boolean

enables or disables hot spots
since 17.10
true
Default

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

hotspotCallbackFunction​

function

callback function for hot spots
since 17.10

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:
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​

rgb hex

lighter color of the hot spot marker lines
since 17.10
#FFFF00
Default

The lighter (6-digit hex) color of the hot spot marker lines.

hotspotLineColor2​

rgb hex

darker color of the hot spot marker lines
since 17.10
#000000
Default

The darker (6-digit hex) color of the hot spot marker lines.

hotspotDotColor1​

rgb hex

lighter color of the hot spot marker dot
since 17.10
#FFFF00
Default

The lighter (6-digit hex) color of the hot spot marker circle's gradient.

hotspotDotColor2​

rgb hex

darker color of the hot spot marker dot
since 17.10
#000000
Default

The darker (6-digit hex) color of the hot spot marker circle's gradient.

decodeHTMLEntitiesInHotSpotTexts​

boolean

enables html entities in the hotspots text
since 17.10
false
Default

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

hotspotDotRadius​

float

radius of the hot spot marker circle in px
since 17.10
4.0
Default

The radius of the hot spot marker circle in px.