| 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>Paul Spencer</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:person> |
|---|
| 27 |
<ca:name>Christopher R. Thorne</ca:name> |
|---|
| 28 |
<ca:company>DM Solutions Group Inc.</ca:company> |
|---|
| 29 |
<ca:contact>chameleon@lists.maptools.org</ca:contact> |
|---|
| 30 |
</ca:person> |
|---|
| 31 |
</ca:editors> |
|---|
| 32 |
</ca:docinfo> |
|---|
| 33 |
<ca:identification> |
|---|
| 34 |
<ca:name> |
|---|
| 35 |
<ca:value>Scalebar</ca:value> |
|---|
| 36 |
</ca:name> |
|---|
| 37 |
<ca:chameleonpack> |
|---|
| 38 |
<ca:value>TBD</ca:value> |
|---|
| 39 |
</ca:chameleonpack> |
|---|
| 40 |
<ca:parentgroup> |
|---|
| 41 |
<ca:value>Label Widget</ca:value> |
|---|
| 42 |
</ca:parentgroup> |
|---|
| 43 |
<ca:version> |
|---|
| 44 |
<ca:value>2.0</ca:value> |
|---|
| 45 |
</ca:version> |
|---|
| 46 |
<ca:releasedate> |
|---|
| 47 |
<ca:value>2005-01-10</ca:value> |
|---|
| 48 |
</ca:releasedate> |
|---|
| 49 |
<ca:maturitylevel> |
|---|
| 50 |
<ca:value>TECHRELEASE</ca:value> |
|---|
| 51 |
</ca:maturitylevel> |
|---|
| 52 |
<ca:developers> |
|---|
| 53 |
<ca:person> |
|---|
| 54 |
<ca:name>Paul Spencer</ca:name> |
|---|
| 55 |
<ca:company>DM Solutions Group Inc.</ca:company> |
|---|
| 56 |
<ca:contact>chameleon@lists.maptools.org</ca:contact> |
|---|
| 57 |
</ca:person> |
|---|
| 58 |
</ca:developers> |
|---|
| 59 |
</ca:identification> |
|---|
| 60 |
<ca:descriptions> |
|---|
| 61 |
<ca:description> |
|---|
| 62 |
<ca:paras> |
|---|
| 63 |
<ca:para>The Scalebar widget is used to display a scalebar image for the current extents of the map view. The scalebar is a representation of the ground scale of the map. One block on the screen is equivalent to the indicated distance on the ground (typically kilometers or miles). A scalebar is a more accurate representation of ground scale than the Scale widget because it accomodates differences in screen resolution. However, even a scalebar contains inaccuracies depending on the projection of the map and the assumptions used in the scale calculations.</ca:para> |
|---|
| 64 |
<ca:para>All the attributes of the Scalebar widget are reflected in the MapServer map file. The widget uses any values from the map file as default values and overrides them with the widget attribute values, if set. This means that a template can be configured to fully define the scalebar (thus ignoring any values in the map file), to define none of the attributes (thus taking all the values from the map file), or any combination.</ca:para> |
|---|
| 65 |
<ca:para>Note that there is a technical issue with Scalebar related to a bug in MapServer (bug 513). If the units chosen are not appropriate for the intended scale of the application, the labels for each segment of the Scalebar can end up overlapping each other, or disappearing complete. For instance, if you choose INCHES and then view all of Canada, each segment represents a huge number of inches on the ground and results in an overflow of information. It is also not useful to the user.</ca:para> |
|---|
| 66 |
</ca:paras> |
|---|
| 67 |
</ca:description> |
|---|
| 68 |
<ca:dependancies> |
|---|
| 69 |
<ca:dependancy type="None" title=""> |
|---|
| 70 |
<ca:para/> |
|---|
| 71 |
</ca:dependancy> |
|---|
| 72 |
</ca:dependancies> |
|---|
| 73 |
<ca:sharedresources> |
|---|
| 74 |
<ca:paras title="None Available."> |
|---|
| 75 |
<ca:para/> |
|---|
| 76 |
</ca:paras> |
|---|
| 77 |
</ca:sharedresources> |
|---|
| 78 |
<ca:embeddedhelp> |
|---|
| 79 |
<ca:paras> |
|---|
| 80 |
<ca:para>The Scalebar widget displays the ground scale of the current map view. The Scalebar displays the distance on the ground that is represented by a distance on the screen and is more precise than the Scale widget since it is independent of screen resolution. |
|---|
| 81 |
</ca:para> |
|---|
| 82 |
</ca:paras> |
|---|
| 83 |
</ca:embeddedhelp> |
|---|
| 84 |
</ca:descriptions> |
|---|
| 85 |
<ca:tagstructures> |
|---|
| 86 |
<ca:tagstructure title="Widget Syntax"> |
|---|
| 87 |
<ca:description/> |
|---|
| 88 |
<ca:code> |
|---|
| 89 |
<ca:codeblock bold="true"> |
|---|
| 90 |
<ca:line><CWC2 TYPE="Scalebar"</ca:line> |
|---|
| 91 |
</ca:codeblock> |
|---|
| 92 |
<ca:codeblock bold="false"> |
|---|
| 93 |
<ca:line> ENABLED="[TRUE|FALSE]"</ca:line> |
|---|
| 94 |
<ca:line> FORMINDEX="[0 < integer]"</ca:line> |
|---|
| 95 |
<ca:line> VISIBLE="[TRUE|FALSE]"</ca:line> |
|---|
| 96 |
<ca:line/> |
|---|
| 97 |
<ca:line> <!-- ScaleBar Attributes--></ca:line> |
|---|
| 98 |
<ca:line/> |
|---|
| 99 |
<ca:line> WIDTH="[0 < integer]"</ca:line> |
|---|
| 100 |
<ca:line> HEIGHT="[0 < integer]"</ca:line> |
|---|
| 101 |
<ca:line> INTERVALS="[0 < integer]"</ca:line> |
|---|
| 102 |
<ca:line> UNITS="[INCHES|FEET|MILES|METERS|KILOMETERS]"</ca:line> |
|---|
| 103 |
<ca:line> COLOR="[RRR GGG BBB]"</ca:line> |
|---|
| 104 |
<ca:line> BACKGROUNDCOLOR="[RRR GGG BBB]"</ca:line> |
|---|
| 105 |
<ca:line> OUTLINECOLOR="[RRR GGG BBB]"</ca:line> |
|---|
| 106 |
<ca:line> LABELCOLOR="[RRR GGG BBB]"</ca:line> |
|---|
| 107 |
<ca:line> LABELSIZE="[TINY|SMALL|MEDIUM|LARGE|GIANT]"</ca:line> |
|---|
| 108 |
<ca:line> TRANSPARENT="[TRUE|FALSE]"</ca:line> |
|---|
| 109 |
<ca:line> IMAGETYPE="[GIF|PNG|PNG24|JPEG|WBMP|PDF|SWF]"/></ca:line> |
|---|
| 110 |
</ca:codeblock> |
|---|
| 111 |
</ca:code> |
|---|
| 112 |
</ca:tagstructure> |
|---|
| 113 |
</ca:tagstructures> |
|---|
| 114 |
<ca:examples> |
|---|
| 115 |
<ca:widgetexamples> |
|---|
| 116 |
<ca:example title="Example #1: Simple"> |
|---|
| 117 |
<ca:description>The following is the simplest example of the "Scalebar" widget, because most of the scalebar attributes have default values.</ca:description> |
|---|
| 118 |
<ca:code> |
|---|
| 119 |
<ca:codeblock bold="false"> |
|---|
| 120 |
<ca:line><cwc2 type="Scalebar"/></ca:line> |
|---|
| 121 |
</ca:codeblock> |
|---|
| 122 |
</ca:code> |
|---|
| 123 |
</ca:example> |
|---|
| 124 |
<ca:example title="Example #2: Advanced"> |
|---|
| 125 |
<ca:description>Here is a how a configured Scalebar widget would look.</ca:description> |
|---|
| 126 |
<ca:code> |
|---|
| 127 |
<ca:codeblock bold="false"> |
|---|
| 128 |
<ca:line><cwc2 type="Scalebar"</ca:line> |
|---|
| 129 |
<ca:line> units="MILES"</ca:line> |
|---|
| 130 |
<ca:line> visible="true"</ca:line> |
|---|
| 131 |
<ca:line> width="250"</ca:line> |
|---|
| 132 |
<ca:line> height="4"</ca:line> |
|---|
| 133 |
<ca:line> intervals="5"</ca:line> |
|---|
| 134 |
<ca:line> outlinecolor="0 0 0"</ca:line> |
|---|
| 135 |
<ca:line> color="102 102 102"/></ca:line> |
|---|
| 136 |
</ca:codeblock> |
|---|
| 137 |
</ca:code> |
|---|
| 138 |
</ca:example> |
|---|
| 139 |
</ca:widgetexamples> |
|---|
| 140 |
<ca:sharedresourceexamples> |
|---|
| 141 |
<ca:example title=""> |
|---|
| 142 |
<ca:description/> |
|---|
| 143 |
<ca:code> |
|---|
| 144 |
<ca:codeblock bold="false"> |
|---|
| 145 |
<ca:line/> |
|---|
| 146 |
</ca:codeblock> |
|---|
| 147 |
</ca:code> |
|---|
| 148 |
</ca:example> |
|---|
| 149 |
</ca:sharedresourceexamples> |
|---|
| 150 |
<ca:sampleapps> |
|---|
| 151 |
<ca:sampleapp> |
|---|
| 152 |
<ca:name>Hawaii Demo</ca:name> |
|---|
| 153 |
<ca:appurl>www.mapsherpa.com/hawaii2/</ca:appurl> |
|---|
| 154 |
<ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description> |
|---|
| 155 |
</ca:sampleapp> |
|---|
| 156 |
</ca:sampleapps> |
|---|
| 157 |
<ca:scriptexamples/> |
|---|
| 158 |
</ca:examples> |
|---|
| 159 |
<ca:attributegroups> |
|---|
| 160 |
<ca:attributegroup> |
|---|
| 161 |
<ca:name>Base</ca:name> |
|---|
| 162 |
</ca:attributegroup> |
|---|
| 163 |
</ca:attributegroups> |
|---|
| 164 |
<ca:widgettag> |
|---|
| 165 |
<ca:attribute> |
|---|
| 166 |
<ca:name>COLOR</ca:name> |
|---|
| 167 |
<ca:type> |
|---|
| 168 |
<ca:value>RGB color</ca:value> |
|---|
| 169 |
</ca:type> |
|---|
| 170 |
<ca:class> |
|---|
| 171 |
<ca:value>Widget Only</ca:value> |
|---|
| 172 |
</ca:class> |
|---|
| 173 |
<ca:default> |
|---|
| 174 |
<ca:value>255,255,255</ca:value> |
|---|
| 175 |
<ca:description>white</ca:description> |
|---|
| 176 |
</ca:default> |
|---|
| 177 |
<ca:description>The color to draw the foreground of the scalebar with.</ca:description> |
|---|
| 178 |
</ca:attribute> |
|---|
| 179 |
<ca:attribute> |
|---|
| 180 |
<ca:name>BACKGROUNDCOLOR</ca:name> |
|---|
| 181 |
<ca:type> |
|---|
| 182 |
<ca:value>RGB color</ca:value> |
|---|
| 183 |
</ca:type> |
|---|
| 184 |
<ca:class> |
|---|
| 185 |
<ca:value>Widget Only</ca:value> |
|---|
| 186 |
</ca:class> |
|---|
| 187 |
<ca:default> |
|---|
| 188 |
<ca:value>0,0,0</ca:value> |
|---|
| 189 |
<ca:description>black</ca:description> |
|---|
| 190 |
</ca:default> |
|---|
| 191 |
<ca:description>The color to draw the background of the scalebar with.</ca:description> |
|---|
| 192 |
</ca:attribute> |
|---|
| 193 |
<ca:attribute> |
|---|
| 194 |
<ca:name>HEIGHT</ca:name> |
|---|
| 195 |
<ca:type> |
|---|
| 196 |
<ca:value>integer</ca:value> |
|---|
| 197 |
</ca:type> |
|---|
| 198 |
<ca:class> |
|---|
| 199 |
<ca:value>Widget Only</ca:value> |
|---|
| 200 |
</ca:class> |
|---|
| 201 |
<ca:default> |
|---|
| 202 |
<ca:value>5</ca:value> |
|---|
| 203 |
<ca:description>pixels</ca:description> |
|---|
| 204 |
</ca:default> |
|---|
| 205 |
<ca:possvalues type="range"> |
|---|
| 206 |
<ca:minimum>0</ca:minimum> |
|---|
| 207 |
<ca:maximum>2147483647</ca:maximum> |
|---|
| 208 |
</ca:possvalues> |
|---|
| 209 |
<ca:description>The height (in pixels) to draw the scalebar image. Note that this includes the text labels.</ca:description> |
|---|
| 210 |
</ca:attribute> |
|---|
| 211 |
<ca:attribute> |
|---|
| 212 |
<ca:name>INTERVALS</ca:name> |
|---|
| 213 |
<ca:type> |
|---|
| 214 |
<ca:value>integer</ca:value> |
|---|
| 215 |
</ca:type> |
|---|
| 216 |
<ca:class> |
|---|
| 217 |
<ca:value>Widget Only</ca:value> |
|---|
| 218 |
</ca:class> |
|---|
| 219 |
<ca:default> |
|---|
| 220 |
<ca:value>5</ca:value> |
|---|
| 221 |
<ca:description>scalebars</ca:description> |
|---|
| 222 |
</ca:default> |
|---|
| 223 |
<ca:possvalues type="range"> |
|---|
| 224 |
<ca:minimum>0</ca:minimum> |
|---|
| 225 |
<ca:maximum>2147483647</ca:maximum> |
|---|
| 226 |
</ca:possvalues> |
|---|
| 227 |
<ca:description>The number of intervals to include in the scalebar.</ca:description> |
|---|
| 228 |
</ca:attribute> |
|---|
| 229 |
<ca:attribute> |
|---|
| 230 |
<ca:name>LABELCOLOR</ca:name> |
|---|
| 231 |
<ca:type> |
|---|
| 232 |
<ca:value>RGB color</ca:value> |
|---|
| 233 |
</ca:type> |
|---|
| 234 |
<ca:class> |
|---|
| 235 |
<ca:value>Widget Only</ca:value> |
|---|
| 236 |
</ca:class> |
|---|
| 237 |
<ca:default> |
|---|
| 238 |
<ca:value>0,0,0</ca:value> |
|---|
| 239 |
<ca:description>black</ca:description> |
|---|
| 240 |
</ca:default> |
|---|
| 241 |
<ca:description>The color to draw the labels with.</ca:description> |
|---|
| 242 |
</ca:attribute> |
|---|
| 243 |
<ca:attribute> |
|---|
| 244 |
<ca:name>LABELSIZE</ca:name> |
|---|
| 245 |
<ca:type> |
|---|
| 246 |
<ca:value>string</ca:value> |
|---|
| 247 |
</ca:type> |
|---|
| 248 |
<ca:class> |
|---|
| 249 |
<ca:value>Widget Only</ca:value> |
|---|
| 250 |
</ca:class> |
|---|
| 251 |
<ca:default> |
|---|
| 252 |
<ca:value>SMALL</ca:value> |
|---|
| 253 |
<ca:description/> |
|---|
| 254 |
</ca:default> |
|---|
| 255 |
<ca:possvalues type="list"> |
|---|
| 256 |
<ca:value>TINY</ca:value> |
|---|
| 257 |
<ca:value>SMALL</ca:value> |
|---|
| 258 |
<ca:value>MEDIUM</ca:value> |
|---|
| 259 |
<ca:value>LARGE</ca:value> |
|---|
| 260 |
<ca:value>GIANT</ca:value> |
|---|
| 261 |
</ca:possvalues> |
|---|
| 262 |
<ca:description>The size of the text to draw the labels with.</ca:description> |
|---|
| 263 |
</ca:attribute> |
|---|
| 264 |
<ca:attribute> |
|---|
| 265 |
<ca:name>OUTLINECOLOR</ca:name> |
|---|
| 266 |
<ca:type> |
|---|
| 267 |
<ca:value>RGB color</ca:value> |
|---|
| 268 |
</ca:type> |
|---|
| 269 |
<ca:class> |
|---|
| 270 |
<ca:value>Widget Only</ca:value> |
|---|
| 271 |
</ca:class> |
|---|
| 272 |
<ca:default> |
|---|
| 273 |
<ca:value>0,0,0</ca:value> |
|---|
| 274 |
<ca:description>black</ca:description> |
|---|
| 275 |
</ca:default> |
|---|
| 276 |
<ca:description>The outline color to draw the scalebar with.</ca:description> |
|---|
| 277 |
</ca:attribute> |
|---|
| 278 |
<ca:attribute> |
|---|
| 279 |
<ca:name>TRANSPARENT</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>true</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>Control the transparency of the scalebar image.</ca:description> |
|---|
| 295 |
</ca:attribute> |
|---|
| 296 |
<ca:attribute> |
|---|
| 297 |
<ca:name>UNITS</ca:name> |
|---|
| 298 |
<ca:type> |
|---|
| 299 |
<ca:value>string</ca:value> |
|---|
| 300 |
</ca:type> |
|---|
| 301 |
<ca:class> |
|---|
| 302 |
<ca:value>Widget Only</ca:value> |
|---|
| 303 |
</ca:class> |
|---|
| 304 |
<ca:default> |
|---|
| 305 |
<ca:value>255,255,255</ca:value> |
|---|
| 306 |
<ca:description>white</ca:description> |
|---|
| 307 |
</ca:default> |
|---|
| 308 |
<ca:possvalues type="list"> |
|---|
| 309 |
<ca:value>INCHES</ca:value> |
|---|
| 310 |
<ca:value>FEET</ca:value> |
|---|
| 311 |
<ca:value>MILES</ca:value> |
|---|
| 312 |
<ca:value>METERS</ca:value> |
|---|
| 313 |
<ca:value>KILOMETERS</ca:value> |
|---|
| 314 |
</ca:possvalues> |
|---|
| 315 |
<ca:description>The units to draw the scalebar in.</ca:description> |
|---|
| 316 |
</ca:attribute> |
|---|
| 317 |
<ca:attribute> |
|---|
| 318 |
<ca:name>WIDTH</ca:name> |
|---|
| 319 |
<ca:type> |
|---|
| 320 |
<ca:value>integer</ca:value> |
|---|
| 321 |
</ca:type> |
|---|
| 322 |
<ca:class> |
|---|
| 323 |
<ca:value>Widget Only</ca:value> |
|---|
| 324 |
</ca:class> |
|---|
| 325 |
<ca:default> |
|---|
| 326 |
<ca:value>200</ca:value> |
|---|
| 327 |
<ca:description>pixels</ca:description> |
|---|
| 328 |
</ca:default> |
|---|
| 329 |
<ca:possvalues type="range"> |
|---|
| 330 |
<ca:minimum>0</ca:minimum> |
|---|
| 331 |
<ca:maximum>2147483647</ca:maximum> |
|---|
| 332 |
</ca:possvalues> |
|---|
| 333 |
<ca:description>The width (in pixels) to draw the scalebar image.</ca:description> |
|---|
| 334 |
</ca:attribute> |
|---|
| 335 |
<ca:attribute> |
|---|
| 336 |
<ca:name>IMAGETYPE</ca:name> |
|---|
| 337 |
<ca:type> |
|---|
| 338 |
<ca:value>string</ca:value> |
|---|
| 339 |
</ca:type> |
|---|
| 340 |
<ca:class> |
|---|
| 341 |
<ca:value>Widget Only</ca:value> |
|---|
| 342 |
</ca:class> |
|---|
| 343 |
<ca:default> |
|---|
| 344 |
<ca:value>PNG</ca:value> |
|---|
| 345 |
<ca:description/> |
|---|
| 346 |
</ca:default> |
|---|
| 347 |
<ca:possvalues type="list"> |
|---|
| 348 |
<ca:value>GIF</ca:value> |
|---|
| 349 |
<ca:value>PNG</ca:value> |
|---|
| 350 |
<ca:value>PNG24</ca:value> |
|---|
| 351 |
<ca:value>JPEG</ca:value> |
|---|
| 352 |
<ca:value>WBMP</ca:value> |
|---|
| 353 |
<ca:value>PDF</ca:value> |
|---|
| 354 |
<ca:value>SWF</ca:value> |
|---|
| 355 |
</ca:possvalues> |
|---|
| 356 |
<ca:description>The type of the image to display the scalebar as. This is useful if the main map is PNG24, but the scalebar should be displayed in a format that browsers can display transparently (e.g., PNG).</ca:description> |
|---|
| 357 |
</ca:attribute> |
|---|
| 358 |
</ca:widgettag> |
|---|
| 359 |
<ca:formelements title="Form Elements"> |
|---|
| 360 |
<ca:formelement> |
|---|
| 361 |
<ca:name>sid</ca:name> |
|---|
| 362 |
<ca:type title="Type"> |
|---|
| 363 |
<ca:value>unknown</ca:value> |
|---|
| 364 |
<ca:description></ca:description> |
|---|
| 365 |
</ca:type> |
|---|
| 366 |
<ca:default title="Default"> |
|---|
| 367 |
<ca:value></ca:value> |
|---|
| 368 |
<ca:description></ca:description> |
|---|
| 369 |
</ca:default> |
|---|
| 370 |
<ca:description></ca:description> |
|---|
| 371 |
</ca:formelement> |
|---|
| 372 |
</ca:formelements> |
|---|
| 373 |
</ca:widgetdoc> |
|---|
