Web Statistics with LiveServer Cheat Sheet

Document Sample
scope of work template
							Web Statistics with LiveServer
        Cheat Sheet

     RedDot UK Community Day
    Tuesday 4th November 2008
Chart Types and Parameters

The following chart-types are available:

Parameter                                                                       Description
rdeDefaultBarChart                                                              Two-dimensional bar chart
rdeDefaultBarChartWithDepth                                                     Two-dimensional bar chart with depth
rdeDefaultPieChart                                                              Two-dimensional pie chart
rdeDefaultPieChartWithDepth                                                     Two-dimensional pie chart with depth
rdeDefaultLineChart                                                             Two-dimensional line chart


General Parameters

Bar Chart with Depth: rdeDefaultBarChart

Parameter                      Description                                                                             Values

chartAreaColor                 Background colour of the diagram area.                                                  Hexadecimal value with leading #. Default: transparent
chartAreaGradient              Additional background colour of the diagram area. Creates a smooth transition           Hexadecimal value with leading #. Default: transparent
                               from right to left to the colour specified here.
chartBackgroundColor           Background colour for the entire image.                                                 Hexadecimal value with leading #. Default: transparent
chartBackgroundGradient        Additional background colour for the entire image. Creates a smooth transition          Hexadecimal value with leading #. Default: transparent
                               from right to left to the colour specified here.
chartFont                      Font for all captions (title, axes, values, legend)                                     Name of a font, available in the RedDot LiveServer
                                                                                                                       operating system. Default: Arial
chartFontColor                 Font colour for all captions (title, axes, values, legend)                              Hexadecimal value with leading #. Default: black
                                                                                                                       (#000000)
chartFontSize                  Font size for all captions except title and values along the axes                       Value in pixels. Default: 10
chartHeight                    Height of image                                                                         Value in points. Default: 400
chartWidth                     Width of image                                                                          Value in points. Default: 300
chartSeriesColor               Colours to be used                                                                      Hexadecimal value with leading #. Default: BIRT setting
chartSeriesLabelPosition       Position at which numerical values of the diagram are shown                             Possible values: inside, outside. Default: outside
chartTitle                     Diagram title                                                                           Default: Bar Chart
chartTitleFontSize             Font size for title                                                                     Value in pixels. Default: 16
Parameters for X Axis and Y Axis

Parameter                 Description                                                                               Values

chartAxisLabelFontSize    Font size of values along the axes                                                        Value in pixels. Default: 10

chartAxisLineColor        Colour of the axes                                                                        Hexadecimal value with leading #. Default: black
                                                                                                                    (#000000)
chartAxisTickColor        Colour of ticks along the axes                                                            Hexadecimal value with leading #. Default: black
                                                                                                                    (#000000)
chartGridColor            Colour of the grid lines                                                                  Hexadecimal value with leading #. Default: Light gray
                                                                                                                    (#dddddd)
chartHideAxes             Hide axes                                                                                 Possible values: true, false. Default: false

chartXAxisGridVisible     Showing grid lines of x axis (vertical lines)                                             Possible values: true, false. Default: false

chartXAxisStagger         Values staggered along the x axis                                                         Possible values: true, false. Default: false

chartXAxisStep            Step of values and ticks along the x axis. Is not evaluated if string is given as value   Integer. Default: 1
                          for chartXAxisType.
chartXAxisType            Defines if values for x axis are evaluated as string or integer.                          Possible values: string, integer. Default: integer

chartXAxisTitle           Caption of x axis                                                                         Default: None

chartYAxisGridVisible     Showing grid lines of y axis (horizontal lines)                                           Possible values: true, false. Default: false

chartYAxisStagger         Staggered view of the values along the y axis                                             Possible values: true, false. Default: false

chartYAxisStep            Step of values and ticks along the y axis                                                 Integer. Default: 1

chartYAxisTitle           Caption of y axis                                                                         Default: None
Parameters for the Legend

Parameter                       Description                                                    Values

chartLegendBackgroundColor      Background colour of the legend                                Hexadecimal value with leading #. Default: transparent

chartLegendBackgroundGradient   Additional background colour of the legend. Creates a          Hexadecimal value with leading #. Default: transparent
                                smooth transition from right to left to the colour specified
                                here.
chartLegendPosition             Position of the legend                                         Default: rightMiddle


                                                                                               Above the diagram: aboveLeft, aboveMiddle, aboveRight

                                                                                               Below the diagram: belowLeft, belowMiddle, belowRight

                                                                                               Left of the diagram: leftBottom, leftMiddle, leftTop

                                                                                               Right of the diagram: rightBottom, rightMiddle, rightTop

                                                                                               Within the diagram (bottom): insideBottom, insideBottomLeft,
                                                                                               insideBottomRight

                                                                                               Within the diagram, in the middle: insideLeft, inside Right

                                                                                               Within the diagram (top): insideTop, insideTopLeft, insideTopRight
chartLegendTitle                Headline of the legend                                         Default: None

chartLegendVisible              Showing the legend                                             Possible values: true, false. Default: false
Bar Chart with Depth: rdeDefaultBarChartWithDepth

The same parameters as for the rdeDefaultBarChart diagram type apply. The following additional parameters are possible:

Parameter          Description                                                                           Values

chartFloorColor    Colour of the depth dimension on the x axis with diagrams that have depth and         Hexadecimal value with leading #. Default: Dark gray
                   axes.                                                                                 (#808080)
chartWallColor     Colour of the depth dimension on the y axis with diagrams that have depth and         Hexadecimal value with leading #. Default: Dark gray
                   axes.                                                                                 (#808080)


Line Chart: rdeDefaultLineChart

The same parameters as for the rdeDefaultBarChart diagram type apply. Here, the default for chartTitle is Line Chart. The following additional parameters are possible:

Parameter                        Description                                                             Values

chartSeriesLabelPosition         Position at which numerical values of the diagram are shown             Possible values: above, below, left, right. Default: above



Pie Charts: rdeDefaultPieChart, rdeDefaultPieChartWithDepth

The same parameters as for the rdeDefaultBarChart diagram type apply. Here, the default for chartTitle is Pie Chart. The following additional parameters are possible:

Parameter                  Description                                                         Values

chartSeriesLabel           Defines if numerical values are shown as an absolute value or       Possible values: dataValue, percentage. You can have both values
                           as a percentage                                                     shown, separated by a semicolon. Default: percentage
chartMinSliceBoundary      All values below the limit shown here are combined to one           Floating point number. Default: 0
                           segment
chartMinSliceLabel         Name of the combined segment                                        Default: None

chartMinSliceType          Specifies if the number given for chartSeriesLabel is to be         Possible values: dataValue, percentileDataValue. Default:
                           evaluated as an absolute value or as a percentage                   percentileDataValue

						
Related docs