Difference between revisions of "Key Stats - Visualisations"

From All n One's bxp software Wixi

Jump to: navigation, search
(Creating a visual Key Stat)
Line 1: Line 1:
 
 
== Overview ==
 
== Overview ==
  
Line 31: Line 30:
  
 
[[File:VisKeyStatSetting.png]]
 
[[File:VisKeyStatSetting.png]]
 +
 +
 +
== Visual Key Stat Multi Data Series ==
 +
 +
bxp allows the the rendering of two charts with multiple Data Series's, these charts are a line chart and a bar chart with line. Both of these charts are created the exact same was a the standard graphs as outlined above but require slight modification to the
 +
following settings : ''Query - SQL'' and ''Query - Field(s)''
 +
 +
 +
=== Line Chart Multi Series ===
 +
 +
In order to render a line chart with multiple data series's the following settings must be in the following format:
 +
 +
<syntaxhighlight lang="html4strict">
 +
 +
<!--Base Format-->
 +
Query - Field(s) - Name of data series( sep by , )[[DATASERIES]]Headings for intervals ( sep by , )
 +
 +
Query - SQL - Values for Series 1 (sep by ,)[[DATASET]]Values for Series 2 (sep by ,)..............[[DATASET]]Values for Series X(sep by ,)
 +
 +
 +
<!--Example-->
 +
Query - Field(s) - Series1, Series 2[[DATASERIES]]Date Range 1,Date Range 2, Date Range 3
 +
 +
Query - SQL - 10,110,200[[DATASET]]500,100,300
 +
</syntaxhighlight>
 +
 +
 +
=== Bar Chart with Line ===
 +
 +
In order to render a bar chart with Line the following settings must be in the following format:
 +
 +
<syntaxhighlight lang="html4strict">
 +
 +
<!--Base Format-->
 +
Query - Field(s) - Name for the Bar Chart Series, Name for the Line Chart Series[[DATASERIES]]Headings for intervals ( sep by , )
 +
 +
Query - SQL - Values for the Bar Chart (sep by ,)[[DATASET]]Values for the Line Chart (sep by ,)
 +
 +
 +
<!--Example-->
 +
Query - Field(s) - Bar Chart Series, Line Chart Series[[DATASERIES]]Date Range 1,Date Range 2, Date Range 3
 +
 +
Query - SQL - 10,110,200[[DATASET]]500,100,300
 +
</syntaxhighlight>
 +
  
 
== Examples Output ==
 
== Examples Output ==
Line 45: Line 89:
  
 
[[File:VisKeyStatChartLine.png]]
 
[[File:VisKeyStatChartLine.png]]
 +
 +
 +
'''Line Multi Series'''
 +
 +
[[File:KeyStats_Line_Multi.png]]
 +
 +
'''Bar Chat With Line'''
 +
 +
[[File:KeyStats_Bar_Line.png]]

Revision as of 13:16, 1 May 2015

1 Overview

bxp has the ability to allow users to render on screen a custom visualisation through the Key Stats module. The visual Key Stat can render a number of charts: line, bar and pie.

The visual Key Stat can render any number of Key Stat data in the chart once they are separated by a ,

2 Creating a Visual Key Stat

To create a Visual Key Stat you first need to have the key stat Id number that will contain the data that you wish to generate the desired chart from. To create a Key Stat navigate the following system path


Main Menu > Key Stats > KeyStat - Add


Once here you will need to input the following settings to successfully create a visual key stat.

1) Title - This should be an easily identifiable title for the key stat

2) Type - Set this to be Graphic

3) Query - Field(s) - This field should contain the headings of the stats that you are including in the chart ( multiple items can be separated by a ,)

4) Query - SQL - This field should contain the key stat ids that you want to include in the chart ( multiple items can be separated by a ,)

5) Display Title - This is the title of the Graph when it renders to screen

6) Style Pattern - This allows you to select the type of graph you wish to render i.e Line, Bar or Pie


VisKeyStatSetting.png


3 Visual Key Stat Multi Data Series

bxp allows the the rendering of two charts with multiple Data Series's, these charts are a line chart and a bar chart with line. Both of these charts are created the exact same was a the standard graphs as outlined above but require slight modification to the following settings : Query - SQL and Query - Field(s)


3.1 Line Chart Multi Series

In order to render a line chart with multiple data series's the following settings must be in the following format:

<!--Base Format-->
Query - Field(s) - Name of data series( sep by , )[[DATASERIES]]Headings for intervals ( sep by , )

Query - SQL - Values for Series 1 (sep by ,)[[DATASET]]Values for Series 2 (sep by ,)..............[[DATASET]]Values for Series X(sep by ,)


<!--Example-->
Query - Field(s) - Series1, Series 2[[DATASERIES]]Date Range 1,Date Range 2, Date Range 3

Query - SQL - 10,110,200[[DATASET]]500,100,300


3.2 Bar Chart with Line

In order to render a bar chart with Line the following settings must be in the following format:

<!--Base Format-->
Query - Field(s) - Name for the Bar Chart Series, Name for the Line Chart Series[[DATASERIES]]Headings for intervals ( sep by , )

Query - SQL - Values for the Bar Chart (sep by ,)[[DATASET]]Values for the Line Chart (sep by ,)


<!--Example-->
Query - Field(s) - Bar Chart Series, Line Chart Series[[DATASERIES]]Date Range 1,Date Range 2, Date Range 3

Query - SQL - 10,110,200[[DATASET]]500,100,300


4 Examples Output

Bar Chart

VisKeyStatChartBar.png

Pie Chart

VisKeyStatChartPie.png

Line Chart

VisKeyStatChartLine.png


Line Multi Series

KeyStats Line Multi.png

Bar Chat With Line

KeyStats Bar Line.png