1,684
edits
CumulusUtils Runtime Library: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→Functions
m (→Usage) |
m (→Functions) |
||
| Line 28: | Line 28: | ||
== Functions == | == Functions == | ||
All functions are initialised including the timers and output will be displayed in the users website if a specific DIV with an id is used e.g. | All functions are initialised including the timers and output will be displayed in the users website if a specific DIV with an id is used e.g. | ||
<div id='#d3SunDisc'></div> | <pre><div id='#d3SunDisc'></div></pre> | ||
will display the Sun disc and update it over the day. | will display the Sun disc and update it over the day. | ||
The DIV id's will be shown under the specific caption, all functions below can be called by the user. If the specific DIV IDs does not exist in the website, that should not break the calling sequence. | |||
=== Init function === | === Init function === | ||
$(function () {} | |||
At load this function is executed and initialises the library by calling the following functions: | |||
#''loadRealtimeTxt'' => initializes the loading of ''realtime.txt'' and distributes the values over the dashboard | |||
#Initialize the timer interval for reading realtime.txt | |||
#''DoGaugeSettings'' => initializes the settings for the gauges as defined within CUtils. Note that Cutils uses its own gauges library and css file. | |||
#''worldClockZone'' => Initializes the clocks | |||
#''CreateSun'' and ''CreateMoon'' => Creates the sun and moon disc | |||
#''MinuteFunctions'' => initializes the minute function which takes care of the chart refreshes and the moving of the sun disc hand. | |||
#''HourFunctions'' => initialisez the hour functions which takes care of the moondisc updates | |||
#''LoadUtilsReport'' => It calls the initial report to load | |||
=== loadRealtime.txt === | |||
This function is called automatically by the runtime system at the interval defined by the user in CMX (''Menu=>Internet Settings=>Interval Configuration=>Real time Interval Settings''). | |||
The values are distributed to the DIVs with the (self-explaining) IDs: | |||
''ajxCurTemp, ajxTempChange, ajxTempChangeIndicator, ajxTempMax, ajxTempMin, ajxCurPression, ajxBarChange, [...]'' | |||
The values get the configured change colour which is reset after 3 seconds. | |||
=== DoGaugesSettings === | |||
This applies the gauges settings from ''cumulusutils.ini'' which requires the CUtils specific gauges.js | |||
Gauges which use the CMX gauges library are untouched. | |||
=== CreateSun ND CreateMoon === | |||
These functions create the sun and the moon discs in the DIVs with the IDs ''d3SunDisc'' and ''d3MoonDisc'' respectively. | |||
These functions require the ''d3 library'' to be loaded. | |||
