| 1 |
<?xml version="1.0" encoding="ISO-8859-1"?> |
|---|
| 2 |
<ca:widgetdoc xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ca="http://localhost/chameleon/utils/xml/schemas" xsi:schemaLocation="http://localhost/chameleon/utils/xml/schemas ..\..\..\utils\xml\schemas\chameleon.xsd"> |
|---|
| 3 |
<ca:docinfo title="Document Information"> |
|---|
| 4 |
<ca:language title="Document Language Code"> |
|---|
| 5 |
<ca:value>English (en-ca)</ca:value> |
|---|
| 6 |
</ca:language> |
|---|
| 7 |
<ca:docbuilddate title="Doc_Builder Date"> |
|---|
| 8 |
<ca:value>2005-01-07</ca:value> |
|---|
| 9 |
</ca:docbuilddate> |
|---|
| 10 |
<ca:docversion title="Document Repository Version"> |
|---|
| 11 |
<ca:value>$id: $</ca:value> |
|---|
| 12 |
</ca:docversion> |
|---|
| 13 |
<ca:authors title="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:comment></ca:comment> |
|---|
| 19 |
</ca:person> |
|---|
| 20 |
</ca:authors> |
|---|
| 21 |
<ca:editors title="Editors"> |
|---|
| 22 |
<ca:person> |
|---|
| 23 |
<ca:name>Christopher R. Thorne</ca:name> |
|---|
| 24 |
<ca:company>DM Solutions Group Inc.</ca:company> |
|---|
| 25 |
<ca:contact>chameleon@lists.maptools.org</ca:contact> |
|---|
| 26 |
<ca:comment></ca:comment> |
|---|
| 27 |
</ca:person> |
|---|
| 28 |
<ca:person> |
|---|
| 29 |
<ca:name>Paul Spencer</ca:name> |
|---|
| 30 |
<ca:company>DM Solutions Group Inc.</ca:company> |
|---|
| 31 |
<ca:contact>chameleon@lists.maptools.org</ca:contact> |
|---|
| 32 |
<ca:comment></ca:comment> |
|---|
| 33 |
</ca:person> |
|---|
| 34 |
</ca:editors> |
|---|
| 35 |
</ca:docinfo> |
|---|
| 36 |
<ca:identification title="Identification"> |
|---|
| 37 |
<ca:name title="Name"> |
|---|
| 38 |
<ca:value>Extent</ca:value> |
|---|
| 39 |
</ca:name> |
|---|
| 40 |
<ca:chameleonpack title="Widget Package"> |
|---|
| 41 |
<ca:value>TBD</ca:value> |
|---|
| 42 |
</ca:chameleonpack> |
|---|
| 43 |
<ca:parentgroup title="Parent Group"> |
|---|
| 44 |
<ca:value>Label Widget</ca:value> |
|---|
| 45 |
</ca:parentgroup> |
|---|
| 46 |
<ca:version title="Version"> |
|---|
| 47 |
<ca:value>2.0</ca:value> |
|---|
| 48 |
</ca:version> |
|---|
| 49 |
<ca:releasedate title="Release Date"> |
|---|
| 50 |
<ca:value>2005-01-10</ca:value> |
|---|
| 51 |
</ca:releasedate> |
|---|
| 52 |
<ca:maturitylevel title="Maturity Level"> |
|---|
| 53 |
<ca:value>TECHRELEASE</ca:value> |
|---|
| 54 |
</ca:maturitylevel> |
|---|
| 55 |
<ca:developers title="Developers"> |
|---|
| 56 |
<ca:person> |
|---|
| 57 |
<ca:name>Paul Spencer</ca:name> |
|---|
| 58 |
<ca:company>DM Solutions Group Inc.</ca:company> |
|---|
| 59 |
<ca:contact>chameleon@lists.maptools.org</ca:contact> |
|---|
| 60 |
<ca:comment></ca:comment> |
|---|
| 61 |
</ca:person> |
|---|
| 62 |
</ca:developers> |
|---|
| 63 |
</ca:identification> |
|---|
| 64 |
<ca:descriptions title="Description"> |
|---|
| 65 |
<ca:description title="General Functionality"> |
|---|
| 66 |
<ca:paras title=""> |
|---|
| 67 |
<ca:para>The Extent widget is used to display one of the extents of the map currently displayed in the application, in the geographic coordinates of the map.</ca:para> |
|---|
| 68 |
</ca:paras> |
|---|
| 69 |
</ca:description> |
|---|
| 70 |
<ca:techrequirements title="Technical Requirements"> |
|---|
| 71 |
<ca:paras title="Valid Projection"> |
|---|
| 72 |
<ca:para>The MapServer file (*.map) and/or the OGC Context file (*.cml) must have a defined projection. To obtain a valid projection, you should use EPSG projection codes. It is important to define the projection so that the extent values of the map have valid units (e.g., decimal degrees, meters, etc.), so that map becomes geospatially significant within the application map view.</ca:para> |
|---|
| 73 |
</ca:paras> |
|---|
| 74 |
</ca:techrequirements> |
|---|
| 75 |
<ca:dependancies title="Dependencies"> |
|---|
| 76 |
<ca:dependancy type="Widget" title="Mapping Dynamically "> |
|---|
| 77 |
<ca:para>In a Chameleon mapping application, the map view is interactive by nature. The Extent widget helps dynamically update the extents of the map to reflect the current map view. The extents may also change dynamically when there is a change in projection.</ca:para> |
|---|
| 78 |
</ca:dependancy> |
|---|
| 79 |
</ca:dependancies> |
|---|
| 80 |
<ca:sharedresources title="Shared Resources"> |
|---|
| 81 |
<ca:paras title="None Available."> |
|---|
| 82 |
<ca:para></ca:para> |
|---|
| 83 |
</ca:paras> |
|---|
| 84 |
</ca:sharedresources> |
|---|
| 85 |
<ca:embeddedhelp title="General User Interface Help"> |
|---|
| 86 |
<ca:paras title=""> |
|---|
| 87 |
<ca:para>The Extent widget displays one of the coordinates (minimum X, minimum Y, maximum X, or maximum Y) of the rectangle that describes the visible area of the map. The extents are displayed in the units of the current projection.</ca:para> |
|---|
| 88 |
</ca:paras> |
|---|
| 89 |
</ca:embeddedhelp> |
|---|
| 90 |
<ca:guinotes title="Interface Functionality"> |
|---|
| 91 |
<ca:guinote type="Label" title="Positioning the Extent "> |
|---|
| 92 |
<ca:para>There are four possible extent labels for a map. These extent labels could be placed all together near the MapUnits, ProjectionLabel, and other information widgets, or in pairs at two opposite corners (i.e., Min-X, Min-Y (lower left corner) vs. Max-X, Max-Y (upper right corner)).</ca:para> |
|---|
| 93 |
</ca:guinote> |
|---|
| 94 |
</ca:guinotes> |
|---|
| 95 |
<ca:qanotes title="Quality Assurance"> |
|---|
| 96 |
<ca:paras title="None."> |
|---|
| 97 |
<ca:para></ca:para> |
|---|
| 98 |
</ca:paras> |
|---|
| 99 |
</ca:qanotes> |
|---|
| 100 |
</ca:descriptions> |
|---|
| 101 |
<ca:tagstructures title="Tag Syntax"> |
|---|
| 102 |
<ca:tagstructure title="Widget Syntax"> |
|---|
| 103 |
|
|---|
| 104 |
<ca:code> |
|---|
| 105 |
|
|---|
| 106 |
<ca:codeblock bold="true"> |
|---|
| 107 |
<ca:line><CWC2 TYPE="Extent"</ca:line> |
|---|
| 108 |
</ca:codeblock> |
|---|
| 109 |
<ca:codeblock bold="false"> |
|---|
| 110 |
<ca:line> ENABLED="[TRUE|FALSE]"</ca:line> |
|---|
| 111 |
<ca:line> FORMINDEX="[0 < integer]"</ca:line> |
|---|
| 112 |
<ca:line> VISIBLE="[TRUE|FALSE]"</ca:line> |
|---|
| 113 |
<ca:line/> |
|---|
| 114 |
<ca:line> <!-- Extent Attributes --> </ca:line> |
|---|
| 115 |
<ca:line/> |
|---|
| 116 |
</ca:codeblock> |
|---|
| 117 |
<ca:codeblock bold="true"> |
|---|
| 118 |
<ca:line> EXTENT ="[MINX|MINY|MAXX|MAXY]"</ca:line> |
|---|
| 119 |
</ca:codeblock> |
|---|
| 120 |
<ca:codeblock bold="false"> |
|---|
| 121 |
<ca:line> WIDGETCLASS ="[string]"</ca:line> |
|---|
| 122 |
<ca:line> TEXTFIELDSIZE ="[integer]" /></ca:line> |
|---|
| 123 |
</ca:codeblock> |
|---|
| 124 |
</ca:code> |
|---|
| 125 |
</ca:tagstructure> |
|---|
| 126 |
</ca:tagstructures> |
|---|
| 127 |
<ca:examples title="Examples"> |
|---|
| 128 |
<ca:widgetexamples title="Widget Examples"> |
|---|
| 129 |
<ca:example title="Example #1: Simple"> |
|---|
| 130 |
<ca:description>The basic widget definition below outputs the current minimum Y extent - the bottom most horizontal line coordinate value found in the current map view.</ca:description> |
|---|
| 131 |
<ca:code> |
|---|
| 132 |
<ca:codeblock bold="false"> |
|---|
| 133 |
<ca:line><cwc2 type="Extent" </ca:line> |
|---|
| 134 |
<ca:line> extent="miny" /></ca:line> |
|---|
| 135 |
</ca:codeblock> |
|---|
| 136 |
</ca:code> |
|---|
| 137 |
</ca:example> |
|---|
| 138 |
<ca:example title="Example #2: Advanced"> |
|---|
| 139 |
<ca:description>The example below shows how a descriptive label, along with label styling, can be added to the Min-X value. In this case, the label is "Left:", which represents the far left vertical grid line coordinate of the current map view. </ca:description> |
|---|
| 140 |
<ca:code > |
|---|
| 141 |
|
|---|
| 142 |
<ca:codeblock bold="false"> |
|---|
| 143 |
<ca:line><cwc2 type="Extent" </ca:line> |
|---|
| 144 |
<ca:line> label="Left: " </ca:line> |
|---|
| 145 |
<ca:line> visible="true" </ca:line> |
|---|
| 146 |
<ca:line> extent="minx" </ca:line> |
|---|
| 147 |
<ca:line> labelposition="8" </ca:line> |
|---|
| 148 |
<ca:line> labelvalign="middle" </ca:line> |
|---|
| 149 |
<ca:line> labelclass="label" </ca:line> |
|---|
| 150 |
<ca:line> widgetclass="inputBox"/></ca:line> |
|---|
| 151 |
</ca:codeblock> |
|---|
| 152 |
</ca:code> |
|---|
| 153 |
</ca:example> |
|---|
| 154 |
</ca:widgetexamples> |
|---|
| 155 |
<ca:sharedresourceexamples title="Shared Resources Examples"> |
|---|
| 156 |
<ca:example title=""> |
|---|
| 157 |
<ca:description></ca:description> |
|---|
| 158 |
<ca:code title=""> |
|---|
| 159 |
<ca:description></ca:description> |
|---|
| 160 |
<ca:codeblock bold="false"> |
|---|
| 161 |
<ca:line></ca:line> |
|---|
| 162 |
</ca:codeblock> |
|---|
| 163 |
</ca:code> |
|---|
| 164 |
</ca:example> |
|---|
| 165 |
</ca:sharedresourceexamples> |
|---|
| 166 |
<ca:sampleapps title="Sample Applications"> |
|---|
| 167 |
<ca:sampleapp> |
|---|
| 168 |
<ca:name>Hawaii Demo</ca:name> |
|---|
| 169 |
<ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl> |
|---|
| 170 |
<ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description> |
|---|
| 171 |
</ca:sampleapp> |
|---|
| 172 |
</ca:sampleapps> |
|---|
| 173 |
<ca:scriptexamples title="Script Examples"> |
|---|
| 174 |
<ca:example title=""> |
|---|
| 175 |
<ca:description></ca:description> |
|---|
| 176 |
<ca:code title=""> |
|---|
| 177 |
<ca:description></ca:description> |
|---|
| 178 |
<ca:codeblock bold="false"> |
|---|
| 179 |
<ca:line></ca:line> |
|---|
| 180 |
</ca:codeblock> |
|---|
| 181 |
</ca:code> |
|---|
| 182 |
</ca:example> |
|---|
| 183 |
</ca:scriptexamples> |
|---|
| 184 |
</ca:examples> |
|---|
| 185 |
<ca:attributegroups title="Attribute Groups"> |
|---|
| 186 |
<ca:description></ca:description> |
|---|
| 187 |
<ca:attributegroup> |
|---|
| 188 |
<ca:name>Base</ca:name> |
|---|
| 189 |
<ca:name>Label</ca:name> |
|---|
| 190 |
</ca:attributegroup> |
|---|
| 191 |
</ca:attributegroups> |
|---|
| 192 |
<ca:widgettag title="Attributes"> |
|---|
| 193 |
<ca:attribute> |
|---|
| 194 |
<ca:name>EXTENT</ca:name> |
|---|
| 195 |
<ca:type title="Type"> |
|---|
| 196 |
<ca:value>string</ca:value> |
|---|
| 197 |
<ca:description></ca:description> |
|---|
| 198 |
</ca:type> |
|---|
| 199 |
<ca:class title="Class"> |
|---|
| 200 |
<ca:value>Required</ca:value> |
|---|
| 201 |
</ca:class> |
|---|
| 202 |
<ca:possvalues type="list" title="Value"> |
|---|
| 203 |
<ca:value>MINX</ca:value> |
|---|
| 204 |
<ca:value>MINY</ca:value> |
|---|
| 205 |
<ca:value>MAXX</ca:value> |
|---|
| 206 |
<ca:value>MAXY</ca:value> |
|---|
| 207 |
</ca:possvalues> |
|---|
| 208 |
<ca:description>The extent to display.</ca:description> |
|---|
| 209 |
</ca:attribute> |
|---|
| 210 |
<ca:attribute> |
|---|
| 211 |
<ca:name>WIDGETCLASS</ca:name> |
|---|
| 212 |
<ca:type title="Type"> |
|---|
| 213 |
<ca:value>string</ca:value> |
|---|
| 214 |
<ca:description></ca:description> |
|---|
| 215 |
</ca:type> |
|---|
| 216 |
<ca:class title="Class"> |
|---|
| 217 |
<ca:value>Widget Only</ca:value> |
|---|
| 218 |
</ca:class> |
|---|
| 219 |
<ca:default title="Default"> |
|---|
| 220 |
<ca:value>CWCExtentWidgetClass</ca:value> |
|---|
| 221 |
<ca:description></ca:description> |
|---|
| 222 |
</ca:default> |
|---|
| 223 |
<ca:description>The CSS class to control the style of the extent text.</ca:description> |
|---|
| 224 |
</ca:attribute> |
|---|
| 225 |
<ca:attribute> |
|---|
| 226 |
<ca:name>TEXTFIELDSIZE</ca:name> |
|---|
| 227 |
<ca:type title="Type"> |
|---|
| 228 |
<ca:value>integer</ca:value> |
|---|
| 229 |
<ca:description></ca:description> |
|---|
| 230 |
</ca:type> |
|---|
| 231 |
<ca:class title="Class"> |
|---|
| 232 |
<ca:value>Widget Only</ca:value> |
|---|
| 233 |
</ca:class> |
|---|
| 234 |
<ca:default title="Default"> |
|---|
| 235 |
<ca:value>20</ca:value> |
|---|
| 236 |
<ca:description>pixels</ca:description> |
|---|
| 237 |
</ca:default> |
|---|
| 238 |
<ca:possvalues type="range" title="Value"> |
|---|
| 239 |
<ca:minimum>0</ca:minimum> |
|---|
| 240 |
<ca:maximum>2147483647</ca:maximum> |
|---|
| 241 |
</ca:possvalues> |
|---|
| 242 |
<ca:description>The size (in characters) to make the extent widget in JSAPI mode.</ca:description> |
|---|
| 243 |
</ca:attribute> |
|---|
| 244 |
</ca:widgettag> |
|---|
| 245 |
<ca:formelements title="Form Elements"> |
|---|
| 246 |
<ca:formelement> |
|---|
| 247 |
<ca:name>sid</ca:name> |
|---|
| 248 |
<ca:type title="Type"> |
|---|
| 249 |
<ca:value>unknown</ca:value> |
|---|
| 250 |
<ca:description></ca:description> |
|---|
| 251 |
</ca:type> |
|---|
| 252 |
<ca:default title="Default"> |
|---|
| 253 |
<ca:value></ca:value> |
|---|
| 254 |
<ca:description></ca:description> |
|---|
| 255 |
</ca:default> |
|---|
| 256 |
<ca:possvalues type="list" title="Values"> |
|---|
| 257 |
<ca:value></ca:value> |
|---|
| 258 |
</ca:possvalues> |
|---|
| 259 |
<ca:description></ca:description> |
|---|
| 260 |
</ca:formelement> |
|---|
| 261 |
</ca:formelements> |
|---|
| 262 |
<ca:jsvariables title="JavaScript Variables"/> |
|---|
| 263 |
<ca:jsfunctions title="JavaScript Functions"/> |
|---|
| 264 |
<ca:jsfiles title="JavaScript Files"> |
|---|
| 265 |
<ca:jsfile> |
|---|
| 266 |
<ca:name></ca:name> |
|---|
| 267 |
<ca:description></ca:description> |
|---|
| 268 |
<ca:jsvariables title="JavaScript Variables"> |
|---|
| 269 |
<ca:jsvariable> |
|---|
| 270 |
<ca:name></ca:name> |
|---|
| 271 |
<ca:type title="Type"> |
|---|
| 272 |
<ca:value>string</ca:value> |
|---|
| 273 |
</ca:type> |
|---|
| 274 |
<ca:scope title="Scope"> |
|---|
| 275 |
<ca:value>Private</ca:value> |
|---|
| 276 |
</ca:scope> |
|---|
| 277 |
<ca:default title="Default"> |
|---|
| 278 |
<ca:value></ca:value> |
|---|
| 279 |
</ca:default> |
|---|
| 280 |
<ca:possvalues type="list" title="Values"> |
|---|
| 281 |
<ca:value></ca:value> |
|---|
| 282 |
</ca:possvalues> |
|---|
| 283 |
<ca:description></ca:description> |
|---|
| 284 |
</ca:jsvariable> |
|---|
| 285 |
</ca:jsvariables> |
|---|
| 286 |
<ca:jsfunctions title="JavaScript Functions"> |
|---|
| 287 |
<ca:jsfunction> |
|---|
| 288 |
<ca:name></ca:name> |
|---|
| 289 |
<ca:scope title="Scope"> |
|---|
| 290 |
<ca:value>Private</ca:value> |
|---|
| 291 |
</ca:scope> |
|---|
| 292 |
<ca:description></ca:description> |
|---|
| 293 |
<ca:parameters title="Parameters"> |
|---|
| 294 |
<ca:parameter> |
|---|
| 295 |
<ca:name></ca:name> |
|---|
| 296 |
<ca:type title="Type"> |
|---|
| 297 |
<ca:value>string</ca:value> |
|---|
| 298 |
</ca:type> |
|---|
| 299 |
<ca:required title="Required"> |
|---|
| 300 |
<ca:value>false</ca:value> |
|---|
| 301 |
</ca:required> |
|---|
| 302 |
<ca:default title="Default"> |
|---|
| 303 |
<ca:value></ca:value> |
|---|
| 304 |
<ca:description></ca:description> |
|---|
| 305 |
</ca:default> |
|---|
| 306 |
<ca:possvalues type="list" title="Values"> |
|---|
| 307 |
<ca:value></ca:value> |
|---|
| 308 |
</ca:possvalues> |
|---|
| 309 |
<ca:description></ca:description> |
|---|
| 310 |
</ca:parameter> |
|---|
| 311 |
</ca:parameters> |
|---|
| 312 |
<ca:returnvalues title="Function Return Value"> |
|---|
| 313 |
<ca:returnvalue> |
|---|
| 314 |
<ca:type title="Type"> |
|---|
| 315 |
<ca:value>unknown</ca:value> |
|---|
| 316 |
<ca:description></ca:description> |
|---|
| 317 |
</ca:type> |
|---|
| 318 |
<ca:default title="Default"> |
|---|
| 319 |
<ca:value></ca:value> |
|---|
| 320 |
</ca:default> |
|---|
| 321 |
<ca:possvalues type="list" title="Values"> |
|---|
| 322 |
<ca:value></ca:value> |
|---|
| 323 |
</ca:possvalues> |
|---|
| 324 |
<ca:description></ca:description> |
|---|
| 325 |
</ca:returnvalue> |
|---|
| 326 |
</ca:returnvalues> |
|---|
| 327 |
<ca:triggeredjsapievents title="JSAPI Triggered Events"> |
|---|
| 328 |
<ca:triggeredjsapievent title=""> |
|---|
| 329 |
<ca:name></ca:name> |
|---|
| 330 |
<ca:description></ca:description> |
|---|
| 331 |
</ca:triggeredjsapievent> |
|---|
| 332 |
</ca:triggeredjsapievents> |
|---|
| 333 |
</ca:jsfunction> |
|---|
| 334 |
</ca:jsfunctions> |
|---|
| 335 |
</ca:jsfile> |
|---|
| 336 |
</ca:jsfiles> |
|---|
| 337 |
<ca:listenedjsapievents title="JSAPI Listened Events"> |
|---|
| 338 |
<ca:listenedjsapievent title=""> |
|---|
| 339 |
<ca:name></ca:name> |
|---|
| 340 |
<ca:description></ca:description> |
|---|
| 341 |
<ca:calledfunctions title="Functions Calls"> |
|---|
| 342 |
<ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro> |
|---|
| 343 |
<ca:calledfunction> |
|---|
| 344 |
<ca:name></ca:name> |
|---|
| 345 |
<ca:description></ca:description> |
|---|
| 346 |
</ca:calledfunction> |
|---|
| 347 |
</ca:calledfunctions> |
|---|
| 348 |
</ca:listenedjsapievent> |
|---|
| 349 |
</ca:listenedjsapievents> |
|---|
| 350 |
<ca:widgetevents title="Widget Events"> |
|---|
| 351 |
<ca:widgetevent> |
|---|
| 352 |
<ca:name></ca:name> |
|---|
| 353 |
<ca:parameters title="Parameters"> |
|---|
| 354 |
<ca:parameter> |
|---|
| 355 |
<ca:name></ca:name> |
|---|
| 356 |
<ca:type title="Type"> |
|---|
| 357 |
<ca:value>string</ca:value> |
|---|
| 358 |
</ca:type> |
|---|
| 359 |
<ca:required title="Required"> |
|---|
| 360 |
<ca:value>false</ca:value> |
|---|
| 361 |
</ca:required> |
|---|
| 362 |
<ca:default title="Default"> |
|---|
| 363 |
<ca:value></ca:value> |
|---|
| 364 |
<ca:description></ca:description> |
|---|
| 365 |
</ca:default> |
|---|
| 366 |
<ca:possvalues type="list" title="Values"> |
|---|
| 367 |
<ca:value></ca:value> |
|---|
| 368 |
</ca:possvalues> |
|---|
| 369 |
<ca:description></ca:description> |
|---|
| 370 |
</ca:parameter> |
|---|
| 371 |
</ca:parameters> |
|---|
| 372 |
<ca:description></ca:description> |
|---|
| 373 |
</ca:widgetevent> |
|---|
| 374 |
</ca:widgetevents> |
|---|
| 375 |
</ca:widgetdoc> |
|---|
