Appboard/2.4/builder/widgets/circular gauge - Revision history

imported>David.moore: /* Data Step */

2013-12-24T23:43:28Z

Data Step

← Older revision		Revision as of 23:43, 24 December 2013
Line 11:		Line 11:
	=== Data Step ===		=== Data Step ===

	# add a widget by clicking the ''Add Widget'' quick action on the left, or via the ''Widgets'' ~~administration~~ page.		# add a widget by clicking the ''Add Widget'' quick action on the left, or via the ''Widgets'' page.
	# On the ''Widget Type'' selection choose the ''Circular Gauge'' by first navigating to the ''Gauge'' category.		# On the ''Widget Type'' selection choose the ''Circular Gauge'' by first navigating to the ''Gauge'' category.
	# Set the ''Data Collection''		# Set the ''Data Collection''

imported>Jason.nicholls at 08:22, 14 December 2013

2013-12-14T08:22:56Z

← Older revision		Revision as of 08:22, 14 December 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:Circular Gauge Widget}}		{{DISPLAYTITLE:Circular Gauge Widget}}
			[[Category:AppBoard 2.4]]
	[[File:CircularGaugeExample.png\|frame\|center\|\|Circular Gauge Sample]]		[[File:CircularGaugeExample.png\|frame\|center\|\|Circular Gauge Sample]]

imported>Jason.nicholls at 11:29, 2 October 2013

2013-10-02T11:29:53Z

← Older revision		Revision as of 11:29, 2 October 2013
Line 18:		Line 18:
	{{Tip\|If using the sample data the most appropriate data collection is <tt>Sample.Data.ChartData</tt>.}}		{{Tip\|If using the sample data the most appropriate data collection is <tt>Sample.Data.ChartData</tt>.}}

	== Label Field==		=== Visualization Step ===

			==== Label Field====
	Select a field that contains the desired label to be used for each item in the data set.		Select a field that contains the desired label to be used for each item in the data set.
	* The "rows" of data from this field (column) will be used as the label for each gauge.		* The "rows" of data from this field (column) will be used as the label for each gauge.
Line 24:		Line 26:
	If you are using ''Sample.Data.ChartData'', select "Month" to be the Label Field. This will produce 11 gauges, since there are 11 rows of data in the sample file. Each will have a different Month name as their label.		If you are using ''Sample.Data.ChartData'', select "Month" to be the Label Field. This will produce 11 gauges, since there are 11 rows of data in the sample file. Each will have a different Month name as their label.

	== Second Label Field ==		==== Second Label Field ====

	Select a field that contains the desired secondary label to be used for each item in the data set.		Select a field that contains the desired secondary label to be used for each item in the data set.
Line 31:		Line 33:
	If you are using ''Sample.Data.ChartData'', select "Planning" to be the Label Field. This will produce 11 gauges, since there are 11 rows of data in the sample file. Each will have a different Month name as their label.		If you are using ''Sample.Data.ChartData'', select "Planning" to be the Label Field. This will produce 11 gauges, since there are 11 rows of data in the sample file. Each will have a different Month name as their label.

	== Value Field ==		==== Value Field ====

	The "Value Field" is what determines the placement of the needle inside the Gauge component.		The "Value Field" is what determines the placement of the needle inside the Gauge component.
Line 37:		Line 39:
	If you're using ''Sample.Data.ChartData'', select "Software" as the Value Field.		If you're using ''Sample.Data.ChartData'', select "Software" as the Value Field.

	== ~~Start Value~~ ==		==== Thresholds (Color) ====
	This option will crop the range of values used to determine the rotation of the needle. This option is useful when dealing with values that do not have much variation. For Example, SLA calculations usually result in values clustered around 99%. If you start from zero, then the gauge will show nearly identical needles. With a "Start Value" set at .095, the needles will show more variation, providing a more useful comparison across the data set as a whole.


	~~== Comparative Measure ==~~
	~~Comparative Measure is an optional secondary (shorter) needle that can be shown on each gauge. It can be useful for showing a high water mark, or deviations from an historical average.~~
	* Select a field that contains the desired value to use in placing the needle to show the comparative measure.


	~~== Thresholds (Color) ==~~
	Setting thresholds is an important element in configuring the Gauge Widget. Threshold values determine the colors displayed in the gauge, as well as the numeric labels that are displayed around the gauge.		Setting thresholds is an important element in configuring the Gauge Widget. Threshold values determine the colors displayed in the gauge, as well as the numeric labels that are displayed around the gauge.

Line 66:		Line 60:
	Note that the order specified is significant. The thresholds should be specified in greatest magnitude to least or from least to greatest. Notice that '0' is always an implied threshold unless overridden by 'Start Value' in 'Presentation', and will be specified last in the greatest to least scenario or first in the least to greatest scenario. For instance, the specified thresholds (10,20,30) will result in the ranges (0-10,10-20,20-30). The thresholds (30,20,10) will result in the ranges (30-20,20-10,10-0).		Note that the order specified is significant. The thresholds should be specified in greatest magnitude to least or from least to greatest. Notice that '0' is always an implied threshold unless overridden by 'Start Value' in 'Presentation', and will be specified last in the greatest to least scenario or first in the least to greatest scenario. For instance, the specified thresholds (10,20,30) will result in the ranges (0-10,10-20,20-30). The thresholds (30,20,10) will result in the ranges (30-20,20-10,10-0).

	== Gauge Options ==		=== Presentation Step ===

			==== Gauge Options ====
	The gauge widget has several unique rendering options.		The gauge widget has several unique rendering options.
	* '''Show Scale in Gauge''': This option shows numerical labels inside the gauge.		* '''Show Scale in Gauge''': This option shows numerical labels inside the gauge.
Line 74:		Line 70:
	* '''Comparitive Measure Field''': See section above.		* '''Comparitive Measure Field''': See section above.

	== Gauge Size ==		==== Gauge Size ====

	The Gauge Size slider affects how large the gauges are, which will impact the number of gauges that can be displayed in a particular Widget.		The Gauge Size slider affects how large the gauges are, which will impact the number of gauges that can be displayed in a particular Widget.

	[[Image:Gauge_Sizes.png\|750px\|Gauge Sizes]]		[[Image:Gauge_Sizes.png\|750px\|Gauge Sizes]]

			==== Start Value ====

			This option will crop the range of values used to determine the rotation of the needle. This option is useful when dealing with values that do not have much variation. For Example, SLA calculations usually result in values clustered around 99%. If you start from zero, then the gauge will show nearly identical needles. With a "Start Value" set at .095, the needles will show more variation, providing a more useful comparison across the data set as a whole.

			==== Comparative Measure ====

			Comparative Measure is an optional secondary (shorter) needle that can be shown on each gauge. It can be useful for showing a high water mark, or deviations from an historical average.
			* Select a field that contains the desired value to use in placing the needle to show the comparative measure.


	== Additional Configuration Steps ==		== Additional Configuration Steps ==
	* See the following page for detail on configuring Widget Options: [[appboard/2.4/builder/widgets/options\|Options]]		* See the following page for detail on configuring Widget Options: [[appboard/2.4/builder/widgets/options\|Options]]
	* See the following page for detail on configuring Widget Actions: [[appboard/2.4/builder/widgets/actions\|Actions]]		* See the following page for detail on configuring Widget Actions: [[appboard/2.4/builder/widgets/actions\|Actions]]

imported>Jason.nicholls: /* Adding a Circular Gauge Widget */

2013-10-02T11:26:59Z

Adding a Circular Gauge Widget

← Older revision		Revision as of 11:26, 2 October 2013
Line 7:		Line 7:

	== Adding a Circular Gauge Widget ==		== Adding a Circular Gauge Widget ==

			=== Data Step ===

	# add a widget by clicking the ''Add Widget'' quick action on the left, or via the ''Widgets'' administration page.		# add a widget by clicking the ''Add Widget'' quick action on the left, or via the ''Widgets'' administration page.
	# On the ''Widget Type'' selection choose the ''Circular Gauge'' by first navigating to the ''Gauge'' category.		# On the ''Widget Type'' selection choose the ''Circular Gauge'' by first navigating to the ''Gauge'' category.
	# Set the ''Data Collection''		# Set the ''Data Collection''
	# Set the ''Widget Name''		# Set the ''Widget Name''
			# continue onto the ''Visualization'' step.

	{{Tip\|If using the sample data the most appropriate data collection is <tt>Sample.Data.ChartData</tt>.}}		{{Tip\|If using the sample data the most appropriate data collection is <tt>Sample.Data.ChartData</tt>.}}


	== Label Field==		== Label Field==

imported>Jason.nicholls at 11:25, 2 October 2013

2013-10-02T11:25:30Z

← Older revision		Revision as of 11:25, 2 October 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:Circular Gauge Widget}}		{{DISPLAYTITLE:Circular Gauge Widget}}
			[[File:CircularGaugeExample.png\|frame\|center\|\|Circular Gauge Sample]]

	== Sample Data ==		== Sample Data ==
	Instructions for bringing sample chart data into AppBoard can be found here: [[appboard/2.4/builder/sample_chart_data\|Sample Chart Data]]		Instructions for bringing sample chart data into AppBoard can be found here: [[appboard/2.4/builder/sample_chart_data\|Sample Chart Data]]
Line 5:		Line 7:

	== Adding a Circular Gauge Widget ==		== Adding a Circular Gauge Widget ==

	~~[[File:CircularGaugeExample.png\|thumb\|right\|350px\|Circular Gauge Sample]]~~

	# add a widget by clicking the ''Add Widget'' quick action on the left, or via the ''Widgets'' administration page.		# add a widget by clicking the ''Add Widget'' quick action on the left, or via the ''Widgets'' administration page.
	# On the ''Widget Type'' selection choose the ''Circular Gauge'' by first navigating to the ''Gauge'' category.		# On the ''Widget Type'' selection choose the ''Circular Gauge'' by first navigating to the ''Gauge'' category.

imported>Jason.nicholls at 11:24, 2 October 2013

2013-10-02T11:24:20Z

← Older revision		Revision as of 11:24, 2 October 2013
Line 13:		Line 13:
	# Set the ''Widget Name''		# Set the ''Widget Name''

	~~== Select a Data Collection ==~~		{{Tip\|If using the sample data the most appropriate data collection is <tt>Sample.Data.ChartData</tt>.}}
	~~Select a '''Data Collection''' that contains the information to use for this widget.~~
	* Click the "Data Collection" pulldown, then select from the list of available Data Collections.
	* If ~~you are~~ using the sample ~~CSV~~ data~~, select "~~Sample.Data.ChartData".
	* If there are no Data Collections available in the pulldown, then see [[appboard/2.4/builder/sample_chart_data\|Sample Chart Data]], or [[appboard/~~2.4/builder/data_collections\|Add/Edit/Remove a Data Collection]]~~.

imported>Jason.nicholls: /* Adding a Circular Gauge Widget */

2013-10-02T11:20:55Z

Adding a Circular Gauge Widget

← Older revision		Revision as of 11:20, 2 October 2013
Line 6:		Line 6:
	== Adding a Circular Gauge Widget ==		== Adding a Circular Gauge Widget ==

			[[File:CircularGaugeExample.png\|thumb\|right\|350px\|Circular Gauge Sample]]

	~~[[File:CircularGaugeExample.png\|thumb\|center\|500px\|Circular Gauge Sample]]~~		# add a widget by clicking the ''Add Widget'' quick action on the left, or via the ''Widgets'' administration page.
			# On the ''Widget Type'' selection choose the ''Circular Gauge'' by first navigating to the ''Gauge'' category.
	# ~~Click "~~Add Widget~~" in the tool palette~~ on the left.		# Set the ''Data Collection''
	~~#* If "Add Widget" is disabled~~, ~~see [[appboard/2.4/builder/stacks_and_boards\|Adding a Stack]]~~.		# Set the ''Widget Name''
	#* For a general overview of adding a "Widget" see [[appboard/2.4/builder/widgets\|Add/Edit/Remove a Widget]].
	~~# Perform~~ the ~~following steps to select the Gauge~~ Widget ~~from~~ the ~~Add Widget dialog.~~
	~~#* Select the "Gauge" tab~~
	~~#* Select "~~Circular Gauge"
	~~#* (Optional) Enter a name for~~ the ~~Widget, such as "Sample~~ Gauge~~". AppBoard will default to "Untitled" if no name is provided~~.
	#* (Optional) Select the Board on which you would like to place the Widget. AppBoard assumes the ~~current board by default.~~
	# ~~Click~~ the ~~"Add~~ Widget~~" button in the bottom toolbar.~~

	== Select a Data Collection ==		== Select a Data Collection ==

imported>Jason.nicholls: /* Thresholds (Color) */

2013-10-02T11:15:54Z

Thresholds (Color)

← Older revision		Revision as of 11:15, 2 October 2013
Line 70:		Line 70:
	#* ''Max Value'': Will use the maximum value found (in the column selected by the 'Value Field' parameter) as a threshold.		#* ''Max Value'': Will use the maximum value found (in the column selected by the 'Value Field' parameter) as a threshold.

	If you are using ''Sample.Data.ChartData'', then set Red to "Dynamic" "Hardware", and Green to "Dynamic" "Totals".		If you are using ''Sample.Data.ChartData'', then set Red to "Dynamic" "Hardware", and Green to "Dynamic" "Totals".


	Note that the order specified is significant. The thresholds should be specified in greatest magnitude to least or from least to greatest. Notice that '0' is always an implied threshold unless overridden by 'Start Value' in 'Presentation', and will be specified last in the greatest to least scenario or first in the least to greatest scenario. For instance, the specified thresholds (10,20,30) will result in the ranges (0-10,10-20,20-30). The thresholds (30,20,10) will result in the ranges (30-20,20-10,10-0).		Note that the order specified is significant. The thresholds should be specified in greatest magnitude to least or from least to greatest. Notice that '0' is always an implied threshold unless overridden by 'Start Value' in 'Presentation', and will be specified last in the greatest to least scenario or first in the least to greatest scenario. For instance, the specified thresholds (10,20,30) will result in the ranges (0-10,10-20,20-30). The thresholds (30,20,10) will result in the ranges (30-20,20-10,10-0).

imported>Jason.nicholls: /* Value Field */

2013-10-02T11:14:19Z

Value Field

← Older revision		Revision as of 11:14, 2 October 2013
Line 40:		Line 40:

	== Value Field ==		== Value Field ==

	The "Value Field" is what determines the placement of the needle inside the Gauge component.		The "Value Field" is what determines the placement of the needle inside the Gauge component.

	If you're using ''Sample.Data.ChartData'', select "Software" as the Value Field.		If you're using ''Sample.Data.ChartData'', select "Software" as the Value Field.


	== Start Value ==		== Start Value ==

imported>Jason.nicholls: /* Second Label Field */

2013-10-02T11:13:57Z

Second Label Field

← Older revision		Revision as of 11:13, 2 October 2013
Line 33:		Line 33:

	== Second Label Field ==		== Second Label Field ==
	~~The Second Label Field is available in AppBoard versions 2.3.17 or higher.~~


	Select a field that contains the desired secondary label to be used for each item in the data set.		Select a field that contains the desired secondary label to be used for each item in the data set.
	* The "rows" of data from this field (column) will be used as the secondary label for each gauge. directly below the Label Field, beneath the gauge.		* The "rows" of data from this field (column) will be used as the secondary label for each gauge. directly below the Label Field, beneath the gauge.
	If you are using ''Sample.Data.ChartData'', select "Planning" to be the Label Field. This will produce 11 gauges, since there are 11 rows of data in the sample file. Each will have a different Month name as their label.

			If you are using ''Sample.Data.ChartData'', select "Planning" to be the Label Field. This will produce 11 gauges, since there are 11 rows of data in the sample file. Each will have a different Month name as their label.

	== Value Field ==		== Value Field ==