Description
Top
|
|
Gizmo Type: imagemapgizmo |
Content |
||||||||||||||
|
Description |
|
|
The imagemapgizmo displays an image with imagemaps (clickable hotspots). This is useful for operations such as showing a clean room with highlighted possible areas of contamination, aerial photo of a facility with sample points identified, and providing an alternate means of navigation through the product (such as using a data model diagram to navigate to SDI Maintenance pages).
To construct the imagemap, a raw file or image Attachment can be used. A "Hotspot Editor" lets you identify hotspots on the image. Each hotspot can have its own URL and counter. The imagemapgizmo can also be used in Dashboards as a parametergizmo to drive queries of other Gizmos.
The OOB LabVantage application provides preconfigured example Gizmos based on the imagemapgizmo.
Properties |
|
|
The following properties are used to configure Gizmos based on the imagemap Gizmo Type:
| Property Name | Description | ||||||||||||||||||||||||||||||
| Gizmo Properties | Defines high-level characteristics of the Gizmo:
|
||||||||||||||||||||||||||||||
| Source Details | Defines details concerning the Image used for the Gizmo.
|
||||||||||||||||||||||||||||||
| HotSpot Map |
Defines details concerning the hotspots on the image. Click the "Add"
button to add a new hotspot. This opens a hotspot editor where you can
define the coordinates of the hotspot. These coordinates can be edited
using the coordinate editor ( "..." button).
Coordinates are stored in pixels relative to the image and represent the (top, left, bottom, right) coordinates of the hotspot rectangle. The hotspot editor lets you drag and resize the highlighted area to define the coordinates of the hotspot. In add mode, you can also define the hotspot label using the editor.
|
||||||||||||||||||||||||||||||
| Default Counter Query Type |
Default override for the "Hotspot Map" settings ("SDI
List" or "SQL"). You can substitute [keyid1] and [attachmentkeyid1]
for the Attachment SDI.
Rather than duplicating the same Counter or URL for each hotspot, the "Default" settings let you define a single "Default" property and substitute in the Source KeyId 1/2/3 for each hotspot. You can also substitute the [attachmentkeyid1] of the SDI holding the attachment (if used). If using the "SDI List" Query Type, substitution also occurs on the querywhere argument. For example, the default Count SQL might be SELECT count(*) FROM s_sample WHERE samplepointid='[keyid1]'. |
||||||||||||||||||||||||||||||
| Default Counter Query SDC | Default override for the "Hotspot Map" settings. If "Default Counter Query Type" is "SDI List", this is the SDC for the SDI that defines the counter on the hotspot. | ||||||||||||||||||||||||||||||
| Default Counter Query From | Default override for the "Hotspot Map" settings. If "Default Counter Query Type" is "SDI List", this is the From Clause to retrieve SDIs. | ||||||||||||||||||||||||||||||
| Default Counter Query Where | Default override for the "Hotspot Map" settings. If "Default Counter Query Type" is "SDI List", this is the Where Clause to retrieve SDIs. | ||||||||||||||||||||||||||||||
| Default Counter SQL | Default override for the "Hotspot Map" settings. If "Default Counter Query Type" is "SQL", this is the query that defines the counter on the hotspot. | ||||||||||||||||||||||||||||||
| Hotspot Count Color | Color of the Hotspot Counter. This is typically a text string, but can be defined conditionally using a Groovy expression. Example: gizmo.count > 10 ? "Red" : "Green". | ||||||||||||||||||||||||||||||
| Show Zero Count | Determines what to do when the count goes to zero ("Show", "Hide", or "Show Image"). | ||||||||||||||||||||||||||||||
| Zero Image | If "Show Zero Count" is "Show Image", this is the image to display when the count goes to zero. | ||||||||||||||||||||||||||||||
| Default Label CSS | Default CSS style properties for the "Label". | ||||||||||||||||||||||||||||||
| Default URL | Generic URL to use (substitute [keyid1] if required). | ||||||||||||||||||||||||||||||
| Default Target | Generic target. Leave this blank to navigate inline. | ||||||||||||||||||||||||||||||
| Hotspot Coloring | Color of the Hotspt opacity highlight. This is useful when the background color of the image is white. | ||||||||||||||||||||||||||||||
| Show Mouse Over Hotspot | Determines if the Hotspot is highlighted onMouseOver. Highlighting the hotspot area may not be needed if using a touch device (which has no mouseover event). In addition to the mouseover, you can choose to show an icon which, when clicked, will toggle a display of all hotspots and their labels. | ||||||||||||||||||||||||||||||
| Hotspot Indicator | Defines characteristics of the HotSpot Indicator:
|
||||||||||||||||||||||||||||||
| Parameter | When used on a Dashboard, the imagemapgizmo can be used as a parametergizmo
to drive the display of other Gizmos such as the listgizmo. To use this
functionality, you must provide a "Source KeyId 1/2/3" for each
hotspot, provide a "KeyIid 1/2/3 Parameter" property that defines
the name of the parameter for each key. Provide a list of the parameterized
Gizmos to be refreshed whenever a hotspot is clicked. Then, parameterize
the SQL of other Gizmos on the Dashboard (such as samplepointid='[samplepointid]').
|
||||||||||||||||||||||||||||||
| Sidebar Count | Defines characteristics of the Counter in the Sidebar. Each hotspot can
have a Counter to display a numeric value in the center of the hotspot.
Use these properties to define characteristics os the Counter. You can specify
either of the following:
|
Specialized Token Support |
|
|
KeyId Substitution |
Token substitution of KeyId is supported by the properties "Hotspot Map → URL", "Hotspot Map → Counter SQL", "Hotspot Map → Counter Query Where", "Hotspot Map → Label", "Sidebar Count → SQL", and "Sidebar Count → Query Where":
| • | [keyid1] or [linkkeyid1] can be substituted for the value of Hotspot Map → Link KeyId 1 (or Link KeyId 2 or Link KeyId 3). |
| • | [attachmentkeyid1] or [sourcekeyid1] can be substituted for the value of Source KeyId 1 (or Source KeyId 2 or Source KeyId 3). |
Any remaining token values will be substituted with values passed into the Gizmo through the request. For example, a [location] token could be substituted using rc?command=gizmo&gizmo=MyImage&location=Here.
KeyId Column Substitution |
In addition to substituting the KeyId of either the Source SDI or Link SDI value (such as using [linkkeyid1] or [sourcekeyid1] as shown above), a column from that SDI can also be substituted using this syntax:
[linkkeyid1.columnid] or [sourcekeyid1.columnid]
Note that [keyid1] and [attachmentkeyid1] are also supported. For example, consider a floor plan image with a hotspot that is linked to a Location with KeyId "Room 101". When clicking the hotspot, your intent is to navigate the User another imagemap defined in a column on Location "Room 101". To achieve this, we can configure the properties as shown below:
|