Gauge

xlsgen > overview > Gauge

Gauges in xlsgen

Gauge

Gauge depict a given level visually in two ways. They can be programmatically set to reflect levels or states that are part of business decision making. They have the following properties :

a gauge level shows how much of a fill has been achieved so far
a gauge color shows in which of 3 state it currently is
each state has an associated threshold which can be set programmatically
one or more gauges can be defined in the same instance. This is achieved by passing an array of values instead of a single value.
gauges are oriented horizontally or vertically according to the width and height of the bounding area. The orientation can also be programmatically set.
optional title for each gauge

Here is the table of parameters :

Name	Type	Description
SetGreenThreshold	integer or double	value below which the current gauge is green. Default value is 0.
SetOrangeThreshold	integer or double	value around which the current gauge is orange. Default value is 50.
SetRedThreshold	integer or double	value above which the current gauge is red. Default value is 100.
SetVertical	boolean	force the orientation of the gauge(s)
SetValue	integer or double (or range of integers or doubles)	value itself or range of values.
SetTitle	string (or range of strings)	title or range of titles.
ResetValues	None	deletes current value(s).

Creating gauges

C/C++ code


xlsgen::IXlsEnginePtr engine( __uuidof(xlsgen::CoXlsEngine) );

xlsgen::IXlsWorkbookPtr wbk = engine->New( L"gauges.xlsx" );

xlsgen::IXlsWorksheetPtr wksht = wbk->AddWorksheet( L"Sheet1" );

xlsgen::IXlsVisualComponentPtr comp = wksht->NewVisualComponent(L"Gauge.ARsTdesign.1",
       2,5, // row1, col1
       6,8, // row2, col2
       0,0,0,0);

comp->ParameterByName[L"SetVertical"]->Formula = L"=FALSE";
comp->ParameterByName[L"SetValue"]->Formula = L"={80;50;20}";
comp->ParameterByName[L"SetTitle"]->Formula = L"={\"my title (80)\";\"2nd title\";\"3rd title\"}";

wbk->Close();