Table A-6 Real Time Chart Parameters
Parameter
|
Description
|
Auto Align Tick Values
|
Whether to ask the chart to automatically place tick values to reduce overlapping of the tick values with the gauge.
|
Base Font
|
Sets the font face (family) of all chart text (data labels, values etc.). If you also specify the outCnvBaseFont attribute, this attribute controls only the font face of text within the chart canvas bounds.
|
Base Font Color
|
Sets the base font color, that is, all chart values and names are displayed in the font color provided here.
|
Base Font Size
|
Sets the base font size of the chart, that is, all the values and the names in the chart are displayed using the font size provided here.
|
bgColor
|
This attribute sets the background color for the chart. You can set any hex color code as the value of this attribute
|
borderColor
|
Border color of the chart.
|
Canvas Background Color
|
Sets Canvas background color. For a gradient effect, enter the color codes separated by commas.
|
Canvas Border Thickness
|
Specifies the canvas border thickness in pixels.
|
canvasBgColor
|
Sets Canvas background color. For Gradient effect, enter colors separated by comma.
|
canvasBorderThickness
|
Lets you specify canvas border thickness.
|
caption
|
Caption of the chart.
|
Chart Background Color
|
Sets the chart background color. You can use any hexidecimal color code.
|
Chart Border
|
Indicates whether the chart should have a border.
|
Chart Border Color
|
Border color of the chart.
|
Chart Caption
|
Caption of the chart.
|
Chart Link
|
|
Chart Sub Caption
|
Sub-caption of the chart.
|
ChartCategoriesParam
|
|
ChartLink
|
|
Charts Type
|
|
ChartSeriesParam
|
|
ChartType
|
|
ChartValueParam
|
|
Clear Chart Interval
|
The time interval when the chart will clear its contents.
|
Data Refresh Interval
|
Chart data refresh interval in seconds.
|
DataAccessId
|
Data access ID. For real time charts, set this value to 1.
|
dataAccessID
|
|
decimals
|
Number of decimal places to which all numbers on the chart will be rounded to. For more details, please see Advanced Charting > Number Formatting section.
|
Format number scale (K,M)
|
Adds K (thousands) and M (millions) to a number after truncating and rounding it, for example, if formatNumberScale is set to 1, 1043 becomes 1.04K (with decimals set to two places). The same applies to numbers in millions; an M is added at the end.
|
formatNumber
|
This configuration determines whether the numbers displayed on the chart will be formatted using commas, e.g., 40,000 if formatNumber='1' and 40000 ifformatNumber='0'.
|
formatNumberScale
|
Configuration whether to add K (thousands) and M (millions) to a number after truncating and rounding it - e.g., if formatNumberScale is set to 1, 1043 will become 1.04K (with decimals set to 2 places). Same with numbers in millions - an M will be added at the end
|
Fusion Chart categoriesParam name
|
|
Fusion Chart seriesParam name
|
|
Fusion Chart valueParam name
|
|
Gauge Border Color
|
Color of gauge scale border. You can either specify a hex code here (like 333333), or a single token from gradient fill mix like {dark-20} or {light-30}. The chart will then calculate the border color for each color range individually (based on the color code for each color range).
|
Gauge Border Thickness
|
Thickness of gauge scale border.
|
Gauge End Angle
|
Angle where the gauge will end drawing. Default value is 0.
|
Gauge Lower Limit Label
|
This attribute allows you to display a label instead of the lower limit. For example, in a chart displaying Literacy Rate on a scale of 0-100%, you may need to show the label Low at the starting point of the chart. Upon using this attribute to specify the label, the value 0 will be replaced by Low. Default value: If you do not specify the lowerLimitDisplay attribute, the lower limit value will be shown.
|
Gauge Start Angle
|
Angle from where the gauge will start drawing. Default value is 180.
|
Gauge Upper Limit Label
|
This attribute allows you to display a label instead of the upper limit. Upon using this attribute, the upper limit of the chart gets replaced by the label specified. Default value: If you do not specify the upperLimitDisplay attribute, the upper limit value will be shown.
|
Height
|
Height to the chart
|
HtmlObject
|
|
Intervals Array
|
"Array - Intervals to use on the dial. [""0"",""75"",""90"",""100""]. Use for creating XML
|
labelDisplay
|
Using this attribute, you can control how your data labels (x-axis labels) will appear on the chart. There are 4 options: WRAP, STAGGER, ROTATE or NONE. WRAP wraps the label text if it's longer than the allotted area. ROTATE rotates the label in vertical or slanted position. STAGGER divides the labels into multiple lines.
|
labelStep
|
By default, all the labels are displayed on the chart. However, if you have a set of streaming data (like name of months or days of week), you can opt to show every n-th label for better clarity. This attributes just lets you do so. It allows you to display every n(th) X-axis label.
|
Legend Position
|
The legend can be plotted at two positions on the chart - below the chart (BOTTOM) and on the RIGHT side of the chart.
|
Listeners
|
|
Max number of data points to plot
|
Specifies the number of data items that you want as history on the chart. For example, when you set it as 50, only 50 data items (per dataset) are displayed on the chart. After the 51st data item arrives, the first data item is deleted and the rest of the data is shifted by one position left. The new data takes the last position.
|
Name
|
|
Number format
|
Determines whether the numbers displayed on the chart are formatted using commas, for example, 40,000 if formatNumber=1' and 40000 ifformatNumber=0.
|
Number of Decimal points
|
Number of decimal places to which all chart numbers are rounded.
|
Number Prefix
|
Adds a prefix to all the numbers visible on the graph. For example, to represent dollar figures, you could set this attribute to ' $' to show 40000 as $40000, for example.
|
Number Suffix
|
Adds a suffix to all numbers visible on the graph. For example, to represent all figures quantified as per annum, you could set this attribute to ' /a' to show, for example, 40000/a, 50000/a.
|
numDisplaySets
|
This value helps you specify the number of data items that you want as history on the chart. For example, when you set it as 50, only 50 data items (per dataset) will be displayed on the chart. As soon as the 51st data comes in, the first data will be deleted and the rest of the data will be shifted by 1 position left - the new data will come and take the last position.
|
Parameters
|
|
Path
|
Chart path.
|
Place Tick Inside
|
Whether to place ticks inside the gauge (on the inner radius) or outside?
|
Place Values Inside
|
Whether to place tick values inside the gauge?
|
Primary Y Axis Name
|
Primary Y-Axis title.
|
Range Colors Array
|
"Array - Colors to use in the intervals range. [""FF654F"""", ""F6BD0F"", ""8BBA00""]. Refer to ""CGG Dial Component"" Range Color Array. Value can also be hex color codes.
|
refreshInterval
|
For this parameter, you can specify the number of seconds after which the chart will look for new data
|
rotateValues
|
If you show data values, you can rotate them using this attribute.
|
Secondary Y axis decimal places
|
Decimal places for y-axis values on secondary y-axis.
|
Secondary Y Axis Name
|
Secondary Y-Axis title
|
Show Gauge Border
|
Whether to show a border around gauge scale?
|
Show Gauge Value
|
Whether to show each dial's value?
|
Show legend
|
Indicates whether the chart should show a legend. This only applies to multiseries and combination charts.
|
Show Tick Limits
|
Whether to show the first and last tick value (i.e., chart lower and upper limit)?
|
Show Tick Marks
|
Whether to show tick marks?
|
Show Tick Values
|
Whether to show tick values?
|
Show Value Below Pivot
|
Whether to show dial value below the pivot or above it?
|
Show Y Axis Values
|
The y-axis of charts is divided into vertical sections using div (divisional) lines. Each div line assumes a value based on its position. Using this attribute you can specify whether to show the div line (y-axis) values.
|
showBorder
|
Whether to show a border around the chart or not?
|
showLabels
|
It sets the configuration whether the x-axis labels will be displayed or not.
|
showLegend
|
Whether to show legend for the chart (only multi-series and combination charts)?
|
showPercentInToolTip
|
Whether to show percentage figures in tooltip.
|
showPercentValues
|
Whether to show percentage figures in data values of the chart.
|
showValues
|
Sets the configuration whether data values will be displayed along with the data plot on chart.
|
slantLabels
|
If you show rotated labels on a chart, this attribute lets you set the configuration whether the labels will show as slanted labels or fully vertical ones.
|
stack100Percent
|
"Setting this attribute to 1 helps in depicting the values in percentage figures. When this attribute is set to 1 the chart considers the total
of the stacked dataplot as 100% and the Y-Axis shows a scale from 0% to
100%."
|
subCaption
|
Sub-caption of the chart.
|
Width
|
Chart width.
|
X axis label display
|
Controls how data labels (x-axis labels) appear in the chart. WRAP wraps the label text if it is longer than the allotted area. ROTATE rotates the label in vertical or slanted position. STAGGER divides the labels into multiple lines.
|
X axis label step
|
By default, all the labels are displayed on the chart. However, if you have a set of streaming data (such as month names or days of the week), you can opt to show every n-th label for better clarity using this property. The property allows you to display every n(th) X-axis label.
|
X Axis Name
|
X-Axis Title of the Chart.
|
X axis place values inside
|
If you've opted to show data values, you can show them inside the columns using this attribute. By default, the data values show outside the column.
|
X axis rotate values
|
If you show data values, you can rotate them using this attribute.
|
X axis show labels
|
Specifies whether the x-axis labels are displayed.
|
X axis show values
|
Indicates whether data values are displayed along with the data plot on chart.
|
X axis slant labels (for ROTATE)
|
If you selected rotated labels on chart, this attribute determines whether the labels appear as slanted vertical labels.
|
xAxisName
|
X-Axis Title of the Chart.
|
Y axis decimal places
|
Decimal places for y-axis values.
|
Y Axis Name
|
Y-Axis Title of the chart.
|
yAxisValueDecimals
|
Decimal places for y-axis values.
|
FeedbackReal Time Line Dual Y Axis Report Properties