The <select-set-option> element is used to control the selection options
displayed on the selected set summary page (imfSelectSetSummary.jsp) in the IMF viewer.
This element may be repeated multiple times to define the individual options that
appear on the page.
The options shown on the Selected Set Summary page are a combination of the values
read from the default site configuration file and the application's site configuration
file. If an option is found in both files, the one in the application's site configuration file
replaces the value defined in the default file. To turn off an option set in the
default site configuration file, define an option in your application's site configuration
file with the same description and the enabled attribute equal to false.
In addition, the <select-set-option> element may also appear within a layer element
in the layer configuration file to show options only on the Selected Set Summary page
for a particular layer.
| Frequency |
Parent Elements (the <select-set-option> element is valid within): |
|
PO+ |
<layer-config> |
| |
|
|
| Frequency |
Description (in this context) |
|
PO+ |
The <select-set-option> element may appear zero or more times
in the <layer> element.
|
| |
|
|
|
Attributes |
Description |
|
title |
The short title before the description for the option on the Selected Set Summary page. Required.
|
|
description |
The text description for the option to appear on the Selected Set Summary page. Required.
|
|
url |
The URL of the script to run when the option is selected. The URL can contain the
special variable $IMF or $IMF to specify that the document is relative to
the IMF installation directory. Absolute URLs or javascript references may also
be used. URLs that don't start with http: or javascript: or $IMF or $IMF
are resolved relative to the location of the XML file. Required.
|
|
target |
The name of the frame that the url should be executed in. Suggested choices are
"dataFrame", "hiddenFrame" or "_blank". Optional, defaults to "dataFrame".
|
|
spinner |
The name of the "working..." spinner to display when someone chooses this option.
Valid values are "", "loadMap", "loadData" or "prepareMap". Optional, defaults to
no spinner.
|
|
enabled |
Whether the option appears on the select menu page. This is used to turn off
an option that has been defined in the default site configuration file.
Valid choices are "true" or "false". Optional, defaults to true.
|
| |
|
|
Example:
<!-- Add this option for this layer to others defined for all layers in site config. -->
<layer name="Some Layer".... >
<select-set-option title="Extract to Excel" description="Create an Excel spreadsheet containing the selected features." url="$IMF/imfExtractExcelFormResults.jsp" target="dataFrame" spinner="loadData"/>
</layer>
