ReportBase:Meter Chart Properties

From CustosecWiki
Jump to navigation Jump to search
Meter Chart Properties

The meter chart displays the actual value of a check returning numeric output. The chart can also show 3 ranges indicating i.e. OK, WARNING, CRITICAL. The range colour can be changed and a customized label can be added.



Property Description Example Property Set Example Property Not Set
Show Legend Displays or hides the chart legend.
Note: The legends layout as such cannot be changed, but the wording of it can be changed with the colour settings (see below)
RB MeterChartExample.png
RB MeterChartNoLegend.png
Show Tic Labels Displays or hides the tic labels.
RB MeterChartTicSettings.png
Clicking on "More" will open a dialogue to adapt font, font-size, etc. and colour of the tic labels.
RB MeterChartExample.png
RB MeterChartNoTic.png
Meter Shape There are 3 basic meter chart shapes. They differ in the way, the space between the minimum and the maximum positions ("No Range Space") on the meter are treated and presented. The shapes are:
Cord:
A cord between the minimum and the maximum position on the meter is cutting out a piece of it thus flattening the image. The "No Range Space" space between the minimum and the maximum of the ranges will be filled with the meter outline colour (see examples above).
Circle:
This time, there is no chord cutting a piece of the full round, but the full round is shown as part of the chart and the "No Range Space" is coloured in the meter outline colour (example on the left)
Pie:
This time the ranges are shown as one piece of the whole pie, and not showing the "No Range Space" at all. Therefore the "No Range Space" will get the background colour of the whole chart (example on the right).

In all three cases, the "More" will open a dialogue to change the meters angle. That is the angle from a whole 260 degrees, which will be taken for the presentation of the 3 ranges. (The difference between this angle and the full 360 degrees is the "No Range Space").
The default value is 260 degrees. The examples in the second row are as above but with a meter angle of 150 degrees.
RB MeterChartCircle.png
RB MeterChartCircleNarrow.png
RB MeterChartPie.png
RB MeterChartPieNarrow.png
Meter Outline Colour The colour of the charts outline. In this left example the outline is blue or grey to show the difference to the examples above.

Please note:
The "No Range Space" will be coloured in this colour as well. To change this behaviour the "Pie"-shape should be chosen. In this case, there will be no colour for this "No Range Space" and it will take the background colour of the image (see right example).
RB MeterChartChordBlue.png
RB MeterChartPieBlue.png
Needle Colour The colour of the needle.
RB MeterChartChordNeedleBlack.png
RB MeterChartChordNeedleBrown.png
Display Text Appends this text to the end of the value. The text will be put into one line and spread over the whole chart's width. If it is too big, it will be cut. There are no line feeds.
It is meant as a short explanation on the value.

Again, there is a little dialogue to change the text layout by clicking into the Display Text-Field
RB MeterChartChordDisplayText.png
RB MeterChartChordNoDisplayText.png
Display Ranges 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 two examples show the same chart, on the left with a range of 0..100 and on the right from 0..0,2.
The value of the check will stay the same, so the chart changes by defining the ranges.
RB MeterChartChordHighRange.png
RB MeterChartChordLowRange.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".
RB MeterChartExample.png
RB MeterChartDisplaySubRange.png
If one or two ranges are not needed, they must be set above the Display Upper Limit. There will be a message displayed when doing the Preview and the chart will be produced correctly.
RB MeterChartSettingLessSubRange.png
The example on the left is again the same chart as above, with the following settings:

The example on the right is showing just one sub range.
RB MeterChartDisplayLessSubRange.png
RB MeterChartDisplayOneSubRange.png