| 1 |
<?xml version="1.0" encoding="UTF-8"?> |
|---|
| 2 |
<ca:widgetdoc xmlns:ca="http://localhost/chameleon/utils/xml/schemas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://localhost/chameleon/utils/xml/schemas ..\..\..\utils\xml\schemas\chameleon.xsd"> |
|---|
| 3 |
<ca:docinfo> |
|---|
| 4 |
<ca:language> |
|---|
| 5 |
<ca:value>en-ca</ca:value> |
|---|
| 6 |
</ca:language> |
|---|
| 7 |
<ca:docbuilddate> |
|---|
| 8 |
<ca:value>1999-12-31</ca:value> |
|---|
| 9 |
</ca:docbuilddate> |
|---|
| 10 |
<ca:docversion> |
|---|
| 11 |
<ca:value>$id:$</ca:value> |
|---|
| 12 |
</ca:docversion> |
|---|
| 13 |
<ca:authors> |
|---|
| 14 |
<ca:person> |
|---|
| 15 |
<ca:name>Doc_Builder</ca:name> |
|---|
| 16 |
<ca:company>DM Solutions Group Inc.</ca:company> |
|---|
| 17 |
<ca:contact>chameleon@lists.maptools.org</ca:contact> |
|---|
| 18 |
</ca:person> |
|---|
| 19 |
</ca:authors> |
|---|
| 20 |
<ca:editors> |
|---|
| 21 |
<ca:person> |
|---|
| 22 |
<ca:name>Christopher R. Thorne</ca:name> |
|---|
| 23 |
<ca:company>DM Solutions Group Inc.</ca:company> |
|---|
| 24 |
<ca:contact>chameleon@lists.maptools.org</ca:contact> |
|---|
| 25 |
</ca:person> |
|---|
| 26 |
</ca:editors> |
|---|
| 27 |
</ca:docinfo> |
|---|
| 28 |
<ca:identification> |
|---|
| 29 |
<ca:name> |
|---|
| 30 |
<ca:value>Query</ca:value> |
|---|
| 31 |
</ca:name> |
|---|
| 32 |
<ca:chameleonpack> |
|---|
| 33 |
<ca:value>TBD</ca:value> |
|---|
| 34 |
</ca:chameleonpack> |
|---|
| 35 |
<ca:parentgroup> |
|---|
| 36 |
<ca:value>Navigation Widget</ca:value> |
|---|
| 37 |
</ca:parentgroup> |
|---|
| 38 |
<ca:version> |
|---|
| 39 |
<ca:value>2.0</ca:value> |
|---|
| 40 |
</ca:version> |
|---|
| 41 |
<ca:releasedate> |
|---|
| 42 |
<ca:value>2005-01-10</ca:value> |
|---|
| 43 |
</ca:releasedate> |
|---|
| 44 |
<ca:maturitylevel> |
|---|
| 45 |
<ca:value>TECHRELEASE</ca:value> |
|---|
| 46 |
</ca:maturitylevel> |
|---|
| 47 |
<ca:developers> |
|---|
| 48 |
<ca:person> |
|---|
| 49 |
<ca:name>Paul Spencer</ca:name> |
|---|
| 50 |
<ca:company>DM Solutions Group Inc.</ca:company> |
|---|
| 51 |
<ca:contact>chameleon@lists.maptools.org</ca:contact> |
|---|
| 52 |
</ca:person> |
|---|
| 53 |
</ca:developers> |
|---|
| 54 |
</ca:identification> |
|---|
| 55 |
<ca:descriptions> |
|---|
| 56 |
<ca:description> |
|---|
| 57 |
<ca:paras> |
|---|
| 58 |
<ca:para>The Query widget is used to query the map for information at a single point. If a visible feature (point, line, polygon, or raster) found in the map has accessible tabular information, the Query widget returns the query results in a popup window. This widget normally queries all visible layers that are specified as queryable in the map file or Context file. There are several things that must be done to make a map file layer queryable, as discussed in the MapServer documentation at http://mapserver.gis.umn.edu.</ca:para> |
|---|
| 59 |
</ca:paras> |
|---|
| 60 |
</ca:description> |
|---|
| 61 |
<ca:techrequirements title="Technical Requirements"> |
|---|
| 62 |
<ca:paras title="Queryable Map Features"> |
|---|
| 63 |
<ca:para>The availability of tabular data to display to a user depends on how the MapServer map file (*.map) or OGC Context file (*.cml) are configured. In many cases, a Web-mapping application provides some specific queryable layers as well as some non-queryable layers (for base data). Both MapServer map files and OGC Context files have their own procedures for making a map data layer queryable. Refer to the MapServer documentation at http://mapserver.gis.umn.edu.</ca:para> |
|---|
| 64 |
</ca:paras> |
|---|
| 65 |
</ca:techrequirements> |
|---|
| 66 |
<ca:dependancies> |
|---|
| 67 |
<ca:dependancy type="Widget" title="Map Widget"> |
|---|
| 68 |
<ca:para>A map widget must be present in the interface for this widget to find possible queryable map features.</ca:para> |
|---|
| 69 |
</ca:dependancy> |
|---|
| 70 |
<ca:dependancy type="Data" title="Queryable Map Features"> |
|---|
| 71 |
<ca:para>A map layer must be configured to be queryable. In the case of Context files, it is up to the WMS server to determine whether the client query request is allowed, regardless of what is specified in the Context file. The queryability of a WMS layer can be checked by getting the WMS server's Capabilities document.</ca:para> |
|---|
| 72 |
</ca:dependancy> |
|---|
| 73 |
</ca:dependancies> |
|---|
| 74 |
<ca:sharedresources> |
|---|
| 75 |
<ca:paras title="PopupCss and Style Resource"> |
|---|
| 76 |
<ca:para>The Query widget tag has attributes from the Button Attributes and Popup Attributes Groups. This means the Query widget has access to the Style and PopUpCSS Shared Resources. To learn about them, please refer to the appropriate attribute group sections for details.</ca:para> |
|---|
| 77 |
</ca:paras> |
|---|
| 78 |
</ca:sharedresources> |
|---|
| 79 |
<ca:embeddedhelp> |
|---|
| 80 |
<ca:paras> |
|---|
| 81 |
<ca:para>The Query widget provides the capability to perform spatial queries on the map. A query retrieves metadata about a visible layer at a particular geographic location. To perform a query, select the Query tool and click on the map. A Query Results window will popup and display the results of querying each visible, queryable layer at the clicked location. Not all layers may be configured to be queryable - this is determined by the application. |
|---|
| 82 |
</ca:para> |
|---|
| 83 |
</ca:paras> |
|---|
| 84 |
</ca:embeddedhelp> |
|---|
| 85 |
<ca:guinotes> |
|---|
| 86 |
<ca:guinote type="Button" title="Functionality Activation"> |
|---|
| 87 |
<ca:para>You must select the Query button to activate this tool before proceeding to the map. If the button is a part of a button toolset, then the functionality of this button remains active until another button is selected in the same toolset.</ca:para> |
|---|
| 88 |
</ca:guinote> |
|---|
| 89 |
<ca:guinote type="Map" title="Data Navigation Tool"> |
|---|
| 90 |
<ca:para>The user can click the mouse cursor on a queryable map feature and view the result of the request in a separate popup window. If no map features are found within the query tolerance area then the query popup display a "no data found" message.</ca:para> |
|---|
| 91 |
</ca:guinote> |
|---|
| 92 |
</ca:guinotes> |
|---|
| 93 |
</ca:descriptions> |
|---|
| 94 |
<ca:tagstructures> |
|---|
| 95 |
<ca:tagstructure title="Widget Syntax"> |
|---|
| 96 |
<ca:description/> |
|---|
| 97 |
<ca:code> |
|---|
| 98 |
<ca:codeblock bold="true"> |
|---|
| 99 |
<ca:line><CWC2 TYPE="Query"</ca:line> |
|---|
| 100 |
</ca:codeblock> |
|---|
| 101 |
<ca:codeblock bold="false"> |
|---|
| 102 |
<ca:line> ENABLED="[TRUE|FALSE]"</ca:line> |
|---|
| 103 |
<ca:line> FORMINDEX="[0 < integer]"</ca:line> |
|---|
| 104 |
<ca:line> VISIBLE="[TRUE|FALSE]"</ca:line> |
|---|
| 105 |
<ca:line/> |
|---|
| 106 |
<ca:line> <!-- Query Attributes--></ca:line> |
|---|
| 107 |
<ca:line/> |
|---|
| 108 |
<ca:line> ALLOWRECTANGLE = "[TRUE|FALSE]"</ca:line> |
|---|
| 109 |
<ca:line> HIGHLIGHTRESULTS = "[TRUE|FALSE]"</ca:line> |
|---|
| 110 |
<ca:line> INCLUDEEMPTYRESULTS = "[TRUE|FALSE]"</ca:line> |
|---|
| 111 |
<ca:line> MAXFEATURES = "[1 < integer]"</ca:line> |
|---|
| 112 |
<ca:line> PERSISTENTRESULTS = "[TRUE|FALSE]"</ca:line> |
|---|
| 113 |
<ca:line> POPUPRESULTS = "[TRUE|FALSE]"</ca:line> |
|---|
| 114 |
<ca:line> RADIUS = "[1 < integer]"</ca:line> |
|---|
| 115 |
<ca:line> SUBMITPAGE = "[TRUE|FALSE]"</ca:line> |
|---|
| 116 |
<ca:line/> |
|---|
| 117 |
<ca:line> <!-- Navigation Attributes --></ca:line> |
|---|
| 118 |
<ca:line/> |
|---|
| 119 |
<ca:line> CURSORTYPE="[string]"</ca:line> |
|---|
| 120 |
<ca:line> DEFAULT="[TRUE|FALSE]"</ca:line> |
|---|
| 121 |
<ca:line> MAPID="[string]"</ca:line> |
|---|
| 122 |
<ca:line> WIDGETSTYLE="[string]"</ca:line> |
|---|
| 123 |
<ca:line/> |
|---|
| 124 |
<ca:line> <!-- Popup Attribute Group --></ca:line> |
|---|
| 125 |
<ca:line/> |
|---|
| 126 |
</ca:codeblock> |
|---|
| 127 |
<ca:codeblock bold="true"> |
|---|
| 128 |
<ca:line> POPUPHEIGHT="[0 < integer]" </ca:line> |
|---|
| 129 |
<ca:line> POPUPWIDTH="[0 < integer]"</ca:line> |
|---|
| 130 |
</ca:codeblock> |
|---|
| 131 |
<ca:codeblock bold="false"> |
|---|
| 132 |
<ca:line> MENUBAR="[TRUE|FALSE]"</ca:line> |
|---|
| 133 |
<ca:line> POPUPSTYLERESOURCE="[string]"</ca:line> |
|---|
| 134 |
<ca:line> RESIZABLE="[TRUE|FALSE]"</ca:line> |
|---|
| 135 |
<ca:line> SCROLLBARS="[TRUE|FALSE]"</ca:line> |
|---|
| 136 |
<ca:line> STATUS="[TRUE|FALSE]"</ca:line> |
|---|
| 137 |
<ca:line> TOOLBAR="[TRUE|FALSE]"</ca:line> |
|---|
| 138 |
<ca:line/> |
|---|
| 139 |
<ca:line> <!-- Button Attribute Group--></ca:line> |
|---|
| 140 |
<ca:line/> |
|---|
| 141 |
<ca:line> BACKGROUNDIMAGE="[path]"</ca:line> |
|---|
| 142 |
<ca:line> DEFAULT="[TRUE|FALSE]"</ca:line> |
|---|
| 143 |
<ca:line> IMAGE="[path]"</ca:line> |
|---|
| 144 |
<ca:line> IMAGEHEIGHT="[integer]"</ca:line> |
|---|
| 145 |
<ca:line> IMAGETIP="[string]"</ca:line> |
|---|
| 146 |
<ca:line> IMAGEWIDTH="[integer]"</ca:line> |
|---|
| 147 |
<ca:line> LABELALIGN="[LEFT|CENTER|RIGHT]"</ca:line> |
|---|
| 148 |
<ca:line> LABELANTIALIAS="[TRUE|FALSE]"</ca:line> |
|---|
| 149 |
<ca:line> LABELCOLOR="[#RRGGBB]"</ca:line> |
|---|
| 150 |
<ca:line> LABELFONT="[string]"</ca:line> |
|---|
| 151 |
<ca:line> LABELFONTSIZE="[0 < integer]"</ca:line> |
|---|
| 152 |
<ca:line> ONCLICK="[string]"</ca:line> |
|---|
| 153 |
<ca:line> STYLERESOURCE="[string]"</ca:line> |
|---|
| 154 |
<ca:line> TEXTBUTTONBORDER="[path]"</ca:line> |
|---|
| 155 |
<ca:line> TEXTBUTTONBORDER_BOTTOM_IMAGE="[path]"</ca:line> |
|---|
| 156 |
<ca:line> TEXTBUTTONBORDER_BOTTOMLEFT_IMAGE="[path]"</ca:line> |
|---|
| 157 |
<ca:line> TEXTBUTTONBORDER_BOTTOMRIGHT_IMAGE="[path]"</ca:line> |
|---|
| 158 |
<ca:line> TEXTBUTTONBORDER_LEFT_IMAGE="[path]"</ca:line> |
|---|
| 159 |
<ca:line> TEXTBUTTONBORDER_RIGHT_IMAGE="[path]"</ca:line> |
|---|
| 160 |
<ca:line> TEXTBUTTONBORDER_TOP_IMAGE="[path]"</ca:line> |
|---|
| 161 |
<ca:line> TEXTBUTTONBORDER_TOPLEFT_IMAGE="[path]"</ca:line> |
|---|
| 162 |
<ca:line> TEXTBUTTONBORDER_TOPRIGHT_IMAGE="[path]"</ca:line> |
|---|
| 163 |
<ca:line> TEXTBUTTONCOLOR="[#RRGGBB]"</ca:line> |
|---|
| 164 |
<ca:line> TEXTBUTTONNUDGE="[integer]"</ca:line> |
|---|
| 165 |
<ca:line> TEXTBUTTONPADDING="[0 < integer]"</ca:line> |
|---|
| 166 |
<ca:line> TOOLSET="[string]"</ca:line> |
|---|
| 167 |
<ca:line> USETEXTBUTTONCACHE="[TRUE|FALSE]"></ca:line> |
|---|
| 168 |
<ca:line/> |
|---|
| 169 |
<ca:line> <!-- Button Subtag Group --></ca:line> |
|---|
| 170 |
<ca:line/> |
|---|
| 171 |
<ca:line> <IMAGE STATE="[NORMAL|SELECTED|HOVER|DISABLED]"</ca:line> |
|---|
| 172 |
<ca:line> IMAGE="[path]"/></ca:line> |
|---|
| 173 |
</ca:codeblock> |
|---|
| 174 |
<ca:codeblock bold="true"> |
|---|
| 175 |
<ca:line></CWC2></ca:line> |
|---|
| 176 |
</ca:codeblock> |
|---|
| 177 |
</ca:code> |
|---|
| 178 |
</ca:tagstructure> |
|---|
| 179 |
</ca:tagstructures> |
|---|
| 180 |
<ca:examples> |
|---|
| 181 |
<ca:widgetexamples> |
|---|
| 182 |
<ca:example title="Example #1: Simple"> |
|---|
| 183 |
<ca:description>The query radius in the following example is set to 3 pixels and the number of features to be displayed in the popup table results is set to 5.</ca:description> |
|---|
| 184 |
<ca:code> |
|---|
| 185 |
<ca:codeblock bold="false"> |
|---|
| 186 |
<ca:line><cwc2 type="Query"</ca:line> |
|---|
| 187 |
<ca:line> visible="true"</ca:line> |
|---|
| 188 |
<ca:line> image="buttons/button_query_1.png"</ca:line> |
|---|
| 189 |
<ca:line> radius="3"</ca:line> |
|---|
| 190 |
<ca:line> maxfeatures="5"/></ca:line> |
|---|
| 191 |
</ca:codeblock> |
|---|
| 192 |
</ca:code> |
|---|
| 193 |
</ca:example> |
|---|
| 194 |
<ca:example title="Example #2: Advanced"> |
|---|
| 195 |
<ca:description>The following example shows how the Query widget uses a "TextButtons" Shared Resource called "NavigationButtons" with three possible image states.</ca:description> |
|---|
| 196 |
<ca:code> |
|---|
| 197 |
<ca:codeblock bold="false"> |
|---|
| 198 |
<ca:line><cwc2 type="Query"</ca:line> |
|---|
| 199 |
<ca:line> visible="true"</ca:line> |
|---|
| 200 |
<ca:line> imagetip="Identify Feature"</ca:line> |
|---|
| 201 |
<ca:line> image="icons/query_icon.png"</ca:line> |
|---|
| 202 |
<ca:line> styleresource="NavigationButtons"</ca:line> |
|---|
| 203 |
<ca:line> popupwidth="500"</ca:line> |
|---|
| 204 |
<ca:line> popupheight="600"</ca:line> |
|---|
| 205 |
<ca:line> radius="3"</ca:line> |
|---|
| 206 |
<ca:line> maxfeatures="5"></ca:line> |
|---|
| 207 |
<ca:line> <image state="normal" /></ca:line> |
|---|
| 208 |
<ca:line> <image state="hover" /></ca:line> |
|---|
| 209 |
<ca:line> <image state="selected" /></ca:line> |
|---|
| 210 |
<ca:line></cwc2></ca:line> |
|---|
| 211 |
</ca:codeblock> |
|---|
| 212 |
</ca:code> |
|---|
| 213 |
</ca:example> |
|---|
| 214 |
<ca:example title="Example #3: Advanced"> |
|---|
| 215 |
<ca:description>The following Query example shows how the widget could be defined without using a Shared Resource. Note that this tool is linked to a group of button-based navigation widgets using the toolset attribute. This means that if Query is selected, it remains active until another tool within that tool group is selected.</ca:description> |
|---|
| 216 |
<ca:code> |
|---|
| 217 |
<ca:codeblock bold="false"> |
|---|
| 218 |
<ca:line><cwc2 type="Query"</ca:line> |
|---|
| 219 |
<ca:line> visible="true"</ca:line> |
|---|
| 220 |
<ca:line> imagetip="Identify Feature"</ca:line> |
|---|
| 221 |
<ca:line> toolset="Navigation"</ca:line> |
|---|
| 222 |
<ca:line> imagewidth="24"</ca:line> |
|---|
| 223 |
<ca:line> imageheight="24"</ca:line> |
|---|
| 224 |
<ca:line> popupwidth="500"</ca:line> |
|---|
| 225 |
<ca:line> popupheight="600"</ca:line> |
|---|
| 226 |
<ca:line> toolbar="false"</ca:line> |
|---|
| 227 |
<ca:line> status="false"</ca:line> |
|---|
| 228 |
<ca:line> menubar="false"</ca:line> |
|---|
| 229 |
<ca:line> radius="3"</ca:line> |
|---|
| 230 |
<ca:line> maxfeatures="5"></ca:line> |
|---|
| 231 |
<ca:line> <image state="normal"</ca:line> |
|---|
| 232 |
<ca:line> image="buttons/button_query_1.png"/></ca:line> |
|---|
| 233 |
<ca:line> <image state="hover"</ca:line> |
|---|
| 234 |
<ca:line> image="buttons/button_query_2.png"/></ca:line> |
|---|
| 235 |
<ca:line> <image state="selected"</ca:line> |
|---|
| 236 |
<ca:line> image="buttons/button_query_3.png"/></ca:line> |
|---|
| 237 |
<ca:line></cwc2></ca:line> |
|---|
| 238 |
</ca:codeblock> |
|---|
| 239 |
</ca:code> |
|---|
| 240 |
</ca:example> |
|---|
| 241 |
</ca:widgetexamples> |
|---|
| 242 |
<ca:sampleapps> |
|---|
| 243 |
<ca:sampleapp> |
|---|
| 244 |
<ca:name>Hawaii Demo</ca:name> |
|---|
| 245 |
<ca:appurl>www.mapsherpa.com/hawaii2/</ca:appurl> |
|---|
| 246 |
<ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description> |
|---|
| 247 |
</ca:sampleapp> |
|---|
| 248 |
</ca:sampleapps> |
|---|
| 249 |
<ca:scriptexamples/> |
|---|
| 250 |
</ca:examples> |
|---|
| 251 |
<ca:attributegroups> |
|---|
| 252 |
<ca:attributegroup> |
|---|
| 253 |
<ca:name>Base</ca:name> |
|---|
| 254 |
<ca:name>Button</ca:name> |
|---|
| 255 |
<ca:name>NavTool</ca:name> |
|---|
| 256 |
<ca:name>Popup</ca:name> |
|---|
| 257 |
</ca:attributegroup> |
|---|
| 258 |
</ca:attributegroups> |
|---|
| 259 |
<ca:widgettag> |
|---|
| 260 |
<ca:attribute> |
|---|
| 261 |
<ca:name>ALLOWRECTANGLE</ca:name> |
|---|
| 262 |
<ca:type> |
|---|
| 263 |
<ca:value>boolean</ca:value> |
|---|
| 264 |
</ca:type> |
|---|
| 265 |
<ca:class> |
|---|
| 266 |
<ca:value>Widget Only</ca:value> |
|---|
| 267 |
</ca:class> |
|---|
| 268 |
<ca:default> |
|---|
| 269 |
<ca:value>false</ca:value> |
|---|
| 270 |
<ca:description/> |
|---|
| 271 |
</ca:default> |
|---|
| 272 |
<ca:possvalues type="list"> |
|---|
| 273 |
<ca:value>true</ca:value> |
|---|
| 274 |
<ca:value>false</ca:value> |
|---|
| 275 |
</ca:possvalues> |
|---|
| 276 |
<ca:description>Determine whether the query widget should support rectangular queries or point queries. WMS layers only accept point queries. Rectangular queries are not yet implemented, so this attribute is ignored.</ca:description> |
|---|
| 277 |
</ca:attribute> |
|---|
| 278 |
<ca:attribute> |
|---|
| 279 |
<ca:name>HIGHLIGHTRESULTS</ca:name> |
|---|
| 280 |
<ca:type> |
|---|
| 281 |
<ca:value>boolean</ca:value> |
|---|
| 282 |
</ca:type> |
|---|
| 283 |
<ca:class> |
|---|
| 284 |
<ca:value>Widget Only</ca:value> |
|---|
| 285 |
</ca:class> |
|---|
| 286 |
<ca:default> |
|---|
| 287 |
<ca:value>false</ca:value> |
|---|
| 288 |
<ca:description/> |
|---|
| 289 |
</ca:default> |
|---|
| 290 |
<ca:possvalues type="list"> |
|---|
| 291 |
<ca:value>true</ca:value> |
|---|
| 292 |
<ca:value>false</ca:value> |
|---|
| 293 |
</ca:possvalues> |
|---|
| 294 |
<ca:description>Determine whether features identified in the query should be visually highlighted on the map or not. Feature highlighting may be temporary unless PERSISTENTRESULTS is set to "true". The visual style of the feature highlight is controlled by the QUERYMAP element of the map file. See http://mapserver.gis.umn.edu for details.</ca:description> |
|---|
| 295 |
</ca:attribute> |
|---|
| 296 |
<ca:attribute> |
|---|
| 297 |
<ca:name>INCLUDEEMPTYRESULTS</ca:name> |
|---|
| 298 |
<ca:type> |
|---|
| 299 |
<ca:value>boolean</ca:value> |
|---|
| 300 |
</ca:type> |
|---|
| 301 |
<ca:class> |
|---|
| 302 |
<ca:value>Widget Only</ca:value> |
|---|
| 303 |
</ca:class> |
|---|
| 304 |
<ca:default> |
|---|
| 305 |
<ca:value>false</ca:value> |
|---|
| 306 |
<ca:description/> |
|---|
| 307 |
</ca:default> |
|---|
| 308 |
<ca:possvalues type="list"> |
|---|
| 309 |
<ca:value>true</ca:value> |
|---|
| 310 |
<ca:value>false</ca:value> |
|---|
| 311 |
</ca:possvalues> |
|---|
| 312 |
<ca:description>If set to "true", output a message when no search results are found for every layer that is queryable. In set to "false", then layers that are queryable but which have no results do not display any text.</ca:description> |
|---|
| 313 |
</ca:attribute> |
|---|
| 314 |
<ca:attribute> |
|---|
| 315 |
<ca:name>MAXFEATURES</ca:name> |
|---|
| 316 |
<ca:type> |
|---|
| 317 |
<ca:value>integer</ca:value> |
|---|
| 318 |
</ca:type> |
|---|
| 319 |
<ca:class> |
|---|
| 320 |
<ca:value>Widget Only</ca:value> |
|---|
| 321 |
</ca:class> |
|---|
| 322 |
<ca:default> |
|---|
| 323 |
<ca:value>5</ca:value> |
|---|
| 324 |
<ca:description>records</ca:description> |
|---|
| 325 |
</ca:default> |
|---|
| 326 |
<ca:possvalues type="range"> |
|---|
| 327 |
<ca:minimum>1</ca:minimum> |
|---|
| 328 |
<ca:maximum>2147483647</ca:maximum> |
|---|
| 329 |
</ca:possvalues> |
|---|
| 330 |
<ca:description>The number of features to limit a GetFeatureInfo response to. This is the limit for each layer; it is not cumulative. This is a CubeWerx-specific extension to the WMS GetFeatureInfo request and may not be supported by all servers, although most should at least ignore it.</ca:description> |
|---|
| 331 |
</ca:attribute> |
|---|
| 332 |
<ca:attribute> |
|---|
| 333 |
<ca:name>PERSISTENTRESULTS</ca:name> |
|---|
| 334 |
<ca:type> |
|---|
| 335 |
<ca:value>boolean</ca:value> |
|---|
| 336 |
</ca:type> |
|---|
| 337 |
<ca:class> |
|---|
| 338 |
<ca:value>Widget Only</ca:value> |
|---|
| 339 |
</ca:class> |
|---|
| 340 |
<ca:default> |
|---|
| 341 |
<ca:value>false</ca:value> |
|---|
| 342 |
<ca:description/> |
|---|
| 343 |
</ca:default> |
|---|
| 344 |
<ca:possvalues type="list"> |
|---|
| 345 |
<ca:value>true</ca:value> |
|---|
| 346 |
<ca:value>false</ca:value> |
|---|
| 347 |
</ca:possvalues> |
|---|
| 348 |
<ca:description>This controls the persistence of query results. Normally a query disappears on the next navigation by the user. With persistence turned on, highlighted results will be preserved until the user uses the ClearQueryResults widget or performs another query. Although</ca:description> |
|---|
| 349 |
</ca:attribute> |
|---|
| 350 |
<ca:attribute> |
|---|
| 351 |
<ca:name>POPUPRESULTS</ca:name> |
|---|
| 352 |
<ca:type> |
|---|
| 353 |
<ca:value>boolean</ca:value> |
|---|
| 354 |
</ca:type> |
|---|
| 355 |
<ca:class> |
|---|
| 356 |
<ca:value>Widget Only</ca:value> |
|---|
| 357 |
</ca:class> |
|---|
| 358 |
<ca:default> |
|---|
| 359 |
<ca:value>false</ca:value> |
|---|
| 360 |
<ca:description/> |
|---|
| 361 |
</ca:default> |
|---|
| 362 |
<ca:possvalues type="list"> |
|---|
| 363 |
<ca:value>true</ca:value> |
|---|
| 364 |
<ca:value>false</ca:value> |
|---|
| 365 |
</ca:possvalues> |
|---|
| 366 |
<ca:description>Control the display of query results. Setting this to "false" causes the query results popup to be suppressed. This allows the building of custom query results functionality.</ca:description> |
|---|
| 367 |
</ca:attribute> |
|---|
| 368 |
<ca:attribute> |
|---|
| 369 |
<ca:name>RADIUS</ca:name> |
|---|
| 370 |
<ca:type> |
|---|
| 371 |
<ca:value>integer</ca:value> |
|---|
| 372 |
</ca:type> |
|---|
| 373 |
<ca:class> |
|---|
| 374 |
<ca:value>Widget Only</ca:value> |
|---|
| 375 |
</ca:class> |
|---|
| 376 |
<ca:default> |
|---|
| 377 |
<ca:value>3</ca:value> |
|---|
| 378 |
<ca:description>pixel width</ca:description> |
|---|
| 379 |
</ca:default> |
|---|
| 380 |
<ca:possvalues type="range"> |
|---|
| 381 |
<ca:minimum>1</ca:minimum> |
|---|
| 382 |
<ca:maximum>2147483647</ca:maximum> |
|---|
| 383 |
</ca:possvalues> |
|---|
| 384 |
<ca:description>The number of pixels to search for features around the clicked location. This is a CubeWerx-specific extension to the current WMS GetFeatureInfo request and may not be supported by all servers, although most should at least ignore it.</ca:description> |
|---|
| 385 |
</ca:attribute> |
|---|
| 386 |
<ca:attribute> |
|---|
| 387 |
<ca:name>SUBMITPAGE</ca:name> |
|---|
| 388 |
<ca:type> |
|---|
| 389 |
<ca:value>boolean</ca:value> |
|---|
| 390 |
</ca:type> |
|---|
| 391 |
<ca:class> |
|---|
| 392 |
<ca:value>Widget Only</ca:value> |
|---|
| 393 |
</ca:class> |
|---|
| 394 |
<ca:default> |
|---|
| 395 |
<ca:value>false</ca:value> |
|---|
| 396 |
<ca:description/> |
|---|
| 397 |
</ca:default> |
|---|
| 398 |
<ca:possvalues type="list"> |
|---|
| 399 |
<ca:value>true</ca:value> |
|---|
| 400 |
<ca:value>false</ca:value> |
|---|
| 401 |
</ca:possvalues> |
|---|
| 402 |
<ca:description>Determines whether the page is submitted when the user clicks on the map. Normally, the query widget does not submit the page. However, for custom query results, it may be desirable to change this behavior.</ca:description> |
|---|
| 403 |
</ca:attribute> |
|---|
| 404 |
</ca:widgettag> |
|---|
| 405 |
<ca:formelements> |
|---|
| 406 |
<ca:formelement> |
|---|
| 407 |
<ca:name>NAV_CMD</ca:name> |
|---|
| 408 |
<ca:type> |
|---|
| 409 |
<ca:value>string</ca:value> |
|---|
| 410 |
</ca:type> |
|---|
| 411 |
<ca:description>The last command that was used to interact with the map. For the Query widget, this is set to QUERY.</ca:description> |
|---|
| 412 |
</ca:formelement> |
|---|
| 413 |
<ca:formelement> |
|---|
| 414 |
<ca:name>NAV_ALLOW_RECTANGLE</ca:name> |
|---|
| 415 |
<ca:type> |
|---|
| 416 |
<ca:value>boolean</ca:value> |
|---|
| 417 |
</ca:type> |
|---|
| 418 |
<ca:description>Track whether the current navigation tool uses a rubber-banding box or not. For the Query widget, this will be false.</ca:description> |
|---|
| 419 |
</ca:formelement> |
|---|
| 420 |
</ca:formelements> |
|---|
| 421 |
<ca:jsfunctions> |
|---|
| 422 |
<ca:jsfunction> |
|---|
| 423 |
<ca:name>NavSetActiveTool</ca:name> |
|---|
| 424 |
<ca:scope> |
|---|
| 425 |
<ca:value>Private</ca:value> |
|---|
| 426 |
</ca:scope> |
|---|
| 427 |
<ca:description>Set the active navigation tool for a particular group of tools.</ca:description> |
|---|
| 428 |
<ca:parameters> |
|---|
| 429 |
<ca:parameter> |
|---|
| 430 |
<ca:name>oButton</ca:name> |
|---|
| 431 |
<ca:type> |
|---|
| 432 |
<ca:value>object</ca:value> |
|---|
| 433 |
</ca:type> |
|---|
| 434 |
<ca:required> |
|---|
| 435 |
<ca:value>true</ca:value> |
|---|
| 436 |
</ca:required> |
|---|
| 437 |
<ca:description>This is the JavaScript button object.</ca:description> |
|---|
| 438 |
</ca:parameter> |
|---|
| 439 |
<ca:parameter> |
|---|
| 440 |
<ca:name>aVals</ca:name> |
|---|
| 441 |
<ca:type> |
|---|
| 442 |
<ca:value>array</ca:value> |
|---|
| 443 |
</ca:type> |
|---|
| 444 |
<ca:required> |
|---|
| 445 |
<ca:value>true</ca:value> |
|---|
| 446 |
</ca:required> |
|---|
| 447 |
<ca:description>Array of parameters that defines the navigation tool. The first element is the tool number. The second element is the tool name. The third element is boolean and determines if rectangle mode is enabled or not. The fourth element controls automatic submission of the page after navigation. The fifth element is a string that define the cursor type.</ca:description> |
|---|
| 448 |
</ca:parameter> |
|---|
| 449 |
</ca:parameters> |
|---|
| 450 |
</ca:jsfunction> |
|---|
| 451 |
<ca:jsfunction> |
|---|
| 452 |
<ca:name>QueryWMouseClick</ca:name> |
|---|
| 453 |
<ca:scope> |
|---|
| 454 |
<ca:value>Private</ca:value> |
|---|
| 455 |
</ca:scope> |
|---|
| 456 |
<ca:description>Handle the user clicking the mouse on the map.</ca:description> |
|---|
| 457 |
<ca:parameters> |
|---|
| 458 |
<ca:parameter> |
|---|
| 459 |
<ca:name>e</ca:name> |
|---|
| 460 |
<ca:type> |
|---|
| 461 |
<ca:value>object</ca:value> |
|---|
| 462 |
</ca:type> |
|---|
| 463 |
<ca:required> |
|---|
| 464 |
<ca:value>true</ca:value> |
|---|
| 465 |
</ca:required> |
|---|
| 466 |
<ca:description>A JavaScript event object</ca:description> |
|---|
| 467 |
</ca:parameter> |
|---|
| 468 |
</ca:parameters> |
|---|
| 469 |
</ca:jsfunction> |
|---|
| 470 |
<ca:jsfunction> |
|---|
| 471 |
<ca:name>QueryWMouseMove</ca:name> |
|---|
| 472 |
<ca:scope> |
|---|
| 473 |
<ca:value>Private</ca:value> |
|---|
| 474 |
</ca:scope> |
|---|
| 475 |
<ca:description>Handle the user moving the mouse over the map.</ca:description> |
|---|
| 476 |
<ca:parameters> |
|---|
| 477 |
<ca:parameter> |
|---|
| 478 |
<ca:name>e</ca:name> |
|---|
| 479 |
<ca:type> |
|---|
| 480 |
<ca:value>object</ca:value> |
|---|
| 481 |
</ca:type> |
|---|
| 482 |
<ca:required> |
|---|
| 483 |
<ca:value>true</ca:value> |
|---|
| 484 |
</ca:required> |
|---|
| 485 |
<ca:description>A JavaScript event object</ca:description> |
|---|
| 486 |
</ca:parameter> |
|---|
| 487 |
</ca:parameters> |
|---|
| 488 |
</ca:jsfunction> |
|---|
| 489 |
</ca:jsfunctions> |
|---|
| 490 |
</ca:widgetdoc> |
|---|
