Chart Propertie - statistical data charts - Playlist Templates

Introduction

The statistical data charts of LoriotPro visually display the summary information on the operating state and sizing of your network and systems. The charts can be displayed on demand or automatically with the Dashboard Player and allowing the network administrator to monitor at a glance and in real time the overall state of its infrastructure.

This document explains how to change the graphics configuration settings in the generation file of these graphics. These files can be used as is or serve as a model (template) and be customized.

Models for Dashboard Player slideshows are LUA files.

They are located absolutely in the /bin/config/script/httpdashboard/ so that the Dashboard Player can list them in its interface.

Chart Terminology

To control the settings of the graphics, we must tame the related terminology. Here is a sample of a chart column with most options enabled. It displays three series of data each having in the graphic its own color.

Chart terminology

Chart Area. All other elements are located within Chart Area.

Title. The chart title is usually located at the top of Chart Area.

Legend. A Legend displays a list of series names or data points along with their keys. A Legend may be aligned at the left, top, right, bottom and top-right positions of the Chart Area. It may also overlap the Plot Area.

Plot Area. The Plot Area contains Chart Axes and Diagram Area.

Chart Axes. Axe of the chart, X, Y and Z for 3D. Axes have the following properties:

Major tick marks
Minor tick marks
Labels
Major grid lines
Minor grid lines
Major interval interlacing

Diagram Area. The Diagram Area displays Series.

Series. A Series is built up from a list of Data Points.

Data Point. A data point is a simplest entity that can be shown on Diagram. Its appearance depends on Diagram type (later - Chart Type). For example, for the Pie chart a data point is displayed as a pie portion, but for the Bar chart - as a rectangle. A Data Point can be marked on the Diagram by Data Marker and annotated by Data Label.

Configuration parameters of statistical data charts

In the LUA script file, a set of parameters are used to customize the displayed chart.

Serie(s) of the statistical data

Global parameters of visual aspect

Legend parameters

Labels of the series

Parameters of Markers

Parameter of the X axis

Parameter of the Y axis

Specific parameters for the PIE chart

Specific parameters for the DOUGHNUT and TORUS chart

Specific parameters for the LINE chart

Specific parameters for the: BAR, COLUMN chart

Parameter of the Funnel chart

Serie(s) of the statistical data charts

chart.Label

Series of data points to be displayed in chart. Must be defined in a LUA table with a syntax that complies strictly.

La table LUA is a set of one entry for each DataPoint with the following format:

SerieName;Label_Axe_X;value

Example of table settings with a single data series. A pie chart is enough to show the series.

Declaration and content of the LUA table:

serie={}
serie[1]="serie1;label X1;5"
serie[2]="serie1;label X2;12"
serie[3]="serie1;label X3;3"
serie[4]="serie1;label X4;8"

The legend in this case contains the labels.

Example of table settings with multiple data series. A column or bar chart type 2D or 3D is required to display the series.

Declaration and content of the LUA table:

serie={}
serie[1]="serie1;label X1;5"
serie[2]="serie1;label X2;12"
serie[3]="serie1;label X3;3"
serie[4]="serie1;label X4;8"
serie[5]="serie2;label X1;15"
serie[6]="serie2;label X2;22"
serie[7]="serie2;label X3;33"
serie[8]="serie2;label X4;18"
serie[9]="serie3;label X1;45"
serie[10]="serie3;label X2;32"
serie[11]="serie3;label X3;23"
serie[12]="serie3;label X4;58"

The legend in this case contains the serie names.

The color of the Data Point can be assigned individually by the following syntax: :

Nom_de_la serie;Label_Axe_X;valeur;COLOR;index

COLOR is a reserved keyword

index is the number of the color in the theme

Global parameters of visual aspect

chart.ChartTitle

Chart title displayed above (eg "Top 10 Host with worst response time"

By default this value is set at the beginning of template

chart.Width

width of the graphic in pixel

By default, this value is set depending on the size of the window with the variable lp_Width

chart.Height

Height of the graphic in pixel

By default, this value is set depending on the size of the window with the variable lp_Height

chart.Category

Category of graphique

0: Default;
1: Line;
2: Pie;
3: Pie3D;
4: Pyramid;
5: Pyramid3D;
6: Funnel;
7: Funnel3D;
8: Column;
9: Bar;
10: Area;
11: Stock;
12: Bubble;
13: LongData;
14: HistoricalLine;
15: Polar;
16: Doughnut;
17: Doughnut3D;
18: Torus3D;
19: Ternary;
20: Column3D;
21: Bar3D;
22: Line3D;
23: Area3D;

Line	Pie	Pie 3D

Pyramid	Pyramid 3D	Funnel

Funnel 3D	Column	Bar

Area	Area3D	Buble

Doughnut 3D	HistoricalLine	Polar

Doughnut	Torus3D	Ternary

Column3D	Bar3D	Line3D

chart.ChartTheme

Color theme of the serie.

Example here are reduced, click on this link Selection of the color theme to have a full view.

-- 0: CT_DEFAULT
-- 1: CT_PASTEL
-- 2: CT_SPRING
-- 3: CT_GREEN
-- 4: CT_BLUE
-- 5: CT_GOLD
-- 6: CT_DARK_ROSE
-- 7: CT_BLACK_AND_GOLD
-- 8: CT_RAINBOW
-- 9: CT_GRAY
-- 10: CT_ARCTIC
-- 11: CT_BLACK_AND_RED
-- 12: CT_PLUM
-- 13: CT_SUNNY
-- 14: CT_VIOLET
-- 15: CT_FLOWER
-- 16: CT_STEEL
-- 17: CT_GRAY_AND_GREEN
-- 18: CT_OLIVE
-- 19: CT_AUTUMN
-- 20: CT_BLACK_AND_GREEN
-- 21: CT_BLACK_AND_BLUE
-- 22: CT_FLAT_2014_1
-- 23: CT_FLAT_2014_2
-- 24: CT_FLAT_2014_3
-- 25: CT_FLAT_2014_4
-- 26: CT_FLAT_2015_1
-- 27: CT_FLAT_2015_2
-- 28: CT_FLAT_2015_3
-- 29: CT_FLAT_2015_4
-- 30: CT_FLAT_2015_5

CT_DEFAULT	CT_PASTEL	CT_SPRING

CT_GREEN	CT_BLUE	CT_GOLD

CT_DARK_ROSE	CT_BLACK_AND_GOLD	CT_RAINBOW

CT_GRAY	CT_ARCTIC	CT_BLACK_AND_RED

CT_PLUM	CT_SUNNY	CT_VIOLET

CT_FLOWER	CT_STEEL	CT_GRAY_AND_GREEN

CT_OLIVE	CT_AUTUMN	CT_BLACK_AND_GREEN

CT_BLACK_AND_BLUE	CT_FLAT_2014_1	CT_FLAT_2014_2

CT_FLAT_2014_3	CT_FLAT_2014_4	CT_FLAT_2015_1

CT_FLAT_2015_2	CT_FLAT_2015_3	CT_FLAT_2015_4

chart.CustomColor

0 - Do not use custom color
1 - Use custom color

If Option 1 is selected to be defined 5 colors available (limited to 5 sets of data)

example

--chart.Serie_SetColorS0=BCGPColor["LavenderBlush"]
--chart.Serie_SetColorS1=BCGPColor["Blue"]
--chart.Serie_SetColorS2=BCGPColor["LimeGreen"]
--chart.Serie_SetColorS3=BCGPColor["Yellow"]
--chart.Serie_SetColorS4=BCGPColor["Red"]

Available colors are defined in the following table LUA:

BCGPColor={
AliceBlue=0,AntiqueWhite=1,Aqua=2,Aquamarine=3,Azure=4,
Beige=5,Bisque=6,Black=7,BlanchedAlmond=8,Blue=9,BlueViolet=10,Brown=11,BurlyWood=12,
CadetBlue=13,Chartreuse=14,Chocolate=15,Coral=16,CornflowerBlue=17,Cornsilk=18,Crimson=19,Cyan=20,
DarkBlue=21,DarkCyan=22,DarkGoldenrod=23,DarkGray=24,DarkGreen=25,DarkKhaki=26,DarkMagenta=27,DarkOliveGreen=28,DarkOrange=29,
DarkOrchid=30,DarkRed=31,DarkSalmon=32,DarkSeaGreen=33,DarkSlateBlue=34,DarkSlateGray=35,DarkTurquoise=36,DarkViolet=37,
DeepPink=38,DeepSkyBlue=39,DimGray=40,DodgerBlue=41,
Firebrick=42,FloralWhite=43,ForestGreen=44,Fuchsia=45,
Gainsboro=46,GhostWhite=47,Gold=48,Goldenrod=49,Gray=50,Green=51,GreenYellow=52,
Honeydew=53,HotPink=54,IndianRed=55,Indigo=56,Ivory=57,Khaki=58,Lavender=59,LavenderBlush=60,LawnGreen=61,LemonChiffon=62,
LightBlue=63,LightCoral=64,LightCyan=65,LightGoldenrodYellow=66,LightGreen=67,LightGray=68,LightPink=69,LightSalmon=70,
LightSeaGreen=71,LightSkyBlue=72,LightSlateGray=73,LightSteelBlue=74,LightYellow=75,Lime=76,LimeGreen=77,Linen=78,
Magenta=79,Maroon=80,MediumAquamarine=81,MediumBlue=82,MediumOrchid=83,MediumPurple=84,MediumSeaGreen,85,MediumSlateBlue=86,
MediumSpringGreen=87,MediumTurquoise=88,MediumVioletRed=89,MidnightBlue=90,MintCream=91,MistyRose=92,Moccasin=93,
NavajoWhite=94,Navy=95,
OldLace=96,Olive=97,OliveDrab=98,Orange=99,OrangeRed=100,Orchid=101,
PaleGoldenrod=102,PaleGreen=103,PaleTurquoise=104,PaleVioletRed=105,PapayaWhip=106,
PeachPuff=107,Peru=108,Pink=109,Plum=110,PowderBlue=111,Purple=112,
Red=113,RosyBrown=114,RoyalBlue=115,
SaddleBrown=116,Salmon=117,SandyBrown=118,SeaGreen=119,SeaShell=120,
Sienna=121,Silver=122,SkyBlue=123,SlateBlue=124,SlateGray=125,Snow=126,SpringGreen=127,SteelBlue=128,
Tan=129,Teal=130,Thistle=131,Tomato=132,Turquoise=133,Violet=134,Wheat=135,White=136,WhiteSmoke=137,Yellow=138,YellowGreen=139}

chart.Serie_SetColorS1

see chart.CustomColor

chart.Serie_SetColorS2

see chart.CustomColor

chart.Serie_SetColorS3

see chart.CustomColor

chart.Serie_SetColorS4

see chart.CustomColor

chart.FillGradientType

Gradient color management of the series of data points
-- 1 BCGP_NO_GRADIENT (default)
-- 2 BCGP_GRADIENT_DIAGONAL_LEFT (diagonal left)
-- 3 BCGP_GRADIENT_DIAGONAL_RIGHT (diagonal right)
-- 4 BCGP_GRADIENT_RADIAL_CENTER (radial)
-- 5 BCGP_GRADIENT_BEVEL (bevel)

chart.GraphTextColor

example BCGPColor["DarkBlue"]

chart.GraphOutlineColor

example BCGPColor["DarkBlue"]

chart.GraphFillColor

example BCGPColor["White"] -- Color of the background of the drawing area

chart.GraphPlotterColor

example BCGPColor["White"] -- Color of the background of the chart area

chart.PerspectivePercent

Enable or Disable perspective of 3D chart

0 Disable
1 Enable

chart.SwapAxesDirection

0 - Y axis horizontal and Y vertical axis
1 - Y axis horizontal and X vertical axis

chart.Scale

Zoom in % for 3D scene

chart.Transparency

Transparency of the series in a 3D chart in percent (100 % is transparent)

example with value 50

chart.ThemeOpacity

This method sets theme opacity (opacity of fill series colors). dblOpacity should be in range [0, 1].

chart.ShowWalls=0;

Displays background walls in 3D scene

Legend parameters

A Legend displays a list of series names or data points along with their keys. A Legend may be aligned at the left, top, right, bottom and top-right positions of the Chart Area. It may also overlap the Plot Area.

Labels of the series

chart.ShowDataLabels	0 - Do not display the label of the series 1 Display the label of the series
chart.DataLabelContent	Set the informations displayed in the label attached to a DataPoint example : 0: DEFAULT_CONTENT 1: SERIES_NAME 2: CATEGORY_NAME 3: VALUED 4: PERCENTAGE 5: X_VALUE 6: BUBBLE_SIZE 7: Y1_VALUE; 8: Y2_VALUE 9: A_TERNARY_PERCENTAGE 10: B_TERNARY_PERCENTAGE 11: C_TERNARY_PERCENTAGE 12: DP_INDEX 13: A_TERNARY_VALUE 14: B_TERNARY_VALUE 15: C_TERNARY_VALUE 16: BUBBLE_VALUES = VALUE \| X_VALUE \| BUBBLE_SIZE, 17: ALL_BUBBLE_VALUES = SERIES_NAME \| VALUE \| X_VALUE \| BUBBLE_SIZE, 18: VALUE_PERCENTAGE = VALUE \| PERCENTAGE, 19: SERIES_VALUES = SERIES_NAME \| VALUE \| X_VALUE, 20: SERIES_CATEGORY_VALUE = SERIES_NAME \| CATEGORY_NAME \| VALUE, 21: PIE_NAME_PERCENTAGE = CATEGORY_NAME \| PERCENTAGE, 22: ALL_TERNARY_VALUES = A_TERNARY_VALUE \| B_TERNARY_VALUE \| C_TERNARY_VALUE, 23: ALL_TERNARY_PERCENTAGE = A_TERNARY_PERCENTAGE \| B_TERNARY_PERCENTAGE \| C_TERNARY_PERCENTAGE
chart.DataLabelPosition	Position of the label of the DataPoint - available for BAR chart and COLUMN chart in 2D and 3D 0 - default 1 - center 2 - inside end 3 - inside base 4 - outside end
chart.DataLabelAngle	Rotation of the label of the DataPoints - Only for BAR and COLUMN chart in 2D and 3D -90 -45 0 45 90

Parameters of Markers

MARKERS

chart.ShowDataMarkers	0 - Do not display the Markers 1 - Display the Markers
chart.MarkerShape	1 - Circle 2 - Triangle 3 - Rectangle 4 - Rhombus
chart.MarkerSize	Size of the Markers

Parameter of the X axis

chart.SeeXAxis	0 - Do not display the X axis 1 - Display the X axis
chart.SeeXAxisGridLines	0 - Do not display the the grid of the X axis 1 - Display the the grid of the X axis
chart.SeeXAxisName	0 - Do not display the legend of X axis 1 - Display the legend of X axis
chart.SeeXIntervalInterlasing	0 - Uniform color rear bands 1 - Not uniform color rear bands
chart.XAxisName	The legend text of the X axis
chart.XRotation	In 3D rotation around the X axis in degrees.
chart.pAxisX_Manage	0 - Disable all the the following features 1 - Enable the following features (if feature set)
chart.pAxisX_m_axisLabelsFormat_SetColor	Color of the labels of the X axis
chart.pAxisX_m_axisLabelsFormat_SetDrawingAngle	X rotation - the angle between X axis and vertical axis in range [0 - 360] degrees -90 -45 0 45 90
chart.pAxisX_m_axisLabelsFormat_SetFontSize	Size of the font in pixel
chart.pAxisX_m_axisLabelsFormat_SetTextAlignment	0 - DEFAULT 1 - LEADING 2 - TRAILING 3 - CENTER
chart.pAxisX_m_axisLabelsFormat_SetTextVerticalAlignment	0 - DEFAULT 1 - LEADING 2 - TRAILING 3 - CENTER
chart.pAxisX_ReverseOrder	0 - Display the serie from left to right 1 - Display the serie from right to left
chart.pAxisX_SetAutoDisplayRange	Automatic and Manual Scaling. In this mode the chart is not zoomed and minimal and maximum displayed values are calculated automatically based on the diagram area size and minimum and maximum values on axes.
chart.pAxisX_SetAutoIntervalWidth	In this mode the size of major units in pixels is calculated automatically, based on diagram area size (axis size) and current scroll range (minimum and maximum displayed values).
chart.pAxisX_SetDisplayDataBetweenTickMarks	This mode can be turned on if the series X component is missing and/or automatically treated as a category index. In this case X coordinates of data points are "shifted" right on half major unit size. This mode is a default for Column and Bar series.
chart.pAxisX_SetScrollRange1	set a scroll range for an axis. By default scroll range is set to minimum and maximum possible displayed values for an axis.
chart.pAxisX_SetScrollRange2	set a scroll range for an axis. By default scroll range is set to minimum and maximum possible displayed values for an axis.
chart.pAxisX_ShowMajorGridLines	0 - Do not display the major grid lines 1 - Display the major grid lines
chart.pAxisX_ShowMinorGridLines	0 - Do not display the minor grid lines 1 - Display the minor grid lines
chart.pAxisX_ShowScrollBar1	0 - Do not display the scroll bar 1 1 - Display the scroll bar 1
chart.pAxisX_ShowScrollBar2	0 - Do not display the scroll bar 2 1 - Display the scroll bar 2

Parameter of the Y axis

chart.SeeYAxis

0 - Do not display the Y axis
1 - Display the Y axis

chart.SeeYAxisGridLines

0 - Do not display the the grid of the Y axis
1 - Display the the grid of the Y axis

chart.SeeYAxisName

0 - Do not display the legend of Y axis
1 - Display the legend of Y axis

chart.SeeYIntervalInterlasing

0 - Uniform color rear bands
1 - Not uniform color rear bands

No Grid	Grid X and Y no interlasing	Grid X and Y with interlasing

chart.YAxisName

The legend text of the Y axis

chart.YRotation

In 3D rotation around the Y axis in degrees.

example:

0 degree	45 degrees	90 degrees

chart.pAxisY_Manage

0 - Disable all the the following features
1 - Enable the following features (if feature set)

chart.pAxisY_m_axisLabelsFormat_SetColor

Color of the labels of the Y axis

chart.pAxisY_m_axisLabelsFormat_SetDrawingAngle

Y rotation - the angle between Y axis and vertical axis in range [0 - 360] degrees

-90
-45
0
45
90

chart.pAxisY_m_axisLabelsFormat_SetFontSize

Size of the font in pixel

chart.pAxisY_m_axisLabelsFormat_SetTextAlignment

0 - DEFAULT
1 - LEADING
2 - TRAILING
3 - CENTER

chart.pAxisY_m_axisLabelsFormat_SetTextVerticalAlignment

0 - DEFAULT
1 - LEADING
2 - TRAILING
3 - CENTER

chart.pAxisY_ReverseOrder

0 - Display the serie from left to right
1 - Display the serie from right to left

chart.pAxisY_SetAutoDisplayRange

Automatic and Manual Scaling. In this mode the chart is not zoomed and minimal and maximum displayed values are calculated automatically based on the diagram area size and minimum and maximum values on axes.

chart.pAxisY_SetAutoIntervalWidth

In this mode the size of major units in pixels is calculated automatically, based on diagram area size (axis size) and current scroll range (minimum and maximum displayed values).

chart.pAxisY_SetDisplayDataBetweenTickMarks

This mode can be turned on if the series X component is missing and/or automatically treated as a category index. In this case X coordinates of data points are "shifted" right on half major unit size. This mode is a default for Column and Bar series.

chart.pAxisY_SetScrollRange1

set a scroll range for an axis. By default scroll range is set to minimum and maximum possible displayed values for an axis.

chart.pAxisY_SetScrollRange2

set a scroll range for an axis. By default scroll range is set to minimum and maximum possible displayed values for an axis.

chart.pAxisY_ShowMajorGridLines

0 - Do not display the major grid lines
1 - Display the major grid lines

chart.pAxisY_ShowMinorGridLines

0 - Do not display the minor grid lines
1 - Display the minor grid lines

chart.pAxisY_ShowScrollBar1

0 - Do not display the scroll bar 1
1 - Display the scroll bar 1

chart.pAxisY_ShowScrollBar2

0 - Do not display the scroll bar 2
1 - Display the scroll bar 2

Specific parameters for the PIE chart

chart.FitDiagramArea=1;

If this feature is enabled, pie shape is drawn as ellipse; otherwise the radius of pie is calculated as a minimum between width and height of diagram.

0 - Disable
1 - Enable

chart.PerspectivePercent

The perspective in percent for the PIE in 3D

chart.ExplodePie

Affiche les portions séparément

-- 0 FALSE
-- 1 TRUE

Non explosé	Explosé

Specific parameters for the DOUGHNUT and TORUS chart

chart.HoleSize

Valeur en pourcent de la taille du trou central

Exemple avec 50 %

TORUS 3D

Specific parameters for the LINE chart

chart.Feature	-- 13 BCGP_Line
	-- 14 BCGP_StackedLine	Lignes empilées avec valeur réelle
	-- 15 BCGP_StackedLine100	Lignes empilées avec valeur en %
	-- 16 BCGP_StackedLineSpline
	-- 17 StepLine
chart.LineStyle	Style of the line 0 - solid 1 -dash 2 - dot 3 - dsah dot 4 - dash dot dot
chart.LineThickness	Thickness of the line in 3D charts. Below example with value 20
chart.LineWidth	Thickness of the line in 2D charts

Specific parameters for the: BAR, COLUMN chart

chart.Type

Parameter for chart of category BAR, BAR 3D, COLUMN,COLUMN 3D.

Must be different from 0

0: BCGP_CT_DEFAULT
1: BCGP_CT_SIMPLE (séries non empilées, disposées cote à cote)
2: BCGP_CT_STACKED (séries empilées en respect des valeurs)
3: BCGP_CT_100STACKED (série empilées mais distribution en pourcentage)
4: BCGP_CT_RANGED

SIMPLE

STACKED

100STACKED

Parameter of the Funnel chart

chart.NeckHeightPerc

Specify neck height in percents from the funnel height.

chart.NeckHeightType

Interpret the neck height as a chart value. All data points whose values all in range [0, dblValue] will be displayed in the neck.

dblValue