Revision Log

MapDHTML.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="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:person>
27	<ca:name>Paul Spencer</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>MapDHTML</ca:value>
36	</ca:name>
37	<ca:chameleonpack>
38	<ca:value>TBD</ca:value>
39	</ca:chameleonpack>
40	<ca:parentgroup>
41	<ca:value>Map Widgets</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 MapDHTML widget is used to display the visualization of the current map image and it also provides many of the mechanisms for other tools and widgets, primarily the navigation tools, to do their jobs.</ca:para>
64	<ca:para>The MapDHTML widget provides direct support for specifying point and rectangular regions on the map but does not use the results directly. If the current tool supports rectangular regions, then you can press the left mouse button over the map and drag in any direction to define your rectangular region. The rectangle that follows the mouse in this case is referred to as the "marquee".</ca:para>
65	</ca:paras>
66	</ca:description>
67	<ca:dependancies>
68	<ca:dependancy type="None" title="None.">
69	<ca:para/>
70	</ca:dependancy>
71	</ca:dependancies>
72	<ca:sharedresources>
73	<ca:paras title="WaitImage">
74	<ca:para>The WaitImage Shared Resource is defined by the MapDHTML widget. The WaitImage Shared Resource is a placeholder for (potentially multilingual) images that are displayed when an application is in the middle of an extended process. Examples of this are when loading the map image in the MapDHTML widget and when the query widget is waiting for the server to process a query. The MapDHTML widget also has a WAITIMAGE attribute that can be used to specify an alternate wait image to be used for the map only. This attribute is not multilingual-capable.</ca:para>
75	</ca:paras>
76	</ca:sharedresources>
77	<ca:embeddedhelp>
78	<ca:paras>
79	<ca:para>This widget displays a map image representing the currently visible layers and selected extents. Interacts with the map image by first selecting a navigation tool, then clicking a point or dragging a region of interest on the map image. For example, the ZoomIn tool allows the user to click a point or define a rectangular region of interest to which the map image then zooms.</ca:para>
80	</ca:paras>
81	</ca:embeddedhelp>
82	</ca:descriptions>
83	<ca:tagstructures>
84	<ca:tagstructure title="Widget Syntax">
85	<ca:description/>
86	<ca:code>
87	<ca:codeblock bold="true">
88	<ca:line><CWC2 TYPE="MapDHTML"</ca:line>
89	</ca:codeblock>
90	<ca:codeblock bold="false">
91	<ca:line> ENABLED="[TRUE\|FALSE]"</ca:line>
92	<ca:line> FORMINDEX="[0 < integer]"</ca:line>
93	<ca:line> VISIBLE="[TRUE\|FALSE]"</ca:line>
94	<ca:line/>
95	<ca:line> <!-- MapDHTML Attributes --></ca:line>
96	<ca:line/>
97	<ca:line> BORDERCOLOR ="[hexcolor]"</ca:line>
98	<ca:line> BORDERWIDTH ="[integer]"</ca:line>
99	<ca:line> HEIGHT="[0 < integer]"</ca:line>
100	<ca:line> WIDTH="[0 < integer]"</ca:line>
101	<ca:line> ALLOWRESIZE="[TRUE\|FALSE]"</ca:line>
102	<ca:line> MARQUEECOLOR="[#RRGGBB]"</ca:line>
103	<ca:line> MARQUEEHORIZONTALIMAGE="[path]"</ca:line>
104	<ca:line> MARQUEEWIDTH="[0 < integer]"</ca:line>
105	<ca:line> MARQUEEVERTICALIMAGE="[path]"</ca:line>
106	<ca:line> MINSCALE="[0 < integer < INF]"</ca:line>
107	<ca:line> MAXSCALE="[0 < integer < INF]"</ca:line>
108	<ca:line> WAITIMAGE="[path]"</ca:line>
109	<ca:line> WAITIMAGEHEIGHT="[0 < integer]"</ca:line>
110	<ca:line> WAITIMAGEWIDTH="[0 < integer]"/></ca:line>
111	</ca:codeblock>
112	</ca:code>
113	</ca:tagstructure>
114	<ca:tagstructure title="Shared Resource Syntax">
115	<ca:description/>
116	<ca:code>
117	<ca:codeblock bold="true">
118	<ca:line><CWC2 TYPE="SharedResource"</ca:line>
119	</ca:codeblock>
120	<ca:codeblock bold="false">
121	<ca:line> ENABLED="[TRUE\|FALSE]"</ca:line>
122	<ca:line> FORMINDEX="[0 < integer]"</ca:line>
123	<ca:line> VISIBLE="[TRUE\|FALSE]"</ca:line>
124	<ca:line/>
125	<ca:line> <!-- Shared Resource Attributes--></ca:line>
126	<ca:line/>
127	</ca:codeblock>
128	<ca:codeblock bold="true">
129	<ca:line> NAME="WaitImage"</ca:line>
130	</ca:codeblock>
131	<ca:codeblock bold="false">
132	<ca:line> ENABLEJS="[TRUE\|FALSE]"></ca:line>
133	<ca:line/>
134	<ca:line> <!-- WaitImage Shared Resource SubTag --></ca:line>
135	<ca:line/>
136	<ca:line> <WAITIMAGE LANGUAGE="[string]"</ca:line>
137	<ca:line> WAITIMAGE="[path]"</ca:line>
138	<ca:line> WAITIMAGEWIDTH="[0 < integer]"</ca:line>
139	<ca:line> WAITIMAGEHEIGHT="[0 < integer]"/></ca:line>
140	</ca:codeblock>
141	<ca:codeblock bold="true">
142	<ca:line></CWC2></ca:line>
143	</ca:codeblock>
144	</ca:code>
145	</ca:tagstructure>
146	</ca:tagstructures>
147	<ca:examples>
148	<ca:widgetexamples>
149	<ca:example title="Example #1: Simple">
150	<ca:description>This following example is the most basic definition of MapDHTML. It displays the map as a 400 x 300 pixel image with all default values.</ca:description>
151	<ca:code>
152	<ca:codeblock bold="false">
153	<ca:line><cwc2 type="MapDHTML"</ca:line>
154	<ca:line> width="400"</ca:line>
155	<ca:line> height="300"/></ca:line>
156	</ca:codeblock>
157	</ca:code>
158	</ca:example>
159	<ca:example title="Example #2: Advanced">
160	<ca:description>The following example shows MapDHTML using the WAITIMAGE attributes. This means that the widget does not use the WaitImage Shared Resource.</ca:description>
161	<ca:code>
162	<ca:codeblock bold="false">
163	<ca:line><cwc2 type="MapDHTML"</ca:line>
164	<ca:line> visible="true"</ca:line>
165	<ca:line> width="400"</ca:line>
166	<ca:line> height="300"</ca:line>
167	<ca:line> allowresize="true"</ca:line>
168	<ca:line> marqueecolor="FF3333"</ca:line>
169	<ca:line> marqueewidth="2"</ca:line>
170	<ca:line> minscale="1"</ca:line>
171	<ca:line> waitimage="http://www.somewhere.xx/images/spinner.gif"</ca:line>
172	<ca:line> waitimagewidth="216"</ca:line>
173	<ca:line> waitimageheight="50"/></ca:line>
174	</ca:codeblock>
175	</ca:code>
176	</ca:example>
177	<ca:example title="Example #3: Advanced">
178	<ca:description>This following example shows a MapDHTML instance that could use the "WaitImage" Shared Resource, since the WAITIMAGE attributes have not been defined in the widget.</ca:description>
179	<ca:code>
180	<ca:codeblock bold="false">
181	<ca:line><cwc2 type="MapDHTML"</ca:line>
182	<ca:line> visible="true"</ca:line>
183	<ca:line> width="400"</ca:line>
184	<ca:line> height="300"</ca:line>
185	<ca:line> allowresize="true"</ca:line>
186	<ca:line> marqueecolor="FF3333"</ca:line>
187	<ca:line> marqueewidth="2"</ca:line>
188	<ca:line> minscale="1"/></ca:line>
189	</ca:codeblock>
190	</ca:code>
191	</ca:example>
192	</ca:widgetexamples>
193	<ca:sharedresourceexamples>
194	<ca:example title="Example #1: Simple">
195	<ca:description>The example below represents the default named "WaitImage" Shared Resource. This Shared Resource holds a list of multilingual images that are displayed when an application is in the middle of an extended process. In this example, the Shared Resource contains English and French wait image attribute sets.</ca:description>
196	<ca:code>
197	<ca:codeblock bold="false">
198	<ca:line><!-- Default style for Wait Images --></ca:line>
199	<ca:line/>
200	<ca:line><cwc2 type="SharedResource" name="WaitImage"></ca:line>
201	<ca:line> <waitimage language="en-CA"</ca:line>
202	<ca:line> waitimage="images/spinner.gif"</ca:line>
203	<ca:line> waitimagewidth="216"</ca:line>
204	<ca:line> waitimageheight="50"/></ca:line>
205	<ca:line> <waitimage language="fr-CA"</ca:line>
206	<ca:line> waitimage="images/spinner_f.gif"</ca:line>
207	<ca:line> waitimagewidth="216"</ca:line>
208	<ca:line> waitimageheight="50"/></ca:line>
209	<ca:line></cwc2></ca:line>
210	</ca:codeblock>
211	</ca:code>
212	</ca:example>
213	</ca:sharedresourceexamples>
214	<ca:sampleapps>
215	<ca:sampleapp>
216	<ca:name>Hawaii Demo</ca:name>
217	<ca:appurl>www.mapsherpa.com/hawaii2/</ca:appurl>
218	<ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
219	</ca:sampleapp>
220	</ca:sampleapps>
221	<ca:scriptexamples/>
222	</ca:examples>
223	<ca:attributegroups>
224	<ca:attributegroup>
225	<ca:name>Base</ca:name>
226	</ca:attributegroup>
227	</ca:attributegroups>
228	<ca:widgettag>
229	<ca:attribute>
230	<ca:name>BORDERCOLOR</ca:name>
231	<ca:type title="Type">
232	<ca:value>hexcolor</ca:value>
233	<ca:description></ca:description>
234	</ca:type>
235	<ca:class title="Class">
236	<ca:value>Widget Only</ca:value>
237	</ca:class>
238	<ca:default title="Default">
239	<ca:value>#000000</ca:value>
240	<ca:description></ca:description>
241	</ca:default>
242	<ca:description>The color to draw a neatline border around the map in. Black by default</ca:description>
243	</ca:attribute>
244	<ca:attribute>
245	<ca:name>BORDERWIDTH</ca:name>
246	<ca:type title="Type">
247	<ca:value>integer</ca:value>
248	<ca:description></ca:description>
249	</ca:type>
250	<ca:class title="Class">
251	<ca:value>Widget Only</ca:value>
252	</ca:class>
253	<ca:default title="Default">
254	<ca:value>1</ca:value>
255	<ca:description></ca:description>
256	</ca:default>
257	<ca:possvalues type="range" title="Value">
258	<ca:minimum>0</ca:minimum>
259	<ca:maximum>2147483647</ca:maximum>
260	</ca:possvalues>
261	<ca:description>The width to draw the neatline border around the map.</ca:description>
262	</ca:attribute>
263	<ca:attribute>
264	<ca:name>ALLOWRESIZE</ca:name>
265	<ca:type>
266	<ca:value>boolean</ca:value>
267	</ca:type>
268	<ca:class>
269	<ca:value>Widget Only</ca:value>
270	</ca:class>
271	<ca:default>
272	<ca:value>false</ca:value>
273	<ca:description/>
274	</ca:default>
275	<ca:possvalues type="list">
276	<ca:value>true</ca:value>
277	<ca:value>false</ca:value>
278	</ca:possvalues>
279	<ca:description>Control the resizability of the map widget. This allows the application to respect or ignore the Window tag in a context document. Note that if you set this to "false", then the map size defined in the map file or Context document, along with the MapSize widget, is ignored.</ca:description>
280	</ca:attribute>
281	<ca:attribute>
282	<ca:name>HEIGHT</ca:name>
283	<ca:type>
284	<ca:value>integer</ca:value>
285	</ca:type>
286	<ca:class>
287	<ca:value>Required</ca:value>
288	</ca:class>
289	<ca:possvalues type="range">
290	<ca:minimum>0</ca:minimum>
291	<ca:maximum>2147483647</ca:maximum>
292	</ca:possvalues>
293	<ca:description>The initial height (in pixels) of the map image. If ALLOWRESIZE is set to "false", then this sets the fixed height of the map image regardless of any other setting.</ca:description>
294	</ca:attribute>
295	<ca:attribute>
296	<ca:name>MARQUEECOLOR</ca:name>
297	<ca:type>
298	<ca:value>hexcolor</ca:value>
299	</ca:type>
300	<ca:class>
301	<ca:value>Widget Only</ca:value>
302	</ca:class>
303	<ca:default>
304	<ca:value>#FF0000</ca:value>
305	<ca:description>RED</ca:description>
306	</ca:default>
307	<ca:description>The color to draw the marquee in.</ca:description>
308	</ca:attribute>
309	<ca:attribute>
310	<ca:name>MARQUEEHORIZONTALIMAGE</ca:name>
311	<ca:type>
312	<ca:value>path</ca:value>
313	</ca:type>
314	<ca:class>
315	<ca:value>Widget Only</ca:value>
316	</ca:class>
317	<ca:default>
318	<ca:value>/chameleon/htdocs/skins/default/images/a_pixel.gif</ca:value>
319	<ca:description/>
320	</ca:default>
321	<ca:description>The image to use for drawing the right and left sides of the marquee. The image is used as a background for the marquee and, as such, only the outermost left and right edges of the image are visible. Used creatively, in combination with the MARQUEEVERTICALIMAGE attribute, this image can create special line effects (e.g., dashed lines).</ca:description>
322	</ca:attribute>
323	<ca:attribute>
324	<ca:name>MARQUEEVERTICALIMAGE</ca:name>
325	<ca:type>
326	<ca:value>path</ca:value>
327	</ca:type>
328	<ca:class>
329	<ca:value>Widget Only</ca:value>
330	</ca:class>
331	<ca:default>
332	<ca:value>/chameleon/htdocs/skins/default/images/a_pixel.gif</ca:value>
333	<ca:description/>
334	</ca:default>
335	<ca:description>The image to use for drawing the top and bottom sides of the marquee. The image is used as a background for the marquee and, as such, only the outermost top and bottom edges of the image are visible. Used creatively, in combination with the MARQUEEHORIZONTALIMAGE attribute, this image can create special line effects (e.g., dashed lines).</ca:description>
336	</ca:attribute>
337	<ca:attribute>
338	<ca:name>MARQUEEWIDTH</ca:name>
339	<ca:type>
340	<ca:value>integer</ca:value>
341	</ca:type>
342	<ca:class>
343	<ca:value>Widget Only</ca:value>
344	</ca:class>
345	<ca:default>
346	<ca:value>1</ca:value>
347	<ca:description/>
348	</ca:default>
349	<ca:possvalues type="range">
350	<ca:minimum>0</ca:minimum>
351	<ca:maximum>2147483647</ca:maximum>
352	</ca:possvalues>
353	<ca:description>When drawing the marquee, this is the width/height (in pixels) to make the edges of the marquee. Values of 1 or 2 are typical.</ca:description>
354	</ca:attribute>
355	<ca:attribute>
356	<ca:name>MAXSCALE</ca:name>
357	<ca:type>
358	<ca:value>float</ca:value>
359	</ca:type>
360	<ca:class>
361	<ca:value>Widget Only</ca:value>
362	</ca:class>
363	<ca:default>
364	<ca:value>1</ca:value>
365	<ca:description>NULL</ca:description>
366	</ca:default>
367	<ca:possvalues type="range">
368	<ca:minimum>0</ca:minimum>
369	<ca:maximum>INF</ca:maximum>
370	</ca:possvalues>
371	<ca:description>The maximum scale to allow when drawing the map. Zooming out beyond this scale is prevented.</ca:description>
372	</ca:attribute>
373	<ca:attribute>
374	<ca:name>MINSCALE</ca:name>
375	<ca:type>
376	<ca:value>float</ca:value>
377	</ca:type>
378	<ca:class>
379	<ca:value>Widget Only</ca:value>
380	</ca:class>
381	<ca:default>
382	<ca:value>-1</ca:value>
383	<ca:description>NULL</ca:description>
384	</ca:default>
385	<ca:possvalues type="range">
386	<ca:minimum>-0</ca:minimum>
387	<ca:maximum>INF</ca:maximum>
388	</ca:possvalues>
389	<ca:description>The minimum scale to allow when drawing the map. Zooming in beyond this scale is prevented.</ca:description>
390	</ca:attribute>
391	<ca:attribute>
392	<ca:name>WAITIMAGE</ca:name>
393	<ca:type>
394	<ca:value>path</ca:value>
395	</ca:type>
396	<ca:class>
397	<ca:value>Widget Only</ca:value>
398	</ca:class>
399	<ca:default>
400	<ca:value>NULL</ca:value>
401	<ca:description/>
402	</ca:default>
403	<ca:description>An image to be displayed while the map image is loading to indicate to the user that something is actually happening. This is equivalent to specifying a WaitImage Shared Resource, and takes precedence over the Shared Resource. Normally, this image is an animated GIF which gives the impression that something is happening.</ca:description>
404	</ca:attribute>
405	<ca:attribute>
406	<ca:name>WAITIMAGEHEIGHT</ca:name>
407	<ca:type>
408	<ca:value>integer</ca:value>
409	</ca:type>
410	<ca:class>
411	<ca:value>Widget Only</ca:value>
412	</ca:class>
413	<ca:default>
414	<ca:value>0</ca:value>
415	<ca:description>NULL</ca:description>
416	</ca:default>
417	<ca:possvalues type="range">
418	<ca:minimum>0</ca:minimum>
419	<ca:maximum>2147483647</ca:maximum>
420	</ca:possvalues>
421	<ca:description>The height (in pixels) of the wait image defined in the WAITIMAGE attribute. This does not need to be specified if the WAITIMAGE attribute is not specified.</ca:description>
422	</ca:attribute>
423	<ca:attribute>
424	<ca:name>WAITIMAGEWIDTH</ca:name>
425	<ca:type>
426	<ca:value>integer</ca:value>
427	</ca:type>
428	<ca:class>
429	<ca:value>Widget Only</ca:value>
430	</ca:class>
431	<ca:default>
432	<ca:value>0</ca:value>
433	<ca:description>NULL</ca:description>
434	</ca:default>
435	<ca:possvalues type="range">
436	<ca:minimum>0</ca:minimum>
437	<ca:maximum>2147483647</ca:maximum>
438	</ca:possvalues>
439	<ca:description>The width (in pixels) of the wait image defined in the WAITIMAGE attribute. This does not need to be specified if the WAITIMAGE attribute is not specified.</ca:description>
440	</ca:attribute>
441	<ca:attribute>
442	<ca:name>WIDTH</ca:name>
443	<ca:type>
444	<ca:value>integer</ca:value>
445	</ca:type>
446	<ca:class>
447	<ca:value>Required</ca:value>
448	</ca:class>
449	<ca:possvalues type="range">
450	<ca:minimum>0</ca:minimum>
451	<ca:maximum>2147483647</ca:maximum>
452	</ca:possvalues>
453	<ca:description>The initial width (in pixels) of the map widget image. If ALLOWRESIZE is set to "false", then this sets the width of the map image regardless of other settings.</ca:description>
454	</ca:attribute>
455	</ca:widgettag>
456	<ca:formelements>
457	<ca:formelement>
458	<ca:name>NAV_INPUT_TYPE</ca:name>
459	<ca:type>
460	<ca:value>String</ca:value>
461	</ca:type>
462	<ca:description>The type of the last navigation command, either POINT or RECTANGLE. This is set by other widgets to indicate whether the current tool accepts rectangular input or not.</ca:description>
463	</ca:formelement>
464	<ca:formelement>
465	<ca:name>NAV_INPUT_COORDINATES</ca:name>
466	<ca:type>
467	<ca:value>String</ca:value>
468	</ca:type>
469	<ca:description>The coordinates that the last command generated. May be a single point or two points representing a rectangle. The coordinates are contained in a single comma-separated string. This is set by the MapDHTML widget when the user releases the left mouse button over the map image.</ca:description>
470	</ca:formelement>
471	<ca:formelement>
472	<ca:name>NAV_INPUT_SUBMIT</ca:name>
473	<ca:type>
474	<ca:value>Boolean</ca:value>
475	</ca:type>
476	<ca:description>Set by navigation tools to indicate if the MapDHTML widget should submit the page as soon as navigation is complete. In some cases, the page is not submitted. For instance, the Query widget normally launches a popup window to display the query results, avoiding a redraw of the entire page.</ca:description>
477	</ca:formelement>
478	<ca:formelement>
479	<ca:name>MAP_EXTENTS_MINX</ca:name>
480	<ca:type>
481	<ca:value>Float</ca:value>
482	</ca:type>
483	<ca:description>The minimum X extents value of the map in geographic coordinates</ca:description>
484	</ca:formelement>
485	<ca:formelement>
486	<ca:name>MAP_EXTENTS_MINY</ca:name>
487	<ca:type>
488	<ca:value>Float</ca:value>
489	</ca:type>
490	<ca:description>The minimum Y extents value of the map in geographic coordinates</ca:description>
491	</ca:formelement>
492	<ca:formelement>
493	<ca:name>MAP_EXTENTS_MAXX</ca:name>
494	<ca:type>
495	<ca:value>Float</ca:value>
496	</ca:type>
497	<ca:description>The maximum X extents value of the map in geographic coordinates</ca:description>
498	</ca:formelement>
499	<ca:formelement>
500	<ca:name>MAP_EXTENTS_MAXY</ca:name>
501	<ca:type>
502	<ca:value>Float</ca:value>
503	</ca:type>
504	<ca:description>The maximum Y extents value of the map in geographic coordinates</ca:description>
505	</ca:formelement>
506	<ca:formelement>
507	<ca:name>MAP_WIDTH</ca:name>
508	<ca:type>
509	<ca:value>Integer</ca:value>
510	</ca:type>
511	<ca:description>The width (in pixels) of the map window.</ca:description>
512	</ca:formelement>
513	<ca:formelement>
514	<ca:name>MAP_HEIGHT</ca:name>
515	<ca:type>
516	<ca:value>Integer</ca:value>
517	</ca:type>
518	<ca:description>The height (in pixels) of the map window.</ca:description>
519	</ca:formelement>
520	<ca:formelement>
521	<ca:name>MAP_CURSOR_POS_X</ca:name>
522	<ca:type>
523	<ca:value>Integer</ca:value>
524	</ca:type>
525	<ca:description>The current X position of the cursor over the map. This is maintained by the MapDHTML widget and can be used by other widgets (e.g., CursorPos).</ca:description>
526	</ca:formelement>
527	<ca:formelement>
528	<ca:name>MAP_CURSOR_POS_Y</ca:name>
529	<ca:type>
530	<ca:value>Integer</ca:value>
531	</ca:type>
532	<ca:description>The current Y position of the cursor over the map. This is maintained by the MapDHTML widget and can be used by other widgets (e.g., CursorPos).</ca:description>
533	</ca:formelement>
534	<ca:formelement>
535	<ca:name>NAV_CMD</ca:name>
536	<ca:type>
537	<ca:value>String</ca:value>
538	</ca:type>
539	<ca:description>The last command that was used to interact with the map. This is not set or changed by the MapDHTML widget</ca:description>
540	</ca:formelement>
541	<ca:formelement>
542	<ca:name>MAP_ORIGINAL_EXTENTS</ca:name>
543	<ca:type>
544	<ca:value>String</ca:value>
545	</ca:type>
546	<ca:description>Original extents of the map in the map file, when the application was first loaded. The extent are in a comma-separated string.</ca:description>
547	</ca:formelement>
548	<ca:formelement>
549	<ca:name>MAP_ORIGINAL_PROJ</ca:name>
550	<ca:type>
551	<ca:value>String</ca:value>
552	</ca:type>
553	<ca:description>String representing the original projection of the map when it was first loaded.</ca:description>
554	</ca:formelement>
555	<ca:formelement>
556	<ca:name>CURSOR_TYPE</ca:name>
557	<ca:type>
558	<ca:value>String</ca:value>
559	</ca:type>
560	<ca:description>Type of the cursor to be used by the navigation tools. This is not set by the MapDHTML widget, but it is used by the MapDHTML widget to change the cursor when the mouse is moved over the map image.</ca:description>
561	</ca:formelement>
562	</ca:formelements>
563
564
565	<ca:jsvariables>
566	<ca:jsvariable>
567	<ca:name>gCWCJSAPI</ca:name>
568	<ca:type>
569	<ca:value>float</ca:value>
570	</ca:type>
571	<ca:scope>
572	<ca:value>Private</ca:value>
573	</ca:scope>
574	<ca:default>
575	<ca:value>0</ca:value>
576	<ca:description/>
577	</ca:default>
578	<ca:description>Indicates if the page is in CWCJSAPI mode.</ca:description>
579	</ca:jsvariable>
580
581	<ca:jsvariable>
582	<ca:name>gAPixel</ca:name>
583	<ca:type>
584	<ca:value>string</ca:value>
585	</ca:type>
586	<ca:scope>
587	<ca:value>Private</ca:value>
588	</ca:scope>
589	<ca:default>
590	<ca:value>http://localhost/chameleon/htdocs//skins/default/images/a_pixel.gif</ca:value>
591	<ca:description/>
592	</ca:default>
593	<ca:description>Many widgets, including MapDHTML, use a single pixel transparent image to provide spacing and layout control. This is the URL for this image.</ca:description>
594	</ca:jsvariable>
595
596	<ca:jsvariable>
597	<ca:name>gMapWiWidth</ca:name>
598	<ca:type>
599	<ca:value>float</ca:value>
600	</ca:type>
601	<ca:scope>
602	<ca:value>Private</ca:value>
603	</ca:scope>
604	<ca:default>
605	<ca:value/>
606	<ca:description/>
607	</ca:default>
608	<ca:description>The width of the map window (in pixels), equivalent to the MAP_WIDTH form variable.</ca:description>
609	</ca:jsvariable>
610
611	<ca:jsvariable>
612	<ca:name>gMapWiHeight</ca:name>
613	<ca:type>
614	<ca:value>float</ca:value>
615	</ca:type>
616	<ca:scope>
617	<ca:value>Private</ca:value>
618	</ca:scope>
619	<ca:default>
620	<ca:value/>
621	<ca:description/>
622	</ca:default>
623	<ca:description>the height of the map widget window (in pixels), equivalent to the MAP_HEIGHT form variable.</ca:description>
624	</ca:jsvariable>
625
626	<ca:jsvariable>
627	<ca:name>gMapDHTMLWaitImage</ca:name>
628	<ca:type>
629	<ca:value>string</ca:value>
630	</ca:type>
631	<ca:scope>
632	<ca:value>Private</ca:value>
633	</ca:scope>
634	<ca:default>
635	<ca:value>http://localhost/chameleon/htdocs//skins/default/images/a_pixel.gif</ca:value>
636	<ca:description/>
637	</ca:default>
638	<ca:description>Web path to the wait image. See the WAITIMAGE attribute.</ca:description>
639	</ca:jsvariable>
640
641	<ca:jsvariable>
642	<ca:name>gMapDHTMLWaitImageWidth</ca:name>
643	<ca:type>
644	<ca:value>float</ca:value>
645	</ca:type>
646	<ca:scope>
647	<ca:value>Private</ca:value>
648	</ca:scope>
649	<ca:default>
650	<ca:value>1</ca:value>
651	<ca:description/>
652	</ca:default>
653	<ca:description>The width of the wait image</ca:description>
654	</ca:jsvariable>
655
656	<ca:jsvariable>
657	<ca:name>gMapDHTMLWaitImageHeight</ca:name>
658	<ca:type>
659	<ca:value>float</ca:value>
660	</ca:type>
661	<ca:scope>
662	<ca:value>Private</ca:value>
663	</ca:scope>
664	<ca:default>
665	<ca:value>1</ca:value>
666	<ca:description>The height of the wait image</ca:description>
667	</ca:default>
668
669	</ca:jsvariable>
670
671	<ca:jsvariable>
672	<ca:name>gMapDHTMLVerticalMarquee</ca:name>
673	<ca:type>
674	<ca:value>string</ca:value>
675	</ca:type>
676	<ca:scope>
677	<ca:value>Private</ca:value>
678	</ca:scope>
679	<ca:default>
680	<ca:value>http://localhost/chameleon/htdocs//skins/default/images/a_pixel.gif</ca:value>
681	<ca:description>Web path to the vertical marquee image. See the MARQUEEVERTICALIMAGE attribute.</ca:description>
682	</ca:default>
683	<ca:description/>
684	</ca:jsvariable>
685	<ca:jsvariable>
686	<ca:name>gMapDHTMLHorizontalMarquee</ca:name>
687	<ca:type>
688	<ca:value>string</ca:value>
689	</ca:type>
690	<ca:scope>
691	<ca:value>Private</ca:value>
692	</ca:scope>
693	<ca:default>
694	<ca:value>http://localhost/chameleon/htdocs//skins/default/images/a_pixel.gif</ca:value>
695	<ca:description/>
696	</ca:default>
697	<ca:description>Web path to the horizontal marquee image. See the MARQUEEHORIZONTALIMAGE attribute.</ca:description>
698	</ca:jsvariable>
699	<ca:jsvariable>
700	<ca:name>gMapDHTMLMarqueeWidth</ca:name>
701	<ca:type>
702	<ca:value>float</ca:value>
703	</ca:type>
704	<ca:scope>
705	<ca:value>Private</ca:value>
706	</ca:scope>
707	<ca:default>
708	<ca:value>1</ca:value>
709	<ca:description/>
710	</ca:default>
711	<ca:description>Width of the marquee image. See the MARQUEEWIDTH attribute.</ca:description>
712	</ca:jsvariable>
713	<ca:jsvariable>
714	<ca:name>gMapDHTMLMarqueeColor</ca:name>
715	<ca:type>
716	<ca:value>string</ca:value>
717	</ca:type>
718	<ca:scope>
719	<ca:value>Private</ca:value>
720	</ca:scope>
721	<ca:default>
722	<ca:value>RED</ca:value>
723	<ca:description/>
724	</ca:default>
725	<ca:description>Color of the marquee image. See the MARQUEECOLOR attribute.</ca:description>
726	</ca:jsvariable>
727	<ca:jsvariable>
728	<ca:name>gMapDHTMLURL</ca:name>
729	<ca:type>
730	<ca:value>string</ca:value>
731	</ca:type>
732	<ca:scope>
733	<ca:value>Private</ca:value>
734	</ca:scope>
735	<ca:default>
736	<ca:value>/chameleon/htdocs//common//wrapper/drawmap.php</ca:value>
737	<ca:description/>
738	</ca:default>
739	<ca:description>Web path to the drawmap.php script that draws the actual map.</ca:description>
740	</ca:jsvariable>
741	<ca:jsvariable>
742	<ca:name>gMapDHTMLAllowResize</ca:name>
743	<ca:type>
744	<ca:value>float</ca:value>
745	</ca:type>
746	<ca:scope>
747	<ca:value>Private</ca:value>
748	</ca:scope>
749	<ca:default>
750	<ca:value>1</ca:value>
751	<ca:description/>
752	</ca:default>
753	<ca:description>Contains the value of the ALLOWRESIZE attribute.</ca:description>
754	</ca:jsvariable>
755	</ca:jsvariables>
756	<ca:jsfiles title="JavaScript Files" >
757	<ca:jsfile >
758	<ca:name>cwc_dhtml.js</ca:name>
759	<ca:description>DHTML utilities for Chameleon widgets.</ca:description>
760	<ca:jsvariables/>
761	<ca:jsfunctions/>
762	</ca:jsfile>
763	<ca:jsfile >
764	<ca:name>MapDHTML.js</ca:name>
765	<ca:description>MapDHTML widget-specific utilities. All JavaScript code of the MapDHTML widget has been moved to this file.</ca:description>
766	<ca:jsvariables/>
767	<ca:jsfunctions/>
768	</ca:jsfile>
769	</ca:jsfiles>
770	</ca:widgetdoc>

Note: See TracBrowser for help on using the browser.

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

Download in other formats: