399
edits
Changes
From All n One's bxp software Wixi
no edit summary
Query - SQL - 10,110,200[[DATASET]]500,100,300
</syntaxhighlight>
== Key Stats Gauges ==
Key stats in bxp has the ability to generate a number of gauges. To create a key stats gauge, you need to have the following settings
* Query - Field(s) - The sub title of the gauge
* Query - SQL - This should contain the main settings for your gauge, these settings are outlined in the below sections
* Display Title - The main title for the gauge
* Style Pattern - Type of gauge to display
The following gauges are available through Key Stats:
* Angular gauge
* Horizontal gauge
* Level indicator gauge
* Pyramid gauge
* Thermometer gauge
=== Angular gauge ===
To generate an Angular gauge, the following settings must be in the following format:
<syntaxhighlight lang="html4strict">
<!--Base Format-->
Enable/Disable border
[SEP]background color
[SEP]height,width
[SEP]min,max
[SEP]range start,range end,color[Range]range start,range end,color[Range]range start,range end,color
[SEP]key stat, key stat
<!--Example-->
False
[SEP]FFFFFF
[SEP]400,600
[SEP]0,100
[SEP]0,20,#e44a00[Range]20,60,#f8bd19[Range]60,100,#6baa01
[SEP]1,2
</syntaxhighlight>
=== Horizontal gauge ===
To generate a Horizontal gauge, the following settings must be in the following format:
<syntaxhighlight lang="html4strict">
<!--Base Format-->
Enable/Disable border
[SEP]background color
[SEP]height,width
[SEP]min,max
[SEP]range start,range end,color[Range]range start,range end,color[Range]range start,range end,color
[SEP]key stat, key stat
<!--Example-->
False
[SEP]FFFFFF
[SEP]200,500
[SEP]0,100
[SEP]0,20,#e44a00[Range]20,60,#f8bd19[Range]60,100,#6baa01
[SEP]1,2
</syntaxhighlight>
=== Level indicator gauge ===
To generate a Level indicator gauge, the following settings must be in the following format:
<syntaxhighlight lang="html4strict">
<!--Base Format-->
Enable/Disable border
[SEP]background color
[SEP]height,width
[SEP]min,max
[SEP]range start,range end,color[Range]range start,range end,color[Range]range start,range end,color
[SEP]Low Text,High Text
[SEP]key stat
<!--Example-->
False
[SEP]FFFFFF
[SEP]200,600
[SEP]0,500
[SEP]0,200,#ff0000[Range]200,350,#00ff00[Range]350,400,#0000ff
[SEP]Low Text,High Text
[SEP]1
</syntaxhighlight>
=== Pyramid gauge ===
To generate a Pyramid gauge, the following settings must be in the following format:
<syntaxhighlight lang="html4strict">
<!--Base Format-->
Enable/Disable border
[SEP]background color
[SEP]height,width
[SEP]min,max
[SEP]key stat, key stat
[SEP]key stat label 1, key stat label 2
[SEP]Tool tip
<!--Example-->
False
[SEP]FFFFFF
[SEP]400,600
[SEP]0,100
[SEP]1,2
[SEP]label 1,label 2
[SEP] - Tool tip testing
</syntaxhighlight>
=== Thermometer gauge ===
To generate a Thermometer gauge, the following settings must be in the following format:
<syntaxhighlight lang="html4strict">
<!--Base Format-->
Enable/Disable border
[SEP]background color
[SEP]height,width
[SEP]min,max
[SEP]key stat
[SEP]Thermometer height
[SEP]Thermometer bulb radius
[SEP]Fill colour
<!--Example-->
False
[SEP]FFFFFF
[SEP]700,600
[SEP]-20,800
[SEP]1
[SEP]500
[SEP]50
[SEP]#008ee4
</syntaxhighlight>
== Examples Output ==
[[File:VisKeyStatChartBar.png]]
'''Pie Chart'''
[[File:VisKeyStatChartPie.png]]
'''Line Chart'''
[[File:KeyStats_Line_Multi.png]]
'''Bar Chat With Line'''
[[File:KeyStats_Bar_Line.png]]
'''Angular gauge'''
[[File:KS_Angular.png]]
'''Horizontal gauge'''
[[File:KS_Horizontal.png]]
'''Level indicator gauge'''
[[File:KS_Level.png]]
'''Pyramid gauge'''
[[File:KS_Pryamid.png]]
'''Thermometer gauge'''
[[File:KS_Thermom.png]]
[[Category:Module Specific:KeyStats]]
