CumulusUtils Runtime Library - Revision history

HansR: /* Init function */

2024-06-30T07:32:15Z

Init function

← Older revision		Revision as of 07:32, 30 June 2024
Line 47:		Line 47:
	''$(function () {<arguments>} )''		''$(function () {<arguments>} )''

	At load time this function is called automatically and initialises the library by calling the following functions:		At load time this function is called automatically - so it is h ere just for information, no user call is required - and initialises the library by calling the following functions:
	#''loadRealtimeTxt'' => initializes the loading of ''realtime.txt'' and distributes the values over the dashboard		#''loadRealtimeTxt'' => initializes the loading of ''realtime.txt'' and distributes the values over the dashboard
	#''RT_timer = setInterval(loadRealtimeTxt, 30 * 1000);'' => Initialize the interval timer for reading realtime.txt (see below)		#''RT_timer = setInterval(loadRealtimeTxt, 30 * 1000);'' => Initialize the interval timer for reading realtime.txt (see below)

HansR: /* Init function */

2024-06-30T07:30:46Z

Init function

← Older revision		Revision as of 07:30, 30 June 2024
Line 54:		Line 54:
	#''CreateSun'' and ''CreateMoon'' => Creates the sun and moon disc		#''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.		#''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		#''HourFunctions'' => initializes the hour functions which takes care of the moondisc updates
	#''LoadUtilsReport'' => It calls the initial report to load		#''LoadUtilsReport'' => It calls the initial report to load

HansR: /* Usage */

2024-06-30T07:25:27Z

Usage

← Older revision		Revision as of 07:25, 30 June 2024
Line 19:		Line 19:
	The library is intended to be used when CUtils is used in a modular fashion. Any other use is not supported. When using modules which require javascript to function properly (e.g. the Graphs modules) cumulusutils.js must be included in the users webpage using the following HTML code:		The library is intended to be used when CUtils is used in a modular fashion. Any other use is not supported. When using modules which require javascript to function properly (e.g. the Graphs modules) cumulusutils.js must be included in the users webpage using the following HTML code:
	<script src='lib/cumulusutils.js'></script>		<script src='lib/cumulusutils.js'></script>

			And following the note above:
			<script src='https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js'></script>

			And for using the sun and moon discs:
			<script src='https://cdnjs.cloudflare.com/ajax/libs/d3/5.15.1/d3.min.js'></script>"
			<script src='lib/suncalc.js'></script>

	== Globals ==		== Globals ==

HansR: /* Introduction */

2024-06-30T07:17:06Z

Introduction

← Older revision		Revision as of 07:17, 30 June 2024
Line 1:		Line 1:
	== Introduction ==		== Introduction ==
	''CumulusUtils.js'' is the javascript runtime library providing the modular user with functionality otherwise available only in the website. It provides e.g. timing, realtime values, clocks and report loading. It is intended for users who are using CumulusUtils in a [[Modules\|modular fashion]]. The available globals and functions are described below.		''CumulusUtils.js'' is the javascript runtime library providing the modular user with functionality otherwise available only in the website. It provides e.g. timing, realtime values, clocks and report loading. It is intended for users who are using CumulusUtils in a [[Modules\|modular fashion]] and are willing and able to use javascript. The available globals and functions are described below.

	The library can be found in the utils directory (on the CumulusMX machine) and is transferred after generation to the lib directory on the server.		The library can be found in the utils directory (on the CumulusMX machine) and is transferred after generation to the lib directory on the server.

HansR: /* CreateSun / CreateMoon */

2024-06-28T20:27:00Z

CreateSun / CreateMoon

← Older revision		Revision as of 20:27, 28 June 2024
Line 104:		Line 104:
	''CreateMoon();''		''CreateMoon();''

	These functions create the sun and the moon discs in the DIVs with the IDs ''d3SunDisc'' and ''d3MoonDisc'' respectively.		These functions create the sun and the moon discs in the DIVs with the IDs ''d3SunDisc'' and ''d3MoonDisc'' respectively.<br>

	These functions require the ''d3 library'' to be loaded.		These functions require the ''d3 library'' to be loaded.

HansR: /* LoadUtilsReport */

2024-06-28T20:26:29Z

LoadUtilsReport

← Older revision		Revision as of 20:26, 28 June 2024
Line 91:		Line 91:
	''LoadUtilsReport(string, bool);'' => Loads the intended report in the DIV with ID ''CUReportView''		''LoadUtilsReport(string, bool);'' => Loads the intended report in the DIV with ID ''CUReportView''

	Argument 1: The name of the report to load into DIV with ID: ''CUReportView''		Argument 1: The name of the report to load into DIV with ID: ''CUReportView''<br>
⚫	Argument 2: Boolean (true/false) indicating the report will be refreshed after <interval> amount of minutes. Normally ~~used~~ for charts.

		⚫	Argument 2: Boolean (true/false) indicating the report will be refreshed after ''<interval>'' amount of minutes. Normally true for charts.
⚫	In principle any text can be loaded in the DIV with ID ''CUReportView'' but for proper formatting it requires HTML. ~~It can contain any javascript if that is contained in~~ <~~SCRIPT~~>~~</SCRIPT tags.~~

		⚫	In principle any text can be loaded in the DIV with ID ''CUReportView'' but for proper formatting it requires HTML. <br>
			It can contain any javascript if that is contained in <SCRIPT></SCRIPT> tags.

	=== CreateSun / CreateMoon ===		=== CreateSun / CreateMoon ===

HansR: /* DoGaugesSettings */

2024-06-28T20:23:40Z

DoGaugesSettings

← Older revision		Revision as of 20:23, 28 June 2024
Line 67:		Line 67:
	''DoGaugeSettings();''		''DoGaugeSettings();''

	This applies the gauges settings from ''cumulusutils.ini'' which requires the CUtils specific ''gauges.js''		This applies the gauges settings from ''cumulusutils.ini'' which requires the CUtils specific ''gauges.js''.<br>

	Gauges which use the CMX gauges library are untouched.		Gauges which use the CMX gauges library are untouched.

HansR: /* Usage */

2024-06-27T13:56:44Z

Usage

← Older revision		Revision as of 13:56, 27 June 2024
Line 18:		Line 18:

	The library is intended to be used when CUtils is used in a modular fashion. Any other use is not supported. When using modules which require javascript to function properly (e.g. the Graphs modules) cumulusutils.js must be included in the users webpage using the following HTML code:		The library is intended to be used when CUtils is used in a modular fashion. Any other use is not supported. When using modules which require javascript to function properly (e.g. the Graphs modules) cumulusutils.js must be included in the users webpage using the following HTML code:
	<script ~~defer~~ src='lib/cumulusutils.js'></script>		<script src='lib/cumulusutils.js'></script>

	== Globals ==		== Globals ==

HansR: /* Introduction */

2024-06-27T13:56:23Z

Introduction

← Older revision		Revision as of 13:56, 27 June 2024
Line 1:		Line 1:
	== Introduction ==		== Introduction ==
	''CumulusUtils.js'' is the javascript runtime library providing the modular user with functionality otherwise available only in the website. It provides e.g. timing, realtime values, clocks and report loading. It is intended for users who are using CumulusUtils in a modular fashion. The available globals and functions are described below.		''CumulusUtils.js'' is the javascript runtime library providing the modular user with functionality otherwise available only in the website. It provides e.g. timing, realtime values, clocks and report loading. It is intended for users who are using CumulusUtils in a [[Modules\|modular fashion]]. The available globals and functions are described below.

	The library can be found in the utils directory (on the CumulusMX machine) and is transferred after generation to the lib directory on the server.		The library can be found in the utils directory (on the CumulusMX machine) and is transferred after generation to the lib directory on the server.

HansR: /* Functions */

2024-06-27T13:54:58Z

Functions

← Older revision		Revision as of 13:54, 27 June 2024
Line 103:		Line 103:
	These functions create the sun and the moon discs in the DIVs with the IDs ''d3SunDisc'' and ''d3MoonDisc'' respectively.		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.		These functions require the ''d3 library'' to be loaded.


			[[Category:CumulusUtils]]