Snippets - Revision history

Libby: Added intro/summary.

2016-04-01T17:49:50Z

Added intro/summary.

Libby: Added dataset table with descriptions.

2016-04-01T00:38:28Z

Added dataset table with descriptions.

Libby: Created Snippets documentation page.

2016-03-31T00:39:23Z

Created Snippets documentation page.

New page

==Example==
Below is an example of a Snippet that was generated using the [http://ewx.chg.ucsb.edu/ewx-snippets/ewxmap/configurator.html EWX Map Snippet Configurator].

<pre>
<script src="http://ewx.chg.ucsb.edu/ewx-snippets/ewxmap/ewxmap.js"></script>
</pre>

<pre>
<div id="ewx-map-00pz63b0tc"></div>
<script>
new EwxMap ({
ewxUrl: 'http://ewx.chg.ucsb.edu:8080/EWX',
id: 'ewx-map-00pz63b0tc',
dataset: 'chirps',
region: 'africa',
periodicity: '1-dekad',
period: { year: 2016, month: 2, dekad: 3 },
showDekadControl: true,
showYearControl: true,
units: 'mm',
statistic: 'data',
width: 427,
height: 455,
zoom: 3,
center: [1.5, 17],
});
</script>
</pre>

==Snippets Parameters==

===ewxUrl===
Currently, the only supported parameter is 'http://ewx.chg.ucsb.edu:8080/EWX'. However, other options are forthcoming.

===id===
This parameter can either be arbitrarily set by the user or, using the [http://ewx.chg.ucsb.edu/ewx-snippets/ewxmap/configurator.html EWX Map Snippet Configurator], an id of 'ewx-map-[random]' will be generated for each configuration, where [random] is a randomly assigned collection of letters and numbers.

===dataset===
The dataset parameter defines which dataset the Snippet map will draw from. Certain other parameters may be available or unavailable depending on the data within the dataset. [http://ewx.chg.ucsb.edu/ewx-snippets/ewxmap/configurator.html EWX Map Snippet Configurator] adjusts to reflect this during configuration.

Data are automatically updated based on what is available through EWX. Currently, the available datasets include:

*b1irtmax
*chirp
*chirps
*chirpsclim
*chirpsdecorr
*chirpsprelim
*cpcirtmax
*eancmet
*eancml1soilm
*eancmrunoff
*eancmrunoff001
*eancmta
*eanrget
*eanrgl1soilm
*eanrgrunoff
*eanrgta
*eavcmet
*eavcml1soilm
*eavcmrunoff
*eavcmta
*gpccdi
*lst
*rchecksstns
*rfe2
*trmm
*wrsilongmaize
*wrsishortmaize

===region===
'''"regionName": "Western Africa"''' <br>
"regionId": "westernafrica" <br>
"bounds": [5.0, -17.25], [18.0, 25.25]

'''"regionName": "Eastern Africa"''' <br>
"regionId": "easternafrica" <br>
"bounds": [-12.0, 21.75], [23.25, 51.25]

'''"regionName": "Western Hemisphere"''' <br>
"regionId": "whem" <br>
"bounds": [-50.0, -130.0], [50.0, -30.0]

'''"regionName": "Southern Africa"''' <br>
"regionId": "southernafrica" <br>
"bounds": [-34.75, 5.75], [7.0, 51.25]

'''"regionName": "Global"''' <br>
"regionId": "global" <br>
"bounds": [-90.0, -180.0], [90.0, 180.0]

'''"regionName": "Asia"''' <br>
"regionId": "asia" <br>
"bounds": [5.0, 40.0], [57.0, 147.0]

'''"regionName": "Africa"''' <br>
"regionId": "africa" <br>
"bounds": [-40.0, -20.0], [40.0, 55.0]

'''"regionName": "United States"''' <br>
"regionId": "usa" <br>
"bounds": [23.0, -130.0], [50.0, -63.0]

===periodicity===
More are forthcoming, but for now the available parameters are below:

*'1-dekad'
*'1-month'
*'2-month'
*'3-month'

===period===
*'''{ year: yyyy, month: m, dekad: 3 }''' = Full year, numerical month (1-12), with a default dekad of 3 (based on monthly, not yearly dekad, if dekad info is available)
*'''latest''' = Latest check box is checked (this parameter will display the latest data for the indicated dataset)

===showDekadControl===
A simple boolean parameter - true if the Dekad box is checked, false if not

===showYearControl===
A simple boolean parameter - true if Year box is checked, false if not

===units===
*'mm'
*'c-deg'
*'none'

===statistic===
*anomaly
*data
*z-score

===width===
Width defaults to 427 and is based on pixels. Width can be adjusted either by resizing the window in the configurator or by manually entering the desired value.

===height===
Height defaults to 455 and is based on pixels. Width can be adjusted either by resizing the window in the configurator or by manually entering the desired value.

===zoom===
Zoom defaults to a value of 3. Zoom can be adjusted by using the +/- buttons on your keyboard or your mouse wheel while your mouse cursor is over the snippet map, or by manually setting the value in the javascript snippet.

===center===
The center value defaults to [1.5, 17] and can be adjusted either by clicking and dragging within the window in the configurator or by manually entering the desired value.

← Older revision		Revision as of 17:49, 1 April 2016
Line 1:		Line 1:
		+	A Snippet is a pre-set chunk of code that can provide the user with the javascript and html markup necessary to display maps from [[EWX]] on any webpage with data tailored to the user's needs.

	==Example==		==Example==

@@ Line 42: / Line 42: @@
 Data are automatically updated based on what is available through EWX. Currently, the available datasets include:
-*b1irtmax
+{| class="wikitable sortable" border="1"
-*chirp
+!Dataset id
-*chirps
+!Notes
-*chirpsclim
+|-
-*chirpsdecorr
+|b1irtmax
-*chirpsprelim
+|B1-IRTmax (from B1 back to 1980, every three hours)
-*cpcirtmax
+|-
-*eancmet
+|chirp
-*eancml1soilm
+|Climate Hazards Group InfraRed Precipitation
-*eancmrunoff
+|-
-*eancmrunoff001
+|chirps
-*eancmta
+|[http://dx.doi.org/10.15780/G2RP4Q Climate Hazards Group InfraRed Precipitation with Station data]
-*eanrget
+|-
-*eanrgl1soilm
+|chirpsclim
-*eanrgrunoff
+|[http://dx.doi.org/10.15780/G2159X The Climate Hazards Group's Precipitation Climatology]
-*eanrgta
+|-
-*eavcmet
+|chirpsdecorr
-*eavcml1soilm
+|CHIRP decorrelation distance
-*eavcmrunoff
+|-
-*eavcmta
+|chirpsprelim
-*gpccdi
+|CHIRPS prelimary data (GTS and Conagua (Mexico) station data only)
-*lst
+|-
-*rchecksstns
+|cpcirtmax
-*rfe2
+|CPC-IRTmax (from [http://www.cpc.ncep.noaa.gov/ CPC] back to 2000, every half hour)
-*trmm
+|-
-*wrsilongmaize
+|eancmet
-*wrsishortmaize
+|East Africa evapotranspiration data using NOAA, CHIRPS, and [http://gmao.gsfc.nasa.gov/research/merra/intro.php MERRA]
+|-
 ===region===
 '''"regionName": "Western Africa"''' <br>