Global Parameters for Hot Spots
enableHotspots | |
|---|---|
| Description | enables or disables hot spots |
| Syntax | boolean |
| Default | true |
| Context | FSI Viewer |
You can set this value to false if hot spots have been defined, but should not be displayed.
hotspotCallbackFunction | |
|---|---|
| Description | callback function for hot spots |
| Syntax | string/ function |
| Default | "" |
| Context | FSI 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);
}
}
| Attribute | Description |
|---|---|
| action | a string representing the action "mouseover", "mouseout", "mousedown" or "click" |
| viewer | the FSI Viewer viewer instance calling the method |
| idViewer | the value of the "id" attribute of the viewer's <div> tag |
| idHotspot | the 0-based id of the hotspot |
| node | the <div> node containing the hot spot content |
| param | the content of the "actionParameter" parameter of the hot spot |
| angle | the hot spot's perimeterAngle value (the angle at which it's visible best) |
hotspotLineColor1 | |
|---|---|
| Description | lighter color of the hot spot marker lines |
| Syntax | 6-digit hex color |
| Default | #FFFF00 |
| Context | FSI Viewer |
The lighter color of the hot spot marker lines.
hotspotLineColor2 | |
|---|---|
| Description | darker color of the hot spot marker lines |
| Syntax | 6-digit hex color |
| Default | #000000 |
| Context | FSI Viewer |
The darker color of the hot spot marker lines.
hotspotDotColor1 | |
|---|---|
| Description | lighter color of the hot spot marker lines |
| Syntax | 6-digit hex color |
| Default | #FFFF00 |
| Context | FSI Viewer |
The lighter color of the hot spot marker circle's gradient.
hotspotDotColor2 | |
|---|---|
| Description | darker color of the hot spot marker lines |
| Syntax | 6-digit hex color |
| Default | #000000 |
| Context | FSI Viewer |
The darker color of the hot spot marker circle's gradient.
decodeHTMLEntitiesInHotSpotTexts | |
|---|---|
| Description | enables html entities in the hotspots text |
| Syntax | Boolean |
| Default | false |
| Context | FSI Viewer |
When enabled, basic HTML entities will be enabled in the hotspot text.
hotspotDotRadius | |
|---|---|
| Description | radius of the hot spot marker circle in px |
| Syntax | float |
| Default | 4.0 |
| Context | FSI Viewer |
The radius of the hot spot marker circle in px.