ReportBase:Dial Chart Properties

From CustosecWiki
Jump to navigation Jump to search
Dial Chart Properties

The dial chart displays the actual value and three ranges indicating OK, WARN and CRITICAL. The range colour can be changed and a customized label can be added. It is used on checks, that deliver a numeric value and the chart is to show one value at a time.

Property Description Example Property Set Example Property Not Set
Dial Frame Background Colour Sets the colour between the outer and inner outlines.

The examples show the same chart, one with a red and one with a yellow background colour.
RB DialChartFrameBackground1.png
RB DialChartFrameBackground2.png
Dial Frame Foreground Colour Sets the colour of the outer and inner outlines.

The examples show the same charts as above, but the one with the yellow background colour has a red outer and inner outline.

RB DialChartDial FrameProperties.png
"More..." opens a little dialogue to change the following 2 parameters:
Dial Frame Radius: Controls the size of the dial. Allowed range is 0.01 (1% of the size of the image) to 1 (100% of the available space). For best results use the default [0.85]
Dial Frame Stroke: Sets the thickness of the outer and inner outlines. Allowed values range from 1.0 to 10 (Default [2].

The examples show the same charts as above, the left one has a Radius of 0.95 and a Frame Stroke of 2. The right one has a Radius of 0.5 and a Frame Stroke of 1.

Please note: The length of the needle is fixed and cannot be changed.
RB DialChartFrameBackground1.png
RB DialChartFrameRadius95.png
RB DialChartFrameBackground2.png
RB DialChartFrameRadius50.png
Display Value Displays the actual value at a given position in the chart.

RB DialChartDisplayValuesProperties.png
"More..." opens a dialogue to change the following parameters:
Font: Sets the value font, font colour and style.
Background Colour: Sets the background colour of the value field.
Radius: Positions the value relative to the centre of the dial. The lower the value the closer to the centre the value will be displayed. A value greater than the frame size may result in the value not being displayed.
Border Colour: Sets the colour of the frame around the displayed value.
Border Stroke: Sets the thickness of the frame around the displayed value.
Position: Sets the location of the value. -90 positions the value at the 6 o'clock position, 90 positions the value at the 12 o'clock position, 0 positions the value at the 3 o'clock position and 180 positions the value at the 9 o'clock position.

First Line: Left as above and right with changed Font, font-size, colour, style.
Second Line: Left as above, but Radius 0.3 and Position 165; Right with Radius 0.75 and Position -165.
RB DialChartFrameBackground1.png
RB DialChartDisplayValuesPosition1.png
RB DialChartDisplayValuesFonts.png
RB DialChartDisplayValuesPosition2.png
Display Labels Tick box to control whether labels should be printed or not.

RB DialChartDisplayLabelsTicksProperties.png
"More..." opens a dialogue to set the following parameters for the major and the minor ticks:
Colour: The colour of the ticks
Stroke: The thickness of the ticks. [Range from 1 - 10, Default = 1]
Length: The length of the ticks. If a Tick Length of 0 is given, the ticks will not be shown. [Range from 0 - 0.2, Default = 0.05/0.02]
Tick Increment: The major ticks steps. [Range from 0 - infinite, Default = 5]
Minor Tick Count: The number of minor ticks between the major ticks [Range from 3 - 20, Default = 3]
Label Offset: The distance between the label and the tick's end.[Range from 0 - 1, Default = 0.15]
RB DialChartDisplayLabelsTicksMore.png
RB DialChartDisplayNoLabels.png
Dial Labels Font and Colour Sets the font and colour used to display the dial scale labels.

The examples show the same chart with different settings for the dial labels.
RB DialChartDisplayLabelsFonts1.png
RB DialChartDisplayLabelsFonts2.png
Dial Cap Fill Colour Sets the colour of the Needle's Cap.

RP DialChartCapsProperties.png
The "More..." dialogue allows additional design parameters of the cap:
Dial Cap Radius: The radius of the cap (size) [Range from 0.01 - 1, Default = 0.05]. Please note: If the cap radius is set to 1 it means that the cap will be 100% of the size of the dial chart which means, the whole chart will only show the cap
Cap Border Stroke: The Thickness of the caps border [Range from 1 - 10, Default = 2]
Cap Border Colour: The colour of the cap's border.
RB DialChartFrameBackground1.png
RP DialChartCapsBigColor.png
Needle Fill Colour Sets the colour of the needle.
Example on the right is with a blue needle, the example on the left with a green needle.
... ...
Display Range Displays the range bands for the dial.
If ticked (default), the range bands (for OK, WARN and CRITICAL) will be displayed. If not, they will not be displayed.

RP DialChartRangeProperties.png
The "More..." dialogue allows for additional design parameters of the ranges:
Outer and Inner Range Radius: The radius of the outer and the inner range band [Ranges from 0.33/0.3 - 1, Default 0,57/0,53]. Lower values positions the band closer to the centre. The defaults as well as the lower limit differ by 0.05 to make sure, both range bands are visible.

Please note: Setting the range band radius to 1 will make it disappear since it is at the outer diameter of the dial chart and covered by this.
Setting the outer range to 1 and the inner to 0.3 will lead to only one range band being displayed (example on the right).

It is also possible to set the inner band with a higher radius and the outer band with a lower radius (Example on the right with 0.55/0.6 for outer/inner range.
RP DialChartRangesChanged.png
RP DialChartRanges1Range.png
Display Text Adds a text between the minimum and maximum ranges. A click on the text field opens the text box.

Please note: The text is displayed between the ranges at the bottom of the chart. If it gets too long, it will be displayed but become not visible because it will disappear behind the ranges [See right example]. Fonts and colour of the text can be set here as well.
RP DialChartText.png
RP DialChartTextTooLong.png
Display Lower/Upper Limit These values set the display range and are carried over from the "Manage Rules" dialogue. They can be changed here.
The example on the right shows the same chart as the one above, but with a "Lower Limit" of 25, which gives the chart a total range of 25 - 100. Please note, that the last label shows 95 and not 100. This is because the "Major Tick Increment" in the "Display Labels" dialogue was set to 10. Starting with 25 it will count up to 95 then.

The example on the right shows the same chart, but with a Lower Limit of 30 and an Upper Limit of 60. Since the value of the check was 29.5, the value will not be shown in this chart. Even the displayed value will be set to 30 (which is the minimum). When creating this chart with the preview button, there will be some messages, saying the chart makes not sense at all. They can be accepted/ignored to get this result...
RP DialChartLowerLimit25.png
RP DialChartSillyLimits.png
Subranges Within the display range 3 sub ranges can be defined. A colour and a title can be added for each of them.
The examples show the same chart, but in the version on the right side, the colours of the ranges have been turned around. This allows the chart to reflect the fact, that a low value returned from a check might mean "Critical" and a higher value might mean "OK".
RP DialChartRanges1.png
RP DialChartRanges2.png
If one or two ranges are not needed, they must be set with a start and an end at 0. The example on the left is again the same chart as above, showing just one sub range colored in blue. The other ranges are all set as Start=0 and End=0.
RP DialChartRanges3.png