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">
5
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
6
<meta name="generator" content="JsDoc Toolkit" />
8
<title>JsDoc Reference - EventLayer</title>
10
<style type="text/css">
14
font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
21
background-color: #ccc;
36
border-top: 1px solid #7F8FB1;
44
border: 1px dashed #ccc;
54
background-color: #F3F3F3;
66
list-style-type: none;
69
font-family: arial, sans-serif;
80
.summaryTable { width: 100%; }
88
h2 { font-size: 110%; }
89
caption, div.sectionTitle
91
background-color: #7F8FB1;
95
padding: 2px 6px 2px 6px;
96
border: 1px #7F8FB1 solid;
99
div.sectionTitle { margin-bottom: 8px; }
100
.summaryTable thead { display: none; }
106
border-bottom: 1px #7F8FB1 solid;
107
border-right: 1px #7F8FB1 solid;
110
/*col#summaryAttributes {}*/
111
.summaryTable td.attributes
113
border-left: 1px #7F8FB1 solid;
118
td.attributes, .fixedFont
122
font-family: "Courier New",Courier,monospace;
126
.summaryTable td.nameDescription
133
.summaryTable td.nameDescription, .description
140
.summaryTable { margin-bottom: 8px; }
153
.detailList dt { margin-left: 20px; }
162
.light, td.attributes, .light a:link, .light a:visited
177
<!-- ============================== header ================================= -->
178
<!-- begin static/header.html -->
181
<!-- end static/header.html -->
183
<!-- ============================== classes 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>
190
<ul class="classList">
192
<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
194
<li><a href="../symbols/Calendar.html">Calendar</a></li>
196
<li><a href="../symbols/Date.html">Date</a></li>
198
<li><a href="../symbols/EventLayer.html">EventLayer</a></li>
200
<li><a href="../symbols/EventLayerAccordion.html">EventLayerAccordion</a></li>
202
<li><a href="../symbols/EventMarker.html">EventMarker</a></li>
204
<li><a href="../symbols/EventTimeline.html">EventTimeline</a></li>
206
<li><a href="../symbols/Helioviewer.html">Helioviewer</a></li>
208
<li><a href="../symbols/Helioviewer%23handlers.html">Helioviewer#handlers</a></li>
210
<li><a href="../symbols/IconPicker.html">IconPicker</a></li>
212
<li><a href="../symbols/Layer.html">Layer</a></li>
214
<li><a href="../symbols/LayerManager.html">LayerManager</a></li>
216
<li><a href="../symbols/LoadingIndicator.html">LoadingIndicator</a></li>
218
<li><a href="../symbols/Math.html">Math</a></li>
220
<li><a href="../symbols/MessageConsole.html">MessageConsole</a></li>
222
<li><a href="../symbols/MovieBuilder.html">MovieBuilder</a></li>
224
<li><a href="../symbols/String.html">String</a></li>
226
<li><a href="../symbols/TileLayer.html">TileLayer</a></li>
228
<li><a href="../symbols/TileLayerAccordion.html">TileLayerAccordion</a></li>
230
<li><a href="../symbols/TimeControls.html">TimeControls</a></li>
232
<li><a href="../symbols/UIElement.html">UIElement</a></li>
234
<li><a href="../symbols/UserSettings.html">UserSettings</a></li>
236
<li><a href="../symbols/Viewport.html">Viewport</a></li>
238
<li><a href="../symbols/ViewportHandlers.html">ViewportHandlers</a></li>
240
<li><a href="../symbols/ZoomControl.html">ZoomControl</a></li>
244
<!-- end publish.classesIndex -->
248
<!-- ============================== class title ============================ -->
249
<h1 class="classTitle">
254
<!-- ============================== class summary ========================== -->
255
<p class="description">
261
<br /><i>Defined in: </i> <a href="../symbols/src/lib_helioviewer_EventLayer.js.html">EventLayer.js</a>.
265
<!-- ============================== constructor summary ==================== -->
267
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class EventLayer.">
268
<caption>Class Summary</caption>
271
<th scope="col">Constructor Attributes</th>
272
<th scope="col">Constructor Name and Description</th>
277
<td class="attributes"> </td>
278
<td class="nameDescription" >
279
<div class="fixedFont">
280
<b><a href="../symbols/EventLayer.html">EventLayer</a></b>(viewport, options)
282
<div class="description">Creates a new EventLayer.</div>
289
<!-- ============================== properties summary ===================== -->
293
<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class EventLayer.">
294
<caption>Field Summary</caption>
297
<th scope="col">Field Attributes</th>
298
<th scope="col">Field Name and Description</th>
304
<td class="attributes"> </td>
305
<td class="nameDescription">
306
<div class="fixedFont">
307
<b><a href="../symbols/EventLayer.html#defaultOptions">defaultOptions</a></b>
309
<div class="description">Default EventLayer options<br><br>
310
<strong>Notes:</strong><br><br>
311
"sunRadius0" refers to the Sun's radius at zoom-level 0, in pixels = 94 * 2^12.</div>
322
<!-- ============================== methods summary ======================== -->
326
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class EventLayer.">
327
<caption>Method Summary</caption>
330
<th scope="col">Method Attributes</th>
331
<th scope="col">Method Name and Description</th>
337
<td class="attributes"> </td>
338
<td class="nameDescription">
339
<div class="fixedFont"><b><a href="../symbols/EventLayer.html#clear">clear</a></b>()
341
<div class="description">Removes all events from the screen and clears event container</div>
346
<td class="attributes"> </td>
347
<td class="nameDescription">
348
<div class="fixedFont"><b><a href="../symbols/EventLayer.html#displayEvents">displayEvents</a></b>(jsonEvents)
350
<div class="description">Draws events to screen</div>
355
<td class="attributes"> </td>
356
<td class="nameDescription">
357
<div class="fixedFont"><b><a href="../symbols/EventLayer.html#queryEvents">queryEvents</a></b>()
359
<div class="description">Sends an AJAX request to get a list of events.</div>
364
<td class="attributes"> </td>
365
<td class="nameDescription">
366
<div class="fixedFont"><b><a href="../symbols/EventLayer.html#reload">reload</a></b>()
368
<div class="description">Reload event-layer</div>
373
<td class="attributes"> </td>
374
<td class="nameDescription">
375
<div class="fixedFont"><b><a href="../symbols/EventLayer.html#reset">reset</a></b>()
377
<div class="description">Reset event-layer</div>
382
<td class="attributes"> </td>
383
<td class="nameDescription">
384
<div class="fixedFont"><b><a href="../symbols/EventLayer.html#toggleLabelVisibility">toggleLabelVisibility</a></b>()
386
<div class="description">Toggle event label visibility</div>
391
<td class="attributes"> </td>
392
<td class="nameDescription">
393
<div class="fixedFont"><b><a href="../symbols/EventLayer.html#updateIcon">updateIcon</a></b>(newIcon)
395
<div class="description">Updates the icon associated with the EventLayer.</div>
400
<td class="attributes"> </td>
401
<td class="nameDescription">
402
<div class="fixedFont"><b><a href="../symbols/EventLayer.html#viewportMove">viewportMove</a></b>()
404
<div class="description">Place-holder for an event-handler which will handle viewportMove events.</div>
414
<!-- ============================== events summary ======================== -->
417
<!-- ============================== constructor details ==================== -->
419
<div class="details"><a name="constructor"> </a>
420
<div class="sectionTitle">
424
<div class="fixedFont">
425
<b>EventLayer</b>(viewport, options)
428
<div class="description">
429
Creates a new EventLayer.
437
<dl class="detailList">
438
<dt class="heading">Parameters:</dt>
441
<span class="light fixedFont">{Object}</span> <b>viewport</b>
444
<dd>A reference to Helioviewer's viewport.</dd>
447
<span class="light fixedFont">{Object}</span> <b>options</b>
450
<dd>The event layer settings.</dd>
464
<!-- ============================== field details ========================== -->
466
<div class="sectionTitle">
470
<a name="defaultOptions"> </a>
471
<div class="fixedFont">
474
<b>defaultOptions</b>
477
<div class="description">
478
Default EventLayer options<br><br>
479
<strong>Notes:</strong><br><br>
480
"sunRadius0" refers to the Sun's radius at zoom-level 0, in pixels = 94 * 2^12.<br>
481
"windowSize" refers to the size of the window (in seconds) from which events should be displayed.<br>
497
<!-- ============================== method details ========================= -->
499
<div class="sectionTitle">
503
<a name="clear"> </a>
504
<div class="fixedFont">
510
<div class="description">
511
Removes all events from the screen and clears event container
528
<a name="displayEvents"> </a>
529
<div class="fixedFont">
532
<b>displayEvents</b>(jsonEvents)
535
<div class="description">
536
Draws events to screen
544
<dl class="detailList">
545
<dt class="heading">Parameters:</dt>
548
<span class="light fixedFont">{JSON}</span> <b>jsonEvents</b>
551
<dd>An JSON array of event meta-information</dd>
564
<a name="queryEvents"> </a>
565
<div class="fixedFont">
571
<div class="description">
572
Sends an AJAX request to get a list of events.
589
<a name="reload"> </a>
590
<div class="fixedFont">
596
<div class="description">
614
<a name="reset"> </a>
615
<div class="fixedFont">
621
<div class="description">
639
<a name="toggleLabelVisibility"> </a>
640
<div class="fixedFont">
643
<b>toggleLabelVisibility</b>()
646
<div class="description">
647
Toggle event label visibility
664
<a name="updateIcon"> </a>
665
<div class="fixedFont">
668
<b>updateIcon</b>(newIcon)
671
<div class="description">
672
Updates the icon associated with the EventLayer.
680
<dl class="detailList">
681
<dt class="heading">Parameters:</dt>
684
<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>newIcon</b>
687
<dd>New icon to use.</dd>
700
<a name="viewportMove"> </a>
701
<div class="fixedFont">
704
<b>viewportMove</b>()
707
<div class="description">
708
Place-holder for an event-handler which will handle viewportMove events.
727
<!-- ============================== event details ========================= -->
734
<!-- ============================== footer ================================= -->
735
<div class="fineprint" style="clear:both">
737
Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Wed Feb 25 2009 14:47:28 GMT-0500 (EST)