Image Map Reporting

The Image Map Report tab - displays the code you must copy to a report wizard (refer to the Reportal documentation) if you wish to include the Image Map question in that report wizard.

Figure 1 - Example of the Image Map Report tab

Important
The report for which you want to run the report wizard to create an Image Map report page, must include a Page Master named ‘Image Map’ and this Page Master must include a Report Page area. If the report does not include such a Page Master with a Report Page area you will get an error when running the wizard in the report.

To copy the script to a report wizard:

1. Click into the script area and select all (Ctrl+A).
2. Click the Copy to clipboard button.
3. Go to Reportal and in the Quick Access pane open the Wizard List.
4. Open an existing report wizard or create a new.
5. In the Wizard Editor overlay, go to the Script tab, click into the tab and paste the script into the tab.
6. Save the changes.

To run a wizard script in an existing report:

1. Right-click on the position in the report where you want to insert the Image Map page.
2. Select Insert From Wizard.
3. Select the wizard you want to run.
4. Click Finish.

This will start a task that runs the wizard script and adds an Image Map page to the report.

When the script is run, a page is created containing a table and a text component. The table contains the data from the questionnaire that is to be presented in the image map page. The text component contains all the code that is used to create the image map and the shapes etc. The table is hidden so will not be seen by the report viewer.

Report Configuration

The configuration properties in the Image Map Report tab allow you to specify legend, label and opacity settings. The properties are as follows:

• Legend start color – the legend that will be included on the report page showing the results for the image map question will be color-graded. Each step in the legend will be given a different color. This property sets the starting color for the legend intervals.
• Legend end color – sets the end color for the legend that will be included on the report page showing the results for image map question.
• Interval – sets the step-interval for the legend values.
• Value label - value labels can be displayed in the various areas in the image map such that report viewers can see the values accorded to those areas. The three options for this property are:
• Always value label - the value labels are always displayed.
• Value label on hover - a value label is displayed for an area in the image map when the user hovers the mouse pointer in that area. The label disappears when the pointer moves out of the area.
• No value label - value labels are not displayed in the image map.
• Opacity slider - check to display a slider bar on the report page such that the report viewer can set the opacity of the shapes in the image map.
• Initial opacity - sets the "start" opacity of the slider bar. The report viewer can then change the opacity as required.
• Include zeros - check to include all labels (as specified by the Value label property) and image map shapes irrespective of their values. If this property is not checked, image map shapes and associated labels will only be displayed if they have non-zero values.
• Apply & Save - any changes you make in the Image Map Report tab must be saved by clicking here. Note that clicking the Save button for the Question Details page will not save these changes.