← Back to branch summary

~jstys-z/helioviewer.org/client5

« back to all changes in this revision

Viewing changes to docs/symbols/Layer.html

  • Committer: V. Keith Hughitt
  • Date: 2009-04-01 21:08:05 UTC
  • Revision ID: hughitt1@kore-20090401210805-372f7dgih07vxk42
nightly build 04-01-2009

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/symbols/Layer.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
2
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
3
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
4
        <head>
 
5
                <meta http-equiv="content-type" content="text/html; charset=utf-8" />
 
6
                <meta name="generator" content="JsDoc Toolkit" />
 
7
                
 
8
                <title>JsDoc Reference - Layer</title>
 
9
 
 
10
                <style type="text/css">
 
11
                        /* default.css */
 
12
body
 
13
{
 
14
        font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
 
15
        width: 800px;
 
16
}
 
17
 
 
18
.header
 
19
{
 
20
        clear: both;
 
21
        background-color: #ccc;
 
22
        padding: 8px;
 
23
}
 
24
 
 
25
h1
 
26
{
 
27
        font-size: 150%;
 
28
        font-weight: bold;
 
29
        padding: 0;
 
30
        margin: 1em 0 0 .3em;
 
31
}
 
32
 
 
33
hr
 
34
{
 
35
        border: none 0;
 
36
        border-top: 1px solid #7F8FB1;
 
37
        height: 1px;
 
38
}
 
39
 
 
40
pre.code
 
41
{
 
42
        display: block;
 
43
        padding: 8px;
 
44
        border: 1px dashed #ccc;
 
45
}
 
46
 
 
47
#index
 
48
{
 
49
        margin-top: 24px;
 
50
        float: left;
 
51
        width: 160px;
 
52
        position: absolute;
 
53
        left: 8px;
 
54
        background-color: #F3F3F3;
 
55
        padding: 8px;
 
56
}
 
57
 
 
58
#content
 
59
{
 
60
        margin-left: 190px;
 
61
        width: 600px;
 
62
}
 
63
 
 
64
.classList
 
65
{
 
66
        list-style-type: none;
 
67
        padding: 0;
 
68
        margin: 0 0 0 8px;
 
69
        font-family: arial, sans-serif;
 
70
        font-size: 1em;
 
71
        overflow: auto;
 
72
}
 
73
 
 
74
.classList li
 
75
{
 
76
        padding: 0;
 
77
        margin: 0 0 8px 0;
 
78
}
 
79
 
 
80
.summaryTable { width: 100%; }
 
81
 
 
82
h1.classTitle
 
83
{
 
84
        font-size:170%;
 
85
        line-height:130%;
 
86
}
 
87
 
 
88
h2 { font-size: 110%; }
 
89
caption, div.sectionTitle
 
90
{
 
91
        background-color: #7F8FB1;
 
92
        color: #fff;
 
93
        font-size:130%;
 
94
        text-align: left;
 
95
        padding: 2px 6px 2px 6px;
 
96
        border: 1px #7F8FB1 solid;
 
97
}
 
98
 
 
99
div.sectionTitle { margin-bottom: 8px; }
 
100
.summaryTable thead { display: none; }
 
101
 
 
102
.summaryTable td
 
103
{
 
104
        vertical-align: top;
 
105
        padding: 4px;
 
106
        border-bottom: 1px #7F8FB1 solid;
 
107
        border-right: 1px #7F8FB1 solid;
 
108
}
 
109
 
 
110
/*col#summaryAttributes {}*/
 
111
.summaryTable td.attributes
 
112
{
 
113
        border-left: 1px #7F8FB1 solid;
 
114
        width: 140px;
 
115
        text-align: right;
 
116
}
 
117
 
 
118
td.attributes, .fixedFont
 
119
{
 
120
        line-height: 15px;
 
121
        color: #002EBE;
 
122
        font-family: "Courier New",Courier,monospace;
 
123
        font-size: 13px;
 
124
}
 
125
 
 
126
.summaryTable td.nameDescription
 
127
{
 
128
        text-align: left;
 
129
        font-size: 13px;
 
130
        line-height: 15px;
 
131
}
 
132
 
 
133
.summaryTable td.nameDescription, .description
 
134
{
 
135
        line-height: 15px;
 
136
        padding: 4px;
 
137
        padding-left: 4px;
 
138
}
 
139
 
 
140
.summaryTable { margin-bottom: 8px; }
 
141
 
 
142
ul.inheritsList
 
143
{
 
144
        list-style: square;
 
145
        margin-left: 20px;
 
146
        padding-left: 0;
 
147
}
 
148
 
 
149
.detailList {
 
150
        margin-left: 20px; 
 
151
        line-height: 15px;
 
152
}
 
153
.detailList dt { margin-left: 20px; }
 
154
 
 
155
.detailList .heading
 
156
{
 
157
        font-weight: bold;
 
158
        padding-bottom: 6px;
 
159
        margin-left: 0;
 
160
}
 
161
 
 
162
.light, td.attributes, .light a:link, .light a:visited
 
163
{
 
164
        color: #777;
 
165
        font-style: italic;
 
166
}
 
167
 
 
168
.fineprint
 
169
{
 
170
        text-align: right;
 
171
        font-size: 10px;
 
172
}
 
173
                </style>
 
174
        </head>
 
175
 
 
176
        <body>
 
177
<!-- ============================== header ================================= -->        
 
178
                <!-- begin static/header.html -->
 
179
                <div id="header">
 
180
</div>
 
181
                <!-- end static/header.html -->
 
182
 
 
183
<!-- ============================== classes index ============================ -->
 
184
                <div id="index">
 
185
                        <!-- begin publish.classesIndex -->
 
186
                        <div align="center"><a href="../index.html">Class Index</a>
 
187
| <a href="../files.html">File Index</a></div>
 
188
<hr />
 
189
<h2>Classes</h2>
 
190
<ul class="classList">
 
191
        
 
192
        <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
 
193
        
 
194
        <li><a href="../symbols/Calendar.html">Calendar</a></li>
 
195
        
 
196
        <li><a href="../symbols/Date.html">Date</a></li>
 
197
        
 
198
        <li><a href="../symbols/EventLayer.html">EventLayer</a></li>
 
199
        
 
200
        <li><a href="../symbols/EventLayerAccordion.html">EventLayerAccordion</a></li>
 
201
        
 
202
        <li><a href="../symbols/EventMarker.html">EventMarker</a></li>
 
203
        
 
204
        <li><a href="../symbols/EventTimeline.html">EventTimeline</a></li>
 
205
        
 
206
        <li><a href="../symbols/Helioviewer.html">Helioviewer</a></li>
 
207
        
 
208
        <li><a href="../symbols/Helioviewer%23handlers.html">Helioviewer#handlers</a></li>
 
209
        
 
210
        <li><a href="../symbols/IconPicker.html">IconPicker</a></li>
 
211
        
 
212
        <li><a href="../symbols/Layer.html">Layer</a></li>
 
213
        
 
214
        <li><a href="../symbols/LayerManager.html">LayerManager</a></li>
 
215
        
 
216
        <li><a href="../symbols/LoadingIndicator.html">LoadingIndicator</a></li>
 
217
        
 
218
        <li><a href="../symbols/Math.html">Math</a></li>
 
219
        
 
220
        <li><a href="../symbols/MessageConsole.html">MessageConsole</a></li>
 
221
        
 
222
        <li><a href="../symbols/MovieBuilder.html">MovieBuilder</a></li>
 
223
        
 
224
        <li><a href="../symbols/String.html">String</a></li>
 
225
        
 
226
        <li><a href="../symbols/TileLayer.html">TileLayer</a></li>
 
227
        
 
228
        <li><a href="../symbols/TileLayerAccordion.html">TileLayerAccordion</a></li>
 
229
        
 
230
        <li><a href="../symbols/TimeControls.html">TimeControls</a></li>
 
231
        
 
232
        <li><a href="../symbols/UIElement.html">UIElement</a></li>
 
233
        
 
234
        <li><a href="../symbols/UserSettings.html">UserSettings</a></li>
 
235
        
 
236
        <li><a href="../symbols/Viewport.html">Viewport</a></li>
 
237
        
 
238
        <li><a href="../symbols/ViewportHandlers.html">ViewportHandlers</a></li>
 
239
        
 
240
        <li><a href="../symbols/ZoomControl.html">ZoomControl</a></li>
 
241
        
 
242
</ul>
 
243
<hr />
 
244
                        <!-- end publish.classesIndex -->
 
245
                </div>
 
246
                
 
247
                <div id="content">
 
248
<!-- ============================== class title ============================ -->
 
249
                        <h1 class="classTitle">
 
250
                                
 
251
                                Class Layer
 
252
                        </h1>
 
253
 
 
254
<!-- ============================== class summary ========================== -->                        
 
255
                        <p class="description">
 
256
                                
 
257
                        
 
258
                                
 
259
                                
 
260
                                
 
261
                                        <br /><i>Defined in: </i> <a href="../symbols/src/lib_helioviewer_Layer.js.html">Layer.js</a>.
 
262
                                
 
263
                        </p>
 
264
 
 
265
<!-- ============================== constructor summary ==================== -->                        
 
266
                        
 
267
                        <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Layer.">
 
268
                                <caption>Class Summary</caption>
 
269
                                <thead>
 
270
                                        <tr>
 
271
                                                <th scope="col">Constructor Attributes</th>
 
272
                                                <th scope="col">Constructor Name and Description</th>
 
273
                                        </tr>
 
274
                                </thead>
 
275
                                <tbody>
 
276
                                        <tr>
 
277
                                                <td class="attributes">&nbsp;</td>
 
278
                                                <td class="nameDescription" >
 
279
                                                        <div class="fixedFont">
 
280
                                                                <b><a href="../symbols/Layer.html">Layer</a></b>(viewport)
 
281
                                                        </div>
 
282
                                                        <div class="description">Creates a new Layer</div>
 
283
                                                </td>
 
284
                                        </tr>
 
285
                                </tbody>
 
286
                        </table>
 
287
                        
 
288
 
 
289
<!-- ============================== properties summary ===================== -->
 
290
                        
 
291
 
 
292
<!-- ============================== methods summary ======================== -->
 
293
                        
 
294
                                
 
295
                                
 
296
                                <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Layer.">
 
297
                                        <caption>Method Summary</caption>
 
298
                                        <thead>
 
299
                                                <tr>
 
300
                                                        <th scope="col">Method Attributes</th>
 
301
                                                        <th scope="col">Method Name and Description</th>
 
302
                                                </tr>
 
303
                                        </thead>
 
304
                                        <tbody>
 
305
                                        
 
306
                                                <tr>
 
307
                                                        <td class="attributes">&nbsp;</td>
 
308
                                                        <td class="nameDescription">
 
309
                                                                <div class="fixedFont"><b><a href="../symbols/Layer.html#setVisible">setVisible</a></b>(visible)
 
310
                                                                </div>
 
311
                                                                <div class="description">Sets the Layer's visibility</div>
 
312
                                                        </td>
 
313
                                                </tr>
 
314
                                        
 
315
                                                <tr>
 
316
                                                        <td class="attributes">&nbsp;</td>
 
317
                                                        <td class="nameDescription">
 
318
                                                                <div class="fixedFont"><b><a href="../symbols/Layer.html#setZIndex">setZIndex</a></b>(val)
 
319
                                                                </div>
 
320
                                                                <div class="description">Adjust the Layer's z-index</div>
 
321
                                                        </td>
 
322
                                                </tr>
 
323
                                        
 
324
                                                <tr>
 
325
                                                        <td class="attributes">&nbsp;</td>
 
326
                                                        <td class="nameDescription">
 
327
                                                                <div class="fixedFont"><b><a href="../symbols/Layer.html#toggleVisible">toggleVisible</a></b>()
 
328
                                                                </div>
 
329
                                                                <div class="description">Toggle layer visibility</div>
 
330
                                                        </td>
 
331
                                                </tr>
 
332
                                        
 
333
                                        </tbody>
 
334
                                </table>
 
335
                                
 
336
                                
 
337
                                
 
338
                        
 
339
<!-- ============================== events summary ======================== -->
 
340
                        
 
341
 
 
342
<!-- ============================== constructor details ==================== -->                
 
343
                        
 
344
                        <div class="details"><a name="constructor"> </a>
 
345
                                <div class="sectionTitle">
 
346
                                        Class Detail
 
347
                                </div>
 
348
                                
 
349
                                <div class="fixedFont">
 
350
                                                <b>Layer</b>(viewport)
 
351
                                </div>
 
352
                                
 
353
                                <div class="description">
 
354
                                        Creates a new Layer
 
355
                                        
 
356
                                </div>
 
357
                                
 
358
                                
 
359
                                
 
360
                                
 
361
                                        
 
362
                                                <dl class="detailList">
 
363
                                                <dt class="heading">Parameters:</dt>
 
364
                                                
 
365
                                                        <dt>
 
366
                                                                <span class="light fixedFont">{Object}</span>  <b>viewport</b>
 
367
                                                                
 
368
                                                        </dt>
 
369
                                                                <dd>Viewport to place the layer in
 
370
<br>
 
371
<br><div style='font-size:16px'>Options:</div><br>
 
372
<div style='margin-left:15px'>
 
373
                <b>maxZoomLevel</b>     -  Maximum zoom level supported by the layer<br>
 
374
     <b>minZoomLevel</b>        - Minimum zoom level supported by the layer<br>
 
375
                <b>visible</b> - The default layer visibility<br>
 
376
</div></dd>
 
377
                                                
 
378
                                                </dl>
 
379
                                        
 
380
                                        
 
381
                                        
 
382
                                        
 
383
                                        
 
384
                                        
 
385
                                        
 
386
 
 
387
                        </div>
 
388
                        
 
389
 
 
390
<!-- ============================== field details ========================== -->                
 
391
                        
 
392
 
 
393
<!-- ============================== method details ========================= -->                
 
394
                        
 
395
                                <div class="sectionTitle">
 
396
                                        Method Detail
 
397
                                </div>
 
398
                                
 
399
                                        <a name="setVisible"> </a>
 
400
                                        <div class="fixedFont">
 
401
                                        
 
402
                                        <span class="light">{Boolean}</span>
 
403
                                        <b>setVisible</b>(visible)
 
404
                                        
 
405
                                        </div>
 
406
                                        <div class="description">
 
407
                                                Sets the Layer's visibility
 
408
                                                
 
409
                                                
 
410
                                        </div>
 
411
                                        
 
412
                                        
 
413
                                        
 
414
                                                
 
415
                                                        <dl class="detailList">
 
416
                                                        <dt class="heading">Parameters:</dt>
 
417
                                                        
 
418
                                                                <dt>
 
419
                                                                        <span class="light fixedFont">{Boolean}</span> <b>visible</b>
 
420
                                                                        
 
421
                                                                </dt>
 
422
                                                                <dd>Hide/Show layer</dd>
 
423
                                                        
 
424
                                                        </dl>
 
425
                                                
 
426
                                                
 
427
                                                
 
428
                                                
 
429
                                                
 
430
                                                        <dl class="detailList">
 
431
                                                        <dt class="heading">Returns:</dt>
 
432
                                                        
 
433
                                                                <dd><span class="light fixedFont">{Boolean}</span> Returns new setting</dd>
 
434
                                                        
 
435
                                                        </dl>
 
436
                                                
 
437
                                                
 
438
                                                
 
439
 
 
440
                                        <hr />
 
441
                                
 
442
                                        <a name="setZIndex"> </a>
 
443
                                        <div class="fixedFont">
 
444
                                        
 
445
                                        
 
446
                                        <b>setZIndex</b>(val)
 
447
                                        
 
448
                                        </div>
 
449
                                        <div class="description">
 
450
                                                Adjust the Layer's z-index
 
451
                                                
 
452
                                                
 
453
                                        </div>
 
454
                                        
 
455
                                        
 
456
                                        
 
457
                                                
 
458
                                                        <dl class="detailList">
 
459
                                                        <dt class="heading">Parameters:</dt>
 
460
                                                        
 
461
                                                                <dt>
 
462
                                                                        <span class="light fixedFont">{Object}</span> <b>val</b>
 
463
                                                                        
 
464
                                                                </dt>
 
465
                                                                <dd>Z-index to use</dd>
 
466
                                                        
 
467
                                                        </dl>
 
468
                                                
 
469
                                                
 
470
                                                
 
471
                                                
 
472
                                                
 
473
                                                
 
474
                                                
 
475
 
 
476
                                        <hr />
 
477
                                
 
478
                                        <a name="toggleVisible"> </a>
 
479
                                        <div class="fixedFont">
 
480
                                        
 
481
                                        
 
482
                                        <b>toggleVisible</b>()
 
483
                                        
 
484
                                        </div>
 
485
                                        <div class="description">
 
486
                                                Toggle layer visibility
 
487
                                                
 
488
                                                
 
489
                                        </div>
 
490
                                        
 
491
                                        
 
492
                                        
 
493
                                                
 
494
                                                
 
495
                                                
 
496
                                                
 
497
                                                
 
498
                                                
 
499
                                                
 
500
 
 
501
                                        
 
502
                                
 
503
                        
 
504
                        
 
505
<!-- ============================== event details ========================= -->         
 
506
                        
 
507
                        
 
508
                        <hr />
 
509
                </div>
 
510
 
 
511
                
 
512
<!-- ============================== footer ================================= -->
 
513
                <div class="fineprint" style="clear:both">
 
514
                        
 
515
                        Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Wed Feb 25 2009 14:47:29 GMT-0500 (EST)
 
516
                </div>
 
517
        </body>
 
518
</html>