NCCOOS Trac Projects: Top | Web | Platforms | Processing | Viz | Sprints | Sandbox | (Wind)

root/Chameleon/trunk/Chameleon/ROIManager/ROIManager.en-ca.doc.xml

Revision 13 (checked in by jcleary, 17 years ago)

Latest Chameleon code checkout from previous repository

Line 
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>2004-12-18</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:editors>
29   </ca:docinfo>
30   <ca:identification title="Identification">
31     <ca:name title="Name">
32       <ca:value>roimanager</ca:value>
33     </ca:name>
34     <ca:chameleonpack title="Widet Package">
35       <ca:value>TBD</ca:value>
36     </ca:chameleonpack>
37     <ca:parentgroup title="Parent Group">
38       <ca:value>TBD</ca:value>
39     </ca:parentgroup>
40     <ca:version title="Version">
41       <ca:value>1.99</ca:value>
42     </ca:version>
43     <ca:releasedate title="Release Date">
44       <ca:value>1999-12-31</ca:value>
45     </ca:releasedate>
46     <ca:maturitylevel title="Maturity Level">
47       <ca:value>BETA</ca:value>
48     </ca:maturitylevel>
49     <ca:developers title="Developers">
50       <ca:person>
51         <ca:name>Paul Spencer</ca:name>
52         <ca:company>DM Solutions Group Inc.</ca:company>
53         <ca:contact>chameleon@lists.maptools.org</ca:contact>
54         <ca:comment></ca:comment>
55       </ca:person>
56     </ca:developers>
57   </ca:identification>
58   <ca:descriptions title="Description">
59     <ca:description title="General Functionality">
60       <ca:paras title="">
61         <ca:para>The ROIManager widget allows the user to draw multiple ROIs</ca:para>
62       </ca:paras>
63     </ca:description>
64     <ca:techrequirements title="Technical Requirements">
65       <ca:paras title="Not Available">
66         <ca:para></ca:para>
67       </ca:paras>
68     </ca:techrequirements>
69     <ca:dependancies title="Dependancies">
70       <ca:dependancy type="None" title="Not Available">
71         <ca:para></ca:para>
72       </ca:dependancy>
73     </ca:dependancies>
74     <ca:sharedresources title="Shared Resources">
75       <ca:paras title="Not Available">
76         <ca:para></ca:para>
77       </ca:paras>
78     </ca:sharedresources>
79     <ca:embeddedhelp title="General User Interface Help">
80       <ca:paras title="">
81         <ca:para></ca:para>
82       </ca:paras>
83     </ca:embeddedhelp>
84     <ca:guinotes title="Interface Functionality">
85       <ca:guinote type="None" title="None.">
86         <ca:para></ca:para>
87       </ca:guinote>
88     </ca:guinotes>
89     <ca:qanotes title="Quality Assurance">
90       <ca:paras title="None.">
91         <ca:para></ca:para>
92       </ca:paras>
93     </ca:qanotes>
94   </ca:descriptions>
95   <ca:tagstructures title="Tag Syntax">
96     <ca:tagstructure title="Widget Syntax">
97       <ca:description></ca:description>
98       <ca:code title="">
99         <ca:description></ca:description>
100         <ca:codeblock bold="false">
101           <ca:line>   MODE ="[string]"</ca:line>
102           <ca:line>   EDGECOLOR ="[hexcolor]"</ca:line>
103           <ca:line>   EDGEWIDTH ="[integer]"</ca:line>
104           <ca:line>   FILLCOLOR ="[hexcolor]"</ca:line>
105           <ca:line>   FILLOPACITY ="[integer]"</ca:line>
106           <ca:line>   FILLROI ="[boolean]"</ca:line>
107           <ca:line>   ONROICHANGED ="[string]"</ca:line>
108         </ca:codeblock>
109       </ca:code>
110     </ca:tagstructure>
111   </ca:tagstructures>
112   <ca:examples title="Examples">
113     <ca:widgetexamples title="Widget Examples">
114       <ca:example title="Example #1: Simple">
115         <ca:description></ca:description>
116         <ca:code title="">
117           <ca:description></ca:description>
118           <ca:codeblock bold="false">
119             <ca:line></ca:line>
120           </ca:codeblock>
121         </ca:code>
122       </ca:example>
123     </ca:widgetexamples>
124     <ca:sharedresourceexamples title="Shared Resources Examples">
125       <ca:example title="Example #1: Advanced">
126         <ca:description></ca:description>
127         <ca:code title="">
128           <ca:description></ca:description>
129           <ca:codeblock bold="false">
130             <ca:line></ca:line>
131           </ca:codeblock>
132         </ca:code>
133       </ca:example>
134     </ca:sharedresourceexamples>
135     <ca:sampleapps title="Sample Applications">
136       <ca:sampleapp>
137         <ca:name>Hawaii Demo</ca:name>
138         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
139         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
140       </ca:sampleapp>
141     </ca:sampleapps>
142     <ca:scriptexamples title="Script Examples">
143       <ca:example title="Example #1: Simple">
144         <ca:description></ca:description>
145         <ca:code title="">
146           <ca:description></ca:description>
147           <ca:codeblock bold="false">
148             <ca:line></ca:line>
149           </ca:codeblock>
150         </ca:code>
151       </ca:example>
152     </ca:scriptexamples>
153   </ca:examples>
154   <ca:attributegroups title="Attribute Groups">
155     <ca:description></ca:description>
156     <ca:attributegroup>
157       <ca:name>base</ca:name>
158     </ca:attributegroup>
159   </ca:attributegroups>
160   <ca:widgettag title="Attributes">
161     <ca:attribute>
162       <ca:name>MODE</ca:name>
163       <ca:type title="Type">
164         <ca:value>string</ca:value>
165         <ca:description></ca:description>
166       </ca:type>
167       <ca:class title="Class">
168         <ca:value>Widget Only</ca:value>
169       </ca:class>
170       <ca:default title="Default">
171         <ca:description></ca:description>
172       </ca:default>
173     </ca:attribute>
174     <ca:attribute>
175       <ca:name>EDGECOLOR</ca:name>
176       <ca:type title="Type">
177         <ca:value>hexcolor</ca:value>
178         <ca:description></ca:description>
179       </ca:type>
180       <ca:class title="Class">
181         <ca:value>Widget Only</ca:value>
182       </ca:class>
183       <ca:default title="Default">
184         <ca:description></ca:description>
185       </ca:default>
186     </ca:attribute>
187     <ca:attribute>
188       <ca:name>EDGEWIDTH</ca:name>
189       <ca:type title="Type">
190         <ca:value>integer</ca:value>
191         <ca:description></ca:description>
192       </ca:type>
193       <ca:class title="Class">
194         <ca:value>Widget Only</ca:value>
195       </ca:class>
196       <ca:default title="Default">
197         <ca:description></ca:description>
198       </ca:default>
199       <ca:possvalues type="range" title="Value">
200         <ca:minimum>1</ca:minimum>
201         <ca:maximum>2147483647</ca:maximum>
202       </ca:possvalues>
203     </ca:attribute>
204     <ca:attribute>
205       <ca:name>FILLCOLOR</ca:name>
206       <ca:type title="Type">
207         <ca:value>hexcolor</ca:value>
208         <ca:description></ca:description>
209       </ca:type>
210       <ca:class title="Class">
211         <ca:value>Widget Only</ca:value>
212       </ca:class>
213       <ca:default title="Default">
214         <ca:description></ca:description>
215       </ca:default>
216     </ca:attribute>
217     <ca:attribute>
218       <ca:name>FILLOPACITY</ca:name>
219       <ca:type title="Type">
220         <ca:value>integer</ca:value>
221         <ca:description></ca:description>
222       </ca:type>
223       <ca:class title="Class">
224         <ca:value>Widget Only</ca:value>
225       </ca:class>
226       <ca:default title="Default">
227         <ca:description></ca:description>
228       </ca:default>
229       <ca:possvalues type="range" title="Value">
230         <ca:minimum>0</ca:minimum>
231         <ca:maximum>100</ca:maximum>
232       </ca:possvalues>
233     </ca:attribute>
234     <ca:attribute>
235       <ca:name>FILLROI</ca:name>
236       <ca:type title="Type">
237         <ca:value>boolean</ca:value>
238         <ca:description></ca:description>
239       </ca:type>
240       <ca:class title="Class">
241         <ca:value>Widget Only</ca:value>
242       </ca:class>
243       <ca:default title="Default">
244         <ca:description></ca:description>
245       </ca:default>
246       <ca:possvalues type="list" title="Value">
247         <ca:value>true</ca:value>
248         <ca:value>false</ca:value>
249       </ca:possvalues>
250     </ca:attribute>
251     <ca:attribute>
252       <ca:name>ONROICHANGED</ca:name>
253       <ca:type title="Type">
254         <ca:value>string</ca:value>
255         <ca:description></ca:description>
256       </ca:type>
257       <ca:class title="Class">
258         <ca:value>Widget Only</ca:value>
259       </ca:class>
260       <ca:default title="Default">
261         <ca:description></ca:description>
262       </ca:default>
263     </ca:attribute>
264     <ca:subtag>
265       <ca:name></ca:name>
266       <ca:type title="Type">
267         <ca:value>XML</ca:value>
268         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
269       </ca:type>
270       <ca:class title="Class">
271         <ca:value>Widget &amp; Shared Resource</ca:value>
272       </ca:class>
273       <ca:description></ca:description>
274       <ca:attribute>
275         <ca:name></ca:name>
276         <ca:type title="Type">
277           <ca:value>float</ca:value>
278           <ca:description></ca:description>
279         </ca:type>
280         <ca:class title="Class">
281           <ca:value>Widget &amp; Shared Resource</ca:value>
282         </ca:class>
283         <ca:default title="Default">
284           <ca:value></ca:value>
285           <ca:description></ca:description>
286         </ca:default>
287         <ca:possvalues type="list" title="Value">
288           <ca:value></ca:value>
289         </ca:possvalues>
290         <ca:description></ca:description>
291       </ca:attribute>
292     </ca:subtag>
293   </ca:widgettag>
294   <ca:formelements title="Form Elements">
295     <ca:formelement>
296       <ca:name>sid</ca:name>
297       <ca:type title="Type">
298         <ca:value>unknown</ca:value>
299         <ca:description></ca:description>
300       </ca:type>
301       <ca:default title="Default">
302         <ca:value></ca:value>
303         <ca:description></ca:description>
304       </ca:default>
305       <ca:possvalues type="list" title="Values">
306         <ca:value></ca:value>
307       </ca:possvalues>
308       <ca:description></ca:description>
309     </ca:formelement>
310     <ca:formelement>
311       <ca:name>ROI_MODE</ca:name>
312       <ca:type title="Type">
313         <ca:value>unknown</ca:value>
314         <ca:description></ca:description>
315       </ca:type>
316       <ca:default title="Default">
317         <ca:value></ca:value>
318         <ca:description></ca:description>
319       </ca:default>
320       <ca:possvalues type="list" title="Values">
321         <ca:value></ca:value>
322       </ca:possvalues>
323       <ca:description>The current mode of the ROI manager.</ca:description>
324     </ca:formelement>
325   </ca:formelements>
326   <ca:jsvariables title="JavaScript Variables">
327     <ca:jsvariable>
328       <ca:name>gROIRenderer</ca:name>
329       <ca:type title="Type">
330         <ca:value>string</ca:value>
331       </ca:type>
332       <ca:scope title="Scope">
333         <ca:value>Private</ca:value>
334       </ca:scope>
335       <ca:default title="Default">
336         <ca:value>gROIRenderer</ca:value>
337       </ca:default>
338       <ca:possvalues type="list" title="Values">
339         <ca:value></ca:value>
340       </ca:possvalues>
341       <ca:description>The URL to use to render an ROI</ca:description>
342     </ca:jsvariable>
343   </ca:jsvariables>
344   <ca:jsfunctions title="JavaScript Functions">
345     <ca:jsfunction>
346       <ca:name>ROIManagerInit</ca:name>
347       <ca:scope title="Scope">
348         <ca:value>Private</ca:value>
349       </ca:scope>
350       <ca:description>Called during page load to initialize the javascript ROI manager.</ca:description>
351       <ca:returnvalues title="Function Return Value">
352         <ca:returnvalue>
353           <ca:type title="Type">
354             <ca:value>unknown</ca:value>
355             <ca:description></ca:description>
356           </ca:type>
357           <ca:default title="Default">
358             <ca:value></ca:value>
359           </ca:default>
360           <ca:possvalues type="list" title="Values">
361             <ca:value></ca:value>
362           </ca:possvalues>
363           <ca:description></ca:description>
364         </ca:returnvalue>
365       </ca:returnvalues>
366       <ca:triggeredjsapievents title="JSAPI Triggered Events">
367         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
368         <ca:triggeredjsapievent title="">
369           <ca:name></ca:name>
370           <ca:description></ca:description>
371         </ca:triggeredjsapievent>
372       </ca:triggeredjsapievents>
373     </ca:jsfunction>
374     <ca:jsfunction>
375       <ca:name>ROIManagerCreateDHTMLLayers</ca:name>
376       <ca:scope title="Scope">
377         <ca:value>Private</ca:value>
378       </ca:scope>
379       <ca:description>Creates the DHTML layers used by the ROI manager to display the current ROI selection.</ca:description>
380       <ca:returnvalues title="Function Return Value">
381         <ca:returnvalue>
382           <ca:type title="Type">
383             <ca:value>unknown</ca:value>
384             <ca:description></ca:description>
385           </ca:type>
386           <ca:default title="Default">
387             <ca:value></ca:value>
388           </ca:default>
389           <ca:possvalues type="list" title="Values">
390             <ca:value></ca:value>
391           </ca:possvalues>
392           <ca:description></ca:description>
393         </ca:returnvalue>
394       </ca:returnvalues>
395       <ca:triggeredjsapievents title="JSAPI Triggered Events">
396         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
397         <ca:triggeredjsapievent title="">
398           <ca:name></ca:name>
399           <ca:description></ca:description>
400         </ca:triggeredjsapievent>
401       </ca:triggeredjsapievents>
402     </ca:jsfunction>
403   </ca:jsfunctions>
404   <ca:jsfiles title="JavaScript Files">
405     <ca:jsfile>
406       <ca:name></ca:name>
407       <ca:description></ca:description>
408       <ca:jsvariables title="JavaScript Variables">
409         <ca:jsvariable>
410           <ca:name></ca:name>
411           <ca:type title="Type">
412             <ca:value>string</ca:value>
413           </ca:type>
414           <ca:scope title="Scope">
415             <ca:value>Private</ca:value>
416           </ca:scope>
417           <ca:default title="Default">
418             <ca:value></ca:value>
419           </ca:default>
420           <ca:possvalues type="list" title="Values">
421             <ca:value></ca:value>
422           </ca:possvalues>
423           <ca:description></ca:description>
424         </ca:jsvariable>
425       </ca:jsvariables>
426       <ca:jsfunctions title="JavaScript Functions">
427         <ca:jsfunction>
428           <ca:name></ca:name>
429           <ca:scope title="Scope">
430             <ca:value>Private</ca:value>
431           </ca:scope>
432           <ca:description></ca:description>
433           <ca:parameters title="Parameters">
434             <ca:parameter>
435               <ca:name></ca:name>
436               <ca:type title="Type">
437                 <ca:value>string</ca:value>
438               </ca:type>
439               <ca:required title="Required">
440                 <ca:value>false</ca:value>
441               </ca:required>
442               <ca:default title="Default">
443                 <ca:value></ca:value>
444                 <ca:description></ca:description>
445               </ca:default>
446               <ca:possvalues type="list" title="Values">
447                 <ca:value></ca:value>
448               </ca:possvalues>
449               <ca:description></ca:description>
450             </ca:parameter>
451           </ca:parameters>
452           <ca:returnvalues title="Function Return Value">
453             <ca:returnvalue>
454               <ca:type title="Type">
455                 <ca:value>unknown</ca:value>
456                 <ca:description></ca:description>
457               </ca:type>
458               <ca:default title="Default">
459                 <ca:value></ca:value>
460               </ca:default>
461               <ca:possvalues type="list" title="Values">
462                 <ca:value></ca:value>
463               </ca:possvalues>
464               <ca:description></ca:description>
465             </ca:returnvalue>
466           </ca:returnvalues>
467           <ca:triggeredjsapievents title="JSAPI Triggered Events">
468             <ca:triggeredjsapievent title="">
469               <ca:name></ca:name>
470               <ca:description></ca:description>
471             </ca:triggeredjsapievent>
472           </ca:triggeredjsapievents>
473         </ca:jsfunction>
474       </ca:jsfunctions>
475     </ca:jsfile>
476   </ca:jsfiles>
477   <ca:listenedjsapievents title="JSAPI Listened Events">
478     <ca:listenedjsapievent title="">
479       <ca:name></ca:name>
480       <ca:description></ca:description>
481       <ca:calledfunctions title="Functions Calls">
482         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
483         <ca:calledfunction>
484           <ca:name></ca:name>
485           <ca:description></ca:description>
486         </ca:calledfunction>
487       </ca:calledfunctions>
488     </ca:listenedjsapievent>
489   </ca:listenedjsapievents>
490   <ca:widgetevents title="Widget Events">
491     <ca:widgetevent>
492       <ca:name></ca:name>
493       <ca:parameters title="Parameters">
494         <ca:parameter>
495           <ca:name></ca:name>
496           <ca:type title="Type">
497             <ca:value>string</ca:value>
498           </ca:type>
499           <ca:required title="Required">
500             <ca:value>false</ca:value>
501           </ca:required>
502           <ca:default title="Default">
503             <ca:value></ca:value>
504             <ca:description></ca:description>
505           </ca:default>
506           <ca:possvalues type="list" title="Values">
507             <ca:value></ca:value>
508           </ca:possvalues>
509           <ca:description></ca:description>
510         </ca:parameter>
511       </ca:parameters>
512       <ca:description></ca:description>
513     </ca:widgetevent>
514   </ca:widgetevents>
515   <ca:errors title="Widget Errors">
516     <ca:error title="Error #1">
517       <ca:type title="Type">
518         <ca:value>PHP Mapscript</ca:value>
519       </ca:type>
520       <ca:severity title="Severity">
521         <ca:value>none</ca:value>
522         <ca:description></ca:description>
523       </ca:severity>
524       <ca:message title="Error Message">
525         <ca:paras title="">
526           <ca:para>Error message string....</ca:para>
527         </ca:paras>
528       </ca:message>
529       <ca:meaning title="Interpretation">
530         <ca:paras title="">
531           <ca:para>The description of what the message means......</ca:para>
532         </ca:paras>
533       </ca:meaning>
534       <ca:solution title="Troubleshooting Tips">
535         <ca:paras title="">
536           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
537         </ca:paras>
538       </ca:solution>
539     </ca:error>
540   </ca:errors>
541 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.