Chart Attributes
- a
- b
- c
- d
- e
- f
- g
- h
- i
- j
- k
- l
- m
- n
- o
- p
- q
- r
- s
- t
- u
- v
- w
- x
- y
- z
- Area 2D
- Bar 2D
- Bar 3D
- Box and Whisker 2D
- Bubble Chart
- Candlestick Chart
- Column 2D
- Column 3D
- Doughnut 2D
- Doughnut 3D
- Drag Node Chart
- Drag-able Area 2D Chart
- Drag-able Column 2D Chart
- Drag-able Line 2D Chart
- Error Bar Chart
- Error Line 2D Chart
- Error Scatter Chart
- Funnel Chart
- Gantt Chart
- Heat Map Chart
- Horizontal Bullet Graph
- Horizontal LED
- Inverse Y-axis Area Chart
- Inverse Y-axis Column 2D Chart
- Inverse Y-axis Line 2D Chart
- Kagi Chart
- Line 2D
- Logarithmic Column 2D Chart
- Logarithmic Line 2D Chart
- Marimekko
- Multi-axis Line Chart
- Multi-level Pie Chart
- Multi-series 2D Dual Y Combination Chart (Column + Line + Area + Spline)
- Multi-series 2D Single Y Combination Chart (Column + Line + Area + Spline)
- Multi-series 3D Single Y Combination Chart (Column + Line + Area + Spline)
- Multi-series Area 2D
- Multi-series Bar 2D
- Multi-series Bar 3D
- Multi-series Column 2D
- Multi-series Column 3D
- Multi-series Column 3D + Line Dual Y Axis
- Multi-series Column 3D + Line Single Y-axis
- Multi-series Line 2D
- Multi-series Spline
- Multi-series Spline Area
- Multi-series Stacked Column 2D
- Multi-series Stacked Column 2D + Line Dual Y Axis
- Overlapped Column 2D
- Overlapped Bar 2D
- Pareto 2D
- Pareto 3D
- Pie 2D
- Pie 3D
- Pyramid Chart
- Radar Chart
- Real-time Angular
- Real-time Area
- Real-time Bulb
- Real-time Column
- Real-time Cylinder
- Real-time Horizontal Linear
- Real-time Line
- Real-time Line (Dual Y)
- Real-time Stacked Area
- Real-time Stacked Column
- Real-time Thermometer
- Scatter Chart
- Scroll Area 2D
- Scroll Column 2D
- Scroll Combination 2D (Dual Y)
- Scroll Combination 2D (Single Y)
- Scroll Line 2D
- Scroll Stacked Column 2D
- Select-scatter Chart
- Single-series Spline 2D
- Single-series Spline Area 2D
- Spark Column
- Spark Line
- Spark Win/Loss
- Stacked 2D Column + Line Single Y-axis
- Stacked 3D Column + Line Single Y-axis
- Stacked Area 2D
- Stacked Bar 2D
- Stacked Bar 3D
- Stacked Column 2D
- Stacked Column 3D
- Stacked Column 3D + Line Dual Y Axis
- Step Line Charts
- Tree Map Chart
- Vertical Bullet Graph
- Vertical LED
- Waterfall / Cascade Chart
- Zoom Line
- Zoom Line Dual Y-axis
- Zoom Scatter
- json
- xml
{
"chart": {
"caption": "Live Visitors on Site",
"subCaption": "Every 5 seconds",
"xAxisName": "Time",
"yAxisName": "No. of visitors",
"refreshinterval": "5",
"numberSuffix": "s",
"yaxisminvalue": "0",
"yaxismaxvalue": "60",
"numdisplaysets": "10",
"labeldisplay": "rotate",
"showValues": "1",
"showRealTimeValue": "0",
"placeValuesInside": "1",
"theme": "fusion"
},
"categories": [
{
"category": [
{
"label": "Day Start"
}
]
}
],
"dataset": [
{
"seriesName": "clothing.hsm.com",
"data": [
{
"value": "12"
}
]
},
{
"seriesName": "food.hsm.com",
"data": [
{
"value": "20"
}
]
}
]
}
<chart caption="Live Visitors on Site" subcaption="Every 5 seconds" xaxisname="Time" yaxisname="No. of visitors" refreshinterval="5" numbersuffix="s" yaxisminvalue="0" yaxismaxvalue="60" numdisplaysets="10" labeldisplay="rotate" showvalues="1" showrealtimevalue="0" placevaluesinside="1" theme="fusion">
<categories>
<category label="Day Start" />
</categories>
<dataset seriesname="clothing.hsm.com">
<set value="12" />
</dataset>
<dataset seriesname="food.hsm.com">
<set value="20" />
</dataset>
</chart>
Chart Atributes
Functional Attributes
These attributes let you control a variety of functional elements on the chart. For example, you can opt to show/hide data labels, data values. You can also set chart limits and extended properties.
This attribute lets you set the configuration whether the chart should appear in an animated fashion. If you do not want to animate any part of the chart, set this as 0.
Range: 0/1
This attribute sets the animation duration of the chart. animationDuration
attribute is applicable only if animation of the chart is enabled.
Default value: 1 sec
Range: In seconds
The entire chart can now act as a hotspot. Use this URL to define the hotspot link for the chart. The link can be specified in FusionCharts link format.
Sets whether the clickURL
attribute (that sets a link to which the user is directed when the chart is clicked) overrides the link
attribute (that sets a link to which the user is directed when a data plot is clicked).
Default value: 0 (clickURL
does not override link
)
Range: 0/1
Each chart has 5 pre-defined color palettes which you can choose from. Each palette renders the chart in a different color theme.
Range: 1-5
If you want your own palette derived from a particular hex color, you can specify the same here. All other colors on the chart will automatically derive from that palette.
Range: Hex Color Code
The palette
attribute allows to select a palette theme that applies to chart background, canvas, font and tool-tips, it does not change the colors of dataplots (i.e., column, line, area etc.). The paletteThemeColor
attribute allows to specify your own palette derived from a particular hex color that is applied to chart background, canvas, font, tool-tips and also dataplots. Using paletteColors
attribute, you can specify your custom list of hex colors for the dataplots only. The list of colors have to be separated by comma e.g., "paletteColors": "#FF0000, #0372AB, #FF5904..."
. The chart will cycle through the list of specified colors and then render the data plot accordingly. To use the same set of colors throughout all your charts in a web application, you can store the list of palette colors in your application globally and then provide the same in each chart JSON.
Range: List of hex color codes separated by comma
Whether to show the real-time update related menu items (like Start/Stop Update or Clear Chart) in chart's context menu? Note: For JavaScript charts real-time update related menu items do not appear by default. You need to explicitly set 'showRTMenuItem': '1'
in the chart
object. The menu appears as a button on the bottom-left corner of the JavaScript chart. You can then use the button to Start/Stop Update or Clear chart.
Range: 0/1
Whether to show "Print Chart" item in the context menu of the chart? Even if you opt to hide the item in context menu, you can still opt to invoke print()
JavaScript method of the chart to print the same.
Range: 0/1
If you wish to plot columns with round edges and fill them with a glass effect gradient, set this attribute to 1. The following functionalities will not work when this attribute is set to 1: showShadow
attribute doesn't work anymore. If you want to remove shadow from columns, you'll have to over-ride the shadow with a new shadow style (applied to DATAPLOT) with alpha as 0. Plot fill properties like gradient color, angle etc. will not work anymore, as the colors for gradient are now calculated by the chart itself. Plot border properties also do not work in this mode. Also, you cannot render the border as dashed in this mode.
Range: 0/1
By default, the real-time charts wait for a few seconds after rendering for the first time and before updating itself with new data. To allow the chart to start updating itself as soon as it is rendered, set this attribute to 1.
Range: 0/1
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%.
Range: 0/1
Whether to show percentage figures in data values of the chart.
Range: 0/1
Whether to show percentage figures in tooltip.
Range: 0/1
Setting this attribute to 1, you can allow the chart to automatically resize itself when the parent container of the chart is resized.
Range: 0/1
When enabled in auto mode, long data labels are truncated by adding ellipses to prevent them from overflowing the chart background. The default value is 1.
Range: 0/1
Maximum allowed column width
Range: In Pixels
This attribute, when set to 1, indicates to the chart that the text (rendered on the chart) may contain RTL characters and the textual display has to be managed accordingly.
This attribute lets you enable/disable the highlight effect, in the form of a fadeout
, for the data plots corresponding to a legend item. When this attribute is enabled and the mouse pointer is hovered over a legend item label, plots belonging to the other data series fadeout, by reducing their opacity.
The fadeout effect can be customized by specifying the fadeout color and opacity using the color
and alpha
attributes. Eg. fadeout|color=#ff0000, alpha=60
This attribute changes the theme of the chart. There are 4 types of themes which have been made according to the different color combinations.
Range: ‘carbon’, ‘fusion’, ‘ocean’, ‘zune’
Determines how the data index will be assigned to data plots in real-time charts. For “variableIndex”: “1”
, a variable index is assigned to each of the chart container slots, and is updated every time a new data plot comes into the container. Therefore, a data plot retains the index assigned to it at the time of creation throughout its lifetime. When “variableIndex”: “0”
, a fixed index is assigned to each of the chart container slots. Therefore, the index of a data plot changes every time the data plot changes its position.
Default value for this attribute is 1.
Range: 0/1
Chart Message-related Attributes
These attributes let you set and configure custom chart messages, using text as well as images. These attributes are supported in FusionCharts constructor (FusionCharts({ })
).
This attribute allows to set a custom font for all chart messages.
This attribute allows to set a custom font size for all chart messages.
Range: In pixels
This attribute allows to set a custom font color for all chart messages.
Range: Hex Color Code
This attribute allows to set a custom horizontal alignment for all images displayed as chart messages.
Default value: middle
Range: left, middle, right
This attribute allows to set a custom vertical alignment for all images displayed as chart messages.
Default value: middle
Range: top, middle, bottom
This attribute allows to set a transparency for all images displayed as chart messages.
Default value: 100
Range: 0 - 100
This attribute allows to set a scale for magnifying all images displayed as chart messages.
Default value: 100
Range: 0-300
This attribute allows to set the message to be displayed when a chart begins to load. To display an image as the chart message, prefix I- to the image URL.
This attribute allows to set the font for the message displayed when a chart begins to load.
Range: Font Name
This attribute allows to set the font size for the message displayed when a chart begins to load.
Range: In pixels
This attribute allows to set the font color for the message displayed when a chart begins to load.
Range: Hex Color Code
If an image is displayed as the chart loadMessage
, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the baseChartMessageImageHAlign
attribute
Range: left, middle, right
If an image is displayed as the chart loadMessage
, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the baseChartMessageImageVAlign
attribute
Range: top, middle, bottom
If an image is displayed as the chart loadMessage
, this attribute allows to set the transparency of the image.
Default value: 100
Range: 0 - 100
If an image is displayed as the chart loadMessage
, this attribute allows to set the scale for magnifying the image.
Default value: 100
Range: 0-300
This attribute allows to set the message to be displayed when the specified chart type is not supported. To display an image as the chart message, prefix I- to the image URL.
This attribute allows to set the font for the message displayed when the specified chart type is not supported.
Range: Font Name
This attribute allows to set the font size for the message displayed when the specified chart type is not supported.
Range: In pixels
This attribute allows to set the font color for the message displayed when the specified chart type is not supported.
Range: Hex Color Code
If an image is displayed as the chart typeNotSupportedMessage
, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the baseChartMessageImageHAlign
attribute
Range: left, middle, right
If an image is displayed as the chart typeNotSupportedMessage
, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the baseChartMessageImageVAlign
attribute
Range: top, middle, bottom
If an image is displayed as the chart typeNotSupportedMessage
, this attribute allows to set the transparency of the image.
Default value: 100
Range: 0 - 100
If an image is displayed as the chart typeNotSupportedMessage
, this attribute allows to set the scale for magnifying the image.
Default value: 100
Range: 0-300
This attribute allows to set the message to be displayed if an error is encountered while rendering the chart. To display an image as the chart message, prefix I- to the image URL.
This attribute allows to set a font for the message displayed if an error is encountered while rendering the chart.
Range: Font Name
This attribute allows to set the font size for the message displayed if an error is encountered while rendering the chart.
Range: In pixels
This attribute allows to set the font color for the message displayed if an error is encountered while rendering the chart.
Range: Hex Color Code
If an image is displayed as the chart renderErrorMessage
, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the baseChartMessageImageHAlign
attribute
Range: left, middle, right
If an image is displayed as the chart renderErrorMessage
, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the baseChartMessageImageVAlign
attribute
Range: top, middle, bottom
If an image is displayed as the chart renderErrorMessage
, this attribute allows to set the transparency of the image.
Default value: 100
Range: 0 - 100
If an image is displayed as the chart renderErrorMessage
, this attribute allows to set the scale for magnifying the image.
Default value: 100
Range: 0-300
This attribute allows to set the message to be displayed when chart data begins loading. To display an image as the chart message, prefix I- to the image URL.
This attribute allows to set a font for the message displayed when chart data begins loading.
Range: Font Name
This attribute allows to set the font size for the message displayed when chart data begins loading.
Range: In pixels
This attribute allows to set the font color for the message displayed when chart data begins loading.
Range: Hex Color Code
If an image is displayed as the chart dataLoadStartMessage
, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the baseChartMessageImageHAlign
attribute
Range: left, middle, right
If an image is displayed as the chart dataLoadStartMessage
, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the baseChartMessageImageVAlign
attribute
Range: top, middle, bottom
If an image is displayed as the chart dataLoadStartMessage
, this attribute allows to set the transparency of the image.
Default value: 100
Range: 0 - 100
If an image is displayed as the chart dataLoadStartMessage
, this attribute allows to set the scale for magnifying the image.
Default value: 100
Range: 0-300
This attribute allows to set the message to be displayed if an error is encountered while loading chart data. To display an image as the chart message, prefix I- to the image URL.
This attribute allows to set a font for the message displayed if an error is encountered while loading chart data.
Range: Font Name
This attribute allows to set the font size for the message displayed if an error is encountered while loading chart data.
Range: In pixels
This attribute allows to set the font color for the message displayed if an error is encountered while loading chart data.
Range: Hex Color Code
If an image is displayed as the chart dataLoadErrorMessage
, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the baseChartMessageImageHAlign
attribute
Range: left, middle, right
If an image is displayed as the chart dataLoadErrorMessage
, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the baseChartMessageImageVAlign
attribute
Range: top, middle, bottom
If an image is displayed as the chart dataLoadErrorMessage
, this attribute allows to set the transparency of the image.
Default value: 100
Range: 0 - 100
If an image is displayed as the chart dataLoadErrorMessage
, this attribute allows to set the scale for magnifying the image.
Default value: 100
Range: 0-300
This attribute allows to set the message to be displayed if the data to be loaded for the chart is invalid. To display an image as the chart message, prefix I- to the image URL.
This attribute allows to set the font for the message displayed if the specified chart data is invalid.
Range: Font Name
This attribute allows to set the font size for the message displayed if the specified chart data is invalid.
Range: In pixels
This attribute allows to set the font color for the message displayed if the specified chart data is invalid.
Range: Hex Color Code
If an image is displayed as the chart dataInvalidMessage
, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the baseChartMessageImageHAlign
attribute
Range: left, middle, right
If an image is displayed as the chart dataInvalidMessage
, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the baseChartMessageImageVAlign
attribute
Range: top, middle, bottom
If an image is displayed as the chart dataInvalidMessage
, this attribute allows to set the transparency of the image.
Default value: 100
Range: 0 - 100
If an image is displayed as the chart dataInvalidMessage
, this attribute allows to set the scale for magnifying the image.
Default value: 100
Range: 0-300
Chart Titles and Axis Names
Using these attributes, you can set the various headings and titles of chart like caption, sub-caption, x-axis and y-axis names etc.
Caption of the chart.
Sub-caption of the chart.
X-axis title of the chart.
Y-axis title of the chart.
Chart Caption Cosmetics
These attributes let you configure the cosmetics of chart caption and sub-caption.
Sets horizontal alignment of caption
Range: "left", "center", "right"
Whether caption should be on top of the data plot area
Range: 0/1
Sets the caption font size in pixels
Range: 6 - 72
Sets the sub-caption font size (in pixels)
Range: 6 - 72
Sets the caption font family
Range: Font Name
Sets the sub-caption font family
Range: Font Name
Sets the caption font color
Range: Hex Color Code
Sets the sub-caption font color
Range: Hex Color Code
Whether the caption font should be displayed in bold
Range: 0/1
Whether the sub caption font should be displayed in bold
Range: 0/1
Whether the caption is aligned with the canvas. Else, it will be aligned with the entire chart area
Range: 0/1
If caption is not centre aligned, lets you configure the padding (in pixels) from either edge. Will be ignored if caption is centre aligned.
Range: In Pixels
Chart Axis Configuration Attributes
Using these attributes, you can set and configure x-axis labels, y-axis values and set chart cosmetics for the axis like color, alpha, etc.
If you hide a dataset using legend icon, this attribute (when set to 1
) will compute the axes limit with respect to maximum and minimum value of the visible dataset(s).
Default value: 0
Range: 0/1
This attribute if set to _0_, hides the x-axis of the chart.
Default value: 1
Range: 0/1
Sets color of the x-axis of the chart.
Range: Hex Color Code
Sets the thickness of the x-axis line of the chart.
Range: In Pixels
The y-axis of the 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 set whether to show those div line (y-axis) values or not. The values of showLimits
and showDivLineValues
, if specified explicitly, overrides the value of this attribute.
Range: 0/1
If you do not wish to rotate y-axis name, set this as 0. It specifically comes to use when you've the special characters (UTF-8) in your y-axis name that do not show up in rotated mode.
Range: 0/1
By default, all div lines show their values. However, you can opt to display every x(th) div line value using this attribute.
If you opt to not rotate y-axis name, you can choose a maximum width that will be applied to y-axis name.
Range: In pixels
This attribute helps you explicitly set the lower limit of the chart. If you don't specify this value, it is automatically calculated by the chart based on the data provided by you.
Range: Numeric Value
This attribute helps you explicitly set the upper limit of the chart. If you don't specify this value, it is automatically calculated by the chart based on the data provided by you.
Range: Numeric Value
Whether to show chart limit values. If not specified showYAxisValues
attribute overrides this value.
Range: 0/1
Whether to show div line values. If not specified showYAxisValues
attribute overrides this value.
Range: 0/1
Decimal places for y-axis values.
Whether to force decimal places for y-axis values.
Range: 0/1
x-Axis Name Cosmetics
To configure the font cosmetics of x-axis name (title), you can use the following attributes.
Sets the x-axis font family for the text
Range: Font Name
Sets the x-axis font color
Range: Hex Color Code
Specifies the x-axis font size
Range: 6 - 72
Whether x-axis font should be bold
Range: 0/1
Whether x-axis font should be italicized
Range: 0/1
Sets the background color for x-axis text
Range: Hex Color Code
Sets the border around the x-axis text
Range: Hex Color Code
Sets the x-axis alpha including font and background
Range: 0 - 100
Sets the x-axis font alpha
Range: 0 - 100
Sets the x-axis background alpha
Range: 0 - 100
Sets the x-axis border alpha
Range: 0 - 100
Sets the x-axis border padding
Range: In Pixels
Sets the x-axis border radius
Range: In Pixels
Sets the x-axis border thickness
Range: In Pixels
Whether the border around the x-axis name should be rendered using dashed lines.
Default value: 0 (border rendered using straight lines)
Range: 0/1
Sets the length of each dash when the border around the x-axis name is rendered using dashed lines.
Range: In pixels
Sets the gap between consecutive dashes when the border around the x-axis name is rendered using dashed lines.
Range: In pixels
y-Axis Name Cosmetics
To configure the font cosmetics of y-axis name (title), you can use the following attributes.
Sets the y-axis (primary / secondary) font family for the text
Range: Font Name
Sets the y-axis (primary / secondary) font color
Range: Hex Color Code
Specifies the y-axis (primary / secondary) font size
Range: 6 - 72
Whether y-axis (primary / secondary) font should be bold
Range: 0/1
Whether y-axis (primary / secondary) font should be italicized
Range: 0/1
Sets the background color for y-axis (primary / secondary) text
Range: Hex Color Code
Sets the border around the y-axis (primary / secondary) text
Range: Hex Color Code
Sets the y-axis (primary / secondary) alpha including font and background
Range: 0 - 100
Sets the y-axis (primary / secondary) font alpha
Range: 0 - 100
Sets the y-axis (primary / secondary) background alpha
Range: 0 - 100
Sets the y-axis (primary / secondary) border alpha
Range: 0 - 100
Sets the y-axis (primary / secondary) border padding
Range: In Pixels
Sets the y-axis (primary / secondary) border radius
Range: In Pixels
Sets the y-axis (primary / secondary) border thickness
Range: In Pixels
Whether the border around the y-axis name should be rendered using dashed lines.
Default value: 0 (border rendered using straight lines)
Range: 0/1
Sets the length of each dash when the border around the y-axis name is rendered using dashed lines.
Range: In pixels
Sets the gap between two consecutive dashes when the border around the y-axis name is rendered using dashed lines.
Range: In pixels
Chart Labels & Values
Data labels refer to the names for the data points which appear on the x-axis and data values refer to the plot values i.e., values of each data plot.
It sets the configuration whether the x-axis labels will be displayed or not.
Range: 0/1
This attribute can be used to set the maximum height for the x-axis labels (data labels) excluding the x-axis title. If any label goes beyond this height, the label will be truncated. In stagger mode, the number of stagger lines will be reduced if they exceed this value.
Range: In Pixels
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.
Range: 'AUTO', 'WRAP', 'STAGGER', 'ROTATE', 'NONE'
If you've opted to show rotated labels on chart, this attribute lets you set the configuration whether the labels will show as slanted labels or fully vertical ones.
Range: 0/1
By default, all the labels are displayed on the chart. However, if you've 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.
If you've opted for STAGGER mode as labelDisplay
, using this attribute you can control how many lines to stagger the label to. By default, all labels are displayed in a single line.
If you want to show sum of all the columns in a given stacked column, set this attribute to 1.
Range: 0/1
Sets the configuration whether data values will be displayed along with the data plot on chart.
Range: 0/1
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.
Range: 0/1
If you've opted to show data values, you can rotate them using this attribute.
Range: 0/1
Sets the background color for value text
Range: Hex Color Code
Sets the border color around the value text
Range: Hex Color Code
Sets the value border alpha
Range: 0 - 100
Sets the value border thickness
Range: In Pixels
Sets the padding between the value and its surrounding border
Range: In Pixels
Specifies the value font color
Range: Hex Color Code
Real-time properties
Using these attributes, you can configure the data streaming feature.
This parameter sets the path of the page which is supposed to relay real-time data to the chart. If you've special characters as a part of your data stream URL, like ? or &, you'll need to URL Encode the entire dataStreamURL
This page needs to be on the same sub-domain on which the chart is hosted and invoked from.
For this parameter, you can specify the number of seconds after which the chart will look for new data. This process will happen continuously - i.e., if you specify 5 seconds here, the chart will look for new data every 5 seconds.
The time after which the chart will keep clearing its contents.
If you want the chart to keep polling for new data every x seconds and queue it, you can specify that x seconds as updateInterval
. This helps you poll at different intervals and then draw at another interval (specified as refreshInterval
).
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.
Constantly changing data stamp that can be added to real time Data URL, so as to maintain a state. Please see the section Real time capabilities > Adding data stamp
This parameter lets you set whether you want the latest value (received from server) to be displayed on the chart or not.
Range: 0/1
If you are showing real time values for multiple datasets on the chart, this attribute lets you define the separator character to separate each value's display.
Number Formatting Properties
Using the attributes below, you can control a myriad of options like: Formatting of commas and decimals Number prefixes and suffixes Decimal places to which the numbers will round to Scaling of numbers based on a user defined scale Custom number input formats
This configuration determines whether the numbers displayed on the chart will be formatted using commas, e.g., 40,000 if 'formatNumber': '1'; and 40000 if 'formatNumber': '0';.
Range: 0/1
Using this attribute, you could add prefix to all the numbers visible on the graph. For example, to represent all dollars figure on the chart, you could specify this attribute to $ to show like $40000, $50000.
Using this attribute, you could add suffix to all the numbers visible on the graph. For example, to represent all figures quantified as per annum on the chart, you could specify this attribute to '/a' to show like 40000/a, 50000/a.
Number of decimal places to which all numbers on the chart will be rounded to.
Whether to add 0 padding at the end of decimal numbers? For example, if you set decimals as 2 and a number is 23.4. If forceDecimals
is set to 1, the number will automatically be converted to 23.40 (note the extra 0 at the end).
Range: 0/1
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.
Range: 0/1
The default unit of the numbers that you're providing to the chart.
Unit of each block of the scale.
Range of the various blocks that constitute the scale.
If a data value is less than the lowest given number is the number scale, this attribute forces the lower value of the numberScaleUnit
to be applied to that data value. This attribute works only when “formatNumberScale”: “1”
and the defaultNumberScale
attribute is not defined.
For example, if “numberScaleUnit”: “K, M”
, “numberScaleValue”: “1000, 1000”
, and “forceNumberScale”: “1”
, a data value of 400 will be rendered as 0.40K.
Range: 0/1
Whether recursive scaling should be applied.
Range: 0/1
How many recursions to complete during recursive scaling? -1 completes the entire set of recursion.
What character to use to separate the scales that are generated after recursion?
This attribute helps you specify the character to be used as the decimal separator in a number.
This attribute helps you specify the character to be used as the thousands separator in a number.
This option helps you specify the position of the thousand separator.
In some countries, commas are used as decimal separators and dots as thousand separators. In XML, if you specify such values, it will give an error while converting to number. So, The chart accepts the input decimal and thousand separators from user, so that it can convert it accordingly into the required format. This attribute lets you input the decimal separators.
In some countries, commas are used as decimal separators and dots as thousand separators. In XML, if you specify such values, it will give an error while converting to number. So, The chart accepts the input decimal and thousand separators from user, so that it can convert it accordingly into the required format. This attribute lets you input the thousand separators.
Message Logger
FusionWidgets XT introduces a new concept of streaming and showing real-time messages in the chart using Message Logger. The Message logger can be effectively used to show necessary real-time information or live error logs.
Whether to use message logger for the chart?
Range: 0/1
This attribute lets you set the width percent of the message logger window w.r.t entire chart width. So, if you set it as 80, the message logger window will take up 80% of chart width.
Range: In percent
This attribute lets you set the height percent of the message logger window w.r.t entire chart height.
Range: In percent
Whether to show the title for message logger?
Range: 0/1
If you've opted to show the title for message logger, you can define your custom title here. Examples are "Error log", "Server History" etc. The title displays at the top left corner of chart.
You can customize the color of the entire message log window by setting a hex value for this attribute.
Range: Hex Color Code
The messages streamed to the chart can either be displayed in the message log window or can be passed to JavaScript. This attribute lets you control whether the messages should be logged in the in-built log window.
Range: 0/1
This attribute lets you configure whether each message streamed from the server should be passed to a local JavaScript function.
Range: 0/1
If you've opted to pass each message to JavaScript function, this attribute lets you define the name of the function. This helps you create your custom functions to react to messages streamed from server.
Whether to pass all message envelope parameters to the custom JavaScript function.
Range: 0/1
Plot (Column) properties
These attributes let you configure how your plot (column) will appear on the chart. Various other controls over plot cosmetics can be attained using this set of attributes.
Whether to apply the shadow effects for data plot?
Range: 0/1
Whether the column border will show up.
Range: 0/1
Color for border
Range: Hex Color Code
Border thickness.
Range: In pixels
Border alpha.
Range: 0 - 100
Whether the border around the data plots should be rendered using dashed lines.
Default value: 0 (border rendered using straight lines)
Range: 0/1
Sets the length of each dash when the border around the data plots are rendered using dashed lines.
Range: In pixels
Sets the gap between two consecutive dashes when the border around the data plots are rendered using dashed lines.
Range: In pixels
If you've opted to fill the plot as gradient, this attribute lets you set the fill angle for gradient.
Range: 0-360
If you've opted to fill the plot as gradient, this attribute lets you set the fill ratio for gradient.
If you've opted to fill the plot as gradient, this attribute lets you set the fill alpha for gradient.
Range: 0 - 100
You can globally add a gradient color to the entire plot of chart by specifying the second color as this attribute. For example, if you've specified individual colors for your plot and now you want a gradient that ends in white. So, specify FFFFFF
(white) as this color and the chart will now draw plots as gradient.
Range: Hex Color Code
Gradient color is a color added globally to the entire plot of chart by specifying the second color in an attribute. This attribute sets the gradient color to true.
Default value: 1
Range: 0/1
Chart Cosmetics
The following attributes let you configure chart cosmetics like background color, background alpha, canvas color & alpha etc.
This attribute sets the background color for the chart. You can set any hex color code as the value of this attribute. To specify a gradient as background color, separate the hex color codes of each color in the gradient using comma. Example: #FF5904, #FFFFFF
.
Range: Hex Color Code
Sets the alpha (transparency) for the background. If you've opted for gradient background, you need to set a list of alpha(s) separated by comma.
Range: 0 - 100
If you've opted for a gradient background, this attribute lets you set the ratio of each color constituent.
Angle of the background color, in case of a gradient.
Range: 0-360
Whether to show a border around the chart or not?
Range: 0/1
Border color of the chart.
Range: Hex Color Code
Border thickness of the chart.
Range: In pixels
Border alpha of the chart.
Range: 0 - 100
To place any image (JPG/PNG/GIF) as background of the chart, enter the (path and) name of the background image. It should be in the same domain as the chart.
This attribute specifies the opacity for the loaded background image.
Range: 0 - 100
Helps you specify the mode in which the background image is to be displayed. Stretch - expands the image to fit the entire chart area, without maintaining original image constraints. Tile - the image is repeated as a pattern on the entire chart area. Fit - fits the image proportionately on the chart area. Fill -proportionately fills the entire chart area with the image. Center - the image is positioned at the center of the chart area. None - Default mode.
Range: 'stretch', 'tile', 'fit', 'fill', 'center', 'none'
Helps you to vertically align the background image.
Range: 'top', 'middle', 'bottom'
Helps you to horizontally align the background image.
Range: 'left', 'middle', 'right'
Helps you magnify the background image. This attribute will only work when the attribute bgImageDisplayMode
is set to none, center, or tile.
Range: 0-300
You can load an external logo (JPEG/PNG) to your chart, this attribute lets you specify the URL. Due to cross domain security restrictions it is advised to use a logo from the same domain name as your charts.
This attribute helps you set the amount of empty space that you want to put on the left side of your logo image. Nothing is rendered in this space.
Range: In Pixels
This attribute helps you set the amount of empty space that you want to put on top of your logo image. Nothing is rendered in this space.
Range: In Pixels
Where to position the logo on the chart: TL - Top-left TR - Top-right BR - Bottom right BL - Bottom left CC - Center of screen
Range: 'TL', 'TR', 'BL', 'BR', 'CC'
Once the logo has loaded on the chart, you can configure its opacity using this attribute.
Range: 0 - 100
You can also change the size of externally loaded logo at run-time by specifying a value for this parameter.
Range: 0 - 100
If you want to link the logo to an external URL, specify the link in this attribute. The link can be in FusionCharts link format, allowing you to link to new windows, pop-ups, frames etc.
Canvas Cosmetics
Canvas refers to the area in which the chart is plotted. The following attributes can be used to customize the canvas:
This attribute sets the background color for the chart canvas. You can set any hex color code as the value of this attribute. To specify a gradient as canvas background color, separate the hex color codes of each color in the gradient using comma. Example: #FF5904, #FFFFFF.
Range: Hex Color Code
This attribute sets the background transparency for the chart canvas. For gradient, separate the alpha value using comma. Example: 15, 50.
Range: 0 - 100
When a gradient is used to set the color of the canvas background, this attribute sets the ratio of the colors. Example : If the value of the canvasBgColor
attribute is set as #FF5904, #FFFFFF
, canvasBgRatio
can be used to specify their ratio in the background.
Range: 0 - 100
Helps you specify canvas background angle in case of gradient.
Range: 0-360
Lets you specify canvas border color.
Range: Hex Color Code
Lets you specify canvas border thickness.
Range: In pixels
Lets you control transparency of canvas border.
Range: 0 - 100
Divisional Lines/Grids
Using this set of attributes, you can control the properties of divisional lines and alternate color bands. Divisional Lines are horizontal or vertical lines running through the canvas. Each divisional line signifies a smaller unit of the entire axis thus aiding the users in interpreting the chart. Alternate color bands are colored blocks between two successive divisional lines.
Number of horizontal axis division lines that you want on the chart.
Color for divisional lines.
Range: Hex Color Code
Thickness of divisional lines.
Range: In pixels
Alpha of divisional lines.
Range: 0 - 100
Whether the divisional lines should be rendered as dashed lines.
Default value: 0 (divisional lines rendered using straight lines)
Range: 0/1
Sets the length of each dash when divisional lines are rendered as dashed lines.
Range: In pixels
Sets the gap between two consecutive dashes when divisional lines are rendered as dashed lines.
Range: In pixels
Whether to show alternate colored horizontal grid bands?
Range: 0/1
Color of the alternate horizontal grid bands.
Range: Hex Color Code
Alpha (transparency) of the alternate horizontal grid bands.
Range: 0 - 100
Zero Plane properties
The zero plane is a 2D/3D plane that signifies the 0 position on the chart which separates the positive and negative numbers on a chart having both of them. If there are no negative numbers on the chart, you won't see a visible zero plane. You can customize the zero plane with the following properties:
Color for the Zero Plane. Zero Plane is the line/plane that appears at position 0 on the y-axis, when negative data is being shown on the chart.
Range: Hex Color Code
Thickness of zero plane.
Range: In pixels
Alpha of zero plane.
Range: 0 - 100
To display the value of the zero plane set this attribute to 1.
Range: 0/1
Font Properties
Using the attributes below, you can define the generic font properties for all the text on the chart. These attributes allow you a high level control over font properties. If you intend to specify font properties for individual chart elements (like Caption, sub-caption etc.), you'll need to use the Styles feature. Using Styles, you can also specify advanced font properties like Bold, Italics, HTML Mode etc. Using Styles you can also configure real-time values.
This attribute lets you set the font face (family) of all the text (data labels, values etc.) on chart. If you specify the outCnvBaseFont
attribute also, then this attribute controls only the font face of text within the chart canvas bounds.
Range: Font Name
This attribute sets the base font size of the chart i.e., all the values and the names in the chart which lie on the canvas will be displayed using the font size provided here.
This attribute sets the base font color of the chart i.e., all the values and the names in the chart which lie on the canvas will be displayed using the font color provided here.
Range: Hex Color Code
This attribute sets the base font family of the chart text which lies outside the canvas i.e., all the values and the names in the chart which lie outside the canvas will be displayed using the font name provided here.
Range: Font Name
This attribute sets the base font size of the chart i.e., all the values and the names in the chart which lie outside the canvas will be displayed using the font size provided here.
This attribute sets the base font color of the chart i.e., all the values and the names in the chart which lie outside the canvas will be displayed using the font color provided here.
Range: Hex Color Code
If real time value is to be displayed on the chart, this attribute lets you set the font face of the same.
Range: Font Name
If real time value is to be displayed on the chart, this attribute lets you set the font size of the same.
If real time value is to be displayed on the chart, this attribute lets you set the font color of the same.
Range: Hex Color Code
Sets whether the real time display value will be bold formatted.
Default value: 0 (not bold formatted)
Range: 0/1
Legend Properties
In multi-series charts, the series name of each data-set shows up in the legend of the chart. If you do not need the legend, you can opt to hide the same. Also, the legend can be placed at the bottom of the chart or to the right of the chart. Using the attributes below, you can configure the functional and cosmetic properties of the legend.
Whether to show legend for the chart (only multi-series and combination charts)?
Range: 0/1
Whether legend keys should be displayed in bold
Range: 0/1
Sets legend item font
Range: Font Name
Sets legend item font size
Range: 6 - 72
Sets legend item font color
Range: Hex Color Code
Sets legend item font color on hover
Range: Hex Color Code
The legend can be plotted at two positions on the chart - below (BOTTOM) the chart and to the right (RIGHT) of the chart.
Range: 'RIGHT' or 'BOTTOM'
Sets the legend caption horizontal alignment .
Range: "left", "center", "right"
Whether legend caption should be displayed in bold
Range: 0/1
Sets legend caption font
Range: Font Name
Sets legend caption font size
Range: 6 - 72
Sets legend caption font color
Range: Hex Color Code
This attribute lets you interact with the legend in your chart. When you click a legend key, the dataplots associated with that series are eliminated from the chart. Re-clicking the key causes the dataplots to reappear.
Range: 0/1
Sets the color that applies on both text font and icon when they are in a disabled / hidden state
Range: Hex Color Code
You can add a caption for the entire legend by setting the same here.
Border Color for the legend.
Range: Hex Color Code
Border thickness for the legend.
Range: In pixels
Border alpha for the legend.
Range: 0 - 100
Background color for the legend.
Range: Hex Color Code
Background alpha for the legend.
Range: 0 - 100
Whether to show a shadow for legend?
Range: 0/1
The legend can be made drag-able by setting this attribute to 1. End viewers of the chart can drag the legend around on the chart.
Range: 0/1
If you've too many items on the legend, a scroll bar shows up on the same. This attribute lets you configure the background color of the scroll bar.
Range: Hex Color Code
You can reverse the ordering of datasets in the legend by setting this attribute to 1.
Range: 0/1
Scaling of legend icon is possible starting FusionWidgets XT. This attribute lets you control the size of legend icon.
Range: 1-5
If your chart contains multiple series, the legend is displayed as a grid comprising of multiple legend keys. With the help of this attribute you can specify the number of columns that are to be displayed in the legend.
Range: positive integer
Whether to minimize legend item text wrapping.
Range: 0/1
Specifies whether drawing a custom legend icon will be enabled. All legend icon customization attributes will work only if this feature is enabled.
Default value: 0 (disabled)
Range: 0/1
Sets the border color for the legend icon.
Default value: Data plot border color
Range: Hex Color Code
Sets the background color for the legend icon.
Default value: Data plot fill color
Range: Hex Color Code
Sets the legend icon transparency.
Default value: 100
Range: 0 - 100
Sets the legend icon background transparency.
Default value: 100
Range: 0 - 100
Sets the number of sides for the legend icon.
Default value: 4
Sets the thickness of the legend icon border.
Default value: 1
Range: 1-5
Sets the starting angle of for drawing the legend icon.
Default value: 45
This attribute if set to 0
, the legend box will be center aligned with respect to the entire width of the chart only if the total width of the legend box is more than the canvas width. By default, the legend box is center aligned with respect to the canvas width and it remains the same if the width of the legend box is less than the canvas width.
Range: 0/1
Tooltip Attributes
These attributes let you control the tooltip. You can set the background color, border color, separator character and few other details.
Whether to show tooltip on chart?
Range: 0/1
This attribute lets you control whether series name will show up in tooltip or not.
Range: 0/1
Background color for tooltip.
Range: Hex Color Code
Font color for the tool-tip.
Range: Hex Color Code
Border color for tooltip.
Range: Hex Color Code
Sets the border transparency for tool tip.
Range: 0 - 100
The character specified as the value of this attribute separates the name and value displayed in tooltip.
Whether to show shadow for tooltips.
Range: 0/1
Specify custom text for the tooltip
You can either specify a constant string as the tooltip text or you can use variable values from the data level by prefixing a $ to the attribute name, for example, $name, $value.
Toolbar Attributes
Using this set of attributes, you can customize the toolbar on the chart. The advantage of having a toolbar is that it manages all the UI action elements (context menus, checkboxes, buttons) centrally. This provides a clean, uniform look and a better, more meaningful and logical grouping.
Where to position the toolbar on the chart: TL - Top-left TR - Top-right BR - Bottom right BL - Bottom left CC - Center of screen
Range: TL, TR, BL, BR, CC
Sets the toolbox position on the chart with respect to x-axis.
Sets the toolbox position on the chart with respect to y-axis.
Sets the horizontal alignment of the toolbar on the chart.
Range: Left, Right
Sets the vertical alignment of the toolbar on the chart
Range: Top, Bottom
Sets the color of the toolbar buttons.
Range: Any (color code without the # prefix)
Enables/disables display of tooltips for toolbar buttons.
Range: 0/1
You can change the scale of the toolbar by specifying a value for this attribute.
Attributes for Exporting Charts
These attributes allow you to control the saving of chart as image, SVG or XLS.
Whether the chart will allow exporting to images, PDFs, SVG or XLS.
Default value: 0
Range: 0/1
In case of server-side exporting, the action specifies whether the exported image will be sent back to client as download, or whether it'll be saved on the server.
Default value: download
Range: 'save' or 'download'
In case of server side exporting, this refers to the path of the server-side export handler (the ready-to-use scripts that we provide).
Lets you configure what output formats to allow for export of chart, in the export context menu, and also customize the label for each menu item. The attribute value should be a pipe (|) delimited separated key-value pair. Example: exportFormats: 'PNG=Export as High Quality Image|JPG|PDF=Export as PDF File'
This attributes sets the modes of export. To enable client-side exporting, set this attribute to client.
Default value: auto.
Note: Starting v3.12.1, the exportMode
attribute replaces the exportAtClientSide
attribute. However, you don’t need to make any changes to the existing setup because, the FusionCharts library comes with the proper mapping already provided.
Whether the menu items related to export (e.g., Save as JPEG etc.) will appear in the context menu of chart.
Range: 0/1
In case of server-side exporting and when using download as action, this lefts you configure whether the return image, PDF, SVG or XLS will open in same window (as an attachment for download), or whether it will open in a new window.
Default value: _self
Range: '_self' or '_blank'
Using this attribute you can specify the name (excluding the extension) of the output (export) file.
Data Plot Hover Effects
If you wish to show an effect on the data plot (column, line anchor, pie etc.) when the user hovers his mouse over the data plot, these attributes let you configure the cosmetics of the hover for all data plots in the chart.
Whether to enable hover effect on charts for all elements
Range: 0/1
Whether to enable hover effect on charts for data plots (e.g., column, pie) only
Range: 0/1
Specifies the hover color for the data plots
Range: Hex Color Code
Specifies the hover alpha for data plots
Range: 1 - 100
This attribute specifies the hover color for the columns.
Range: Hex Color Code
This attribute specifies the transparency of the column when you hover.
Range: 0 - 100
Specifies the gradient color for the data plots when hovered. For example, if you've specified individual colors and now you want hover color that ends in white, You need to specify it.
Range: Hex Color Code
Helps you specify the ratio of gradient colors when hovered.
This attribute specifies the angle of the gradient color when hovered.
Sets the color of the border of plot when hovered.
Range: Hex Color Code
Sets the thickness of the border of plot when hovered.
Range: In Pixels
When a data plot is hovered, this attribute is used to specify whether the data plot border will be rendered as a dashed line.
Default value: 0 (border rendered using straight lines)
Range: 0/1
When a data plot is hovered, this attribute is used to set the length of each dash if the border around the data plots are rendered using dashed lines.
Range: In pixels
When a data plot is hovered, this attribute is used to set the gap between consecutive dashes if the border around the data plots are rendered using dashed lines.
Range: In pixels
Chart Paddings & Margins
The following attributes help you control chart margins and paddings. FusionWidgets XT allows you manually customize the padding of various elements on the chart to allow advanced manipulation and control over chart visualization. Padding in FusionWidgets XT is always defined in pixels, unless the attribute itself suggests some other scale (like plotSpacePercent
, which configures the spacing using percentage values). You can also define the chart margins. Chart Margins refer to the empty space left on the top, bottom, left and right of the chart. It's not necessary for you to specify any padding/margin values. FusionCharts Suite XT automatically assumes the best values for the same, if you do not specify the same.
This attribute lets you control the space (in pixels) between the sub-caption and top of the chart canvas. If the sub-caption is not defined, it controls the space between caption and top of chart canvas. If neither caption, nor sub-caption is defined, this padding does not come into play.
Range: In pixels
Using this, you can set the distance between the top end of x-axis title and the bottom end of data labels (or canvas, if data labels are not to be shown).
Range: In pixels
Using this, you can set the distance between the right end of y-axis title and the start of y-axis values (or canvas, if the y-axis values are not to be shown).
Range: In pixels
This attribute helps you set the horizontal space between the canvas left edge and the y-axis values or trend line values (on left/right side). This is particularly useful, when you want more space between your canvas and y-axis values.
Range: In pixels
This attribute sets the vertical space between the labels and canvas bottom edge. If you want more space between the canvas and the x-axis labels, you can use this attribute to control it.
Range: In pixels
It sets the vertical space between the end of columns and start of value textboxes. This basically helps you control the space you want between your columns/anchors and the value textboxes.
Range: In pixels
On a column chart, there is spacing defined between two columns. By default, the spacing is set to 20% of canvas width. If you intend to increase or decrease the spacing between columns, you can do so using this attribute. For example, if you wanted all columns to stick to each other without any space in between, you can set plotSpacePercent
to 0. Similarly, if you want very thin columns, you can set plotSpacePercent
to its max value of 80.
Range: 20%-80%
Vertical distance between the real-time value and x-axis labels.
Range: In pixels
Padding of legend from right/bottom side of canvas
Range: In pixels
Amount of empty space that you want to put on the left side of your chart. Nothing is rendered in this space.
Range: In pixels
Amount of empty space that you want to put on the right side of your chart. Nothing is rendered in this space.
Range: In pixels
Amount of empty space that you want to put on the top of your chart. Nothing is rendered in this space.
Range: In pixels
Amount of empty space that you want to put at the bottom of your chart. Nothing is rendered in this space.
Range: In pixels
Left margin of canvas. Canvas will start from that position.
Range: In pixels
Right margin of canvas. Canvas will end at that position.
Range: In pixels
Top margin of canvas.
Range: In pixels
Bottom margin of canvas.
Range: In pixels
The categories Object
The categories
object and the category
object (child of the categories
object) are used to specify x-axis labels for real-time charts.
The attributes of the categories
object are used to set the font properties of all x-axis labels collectively.
Lets you specify font face for the x-axis data labels.
Lets you specify font color for the x-axis data labels.
Range: Hex Color Code
Lets you specify font size for the x-axis data labels.
The category Object
The attributes of the category
object are used to define and customize individual x-axis labels for real-time charts.
This attribute determines the label for the data item. The label appears on the x-axis of chart.
Note: The label
attribute replaces the name
attribute. Previously, either one of the attributes could be used to set the label. Support for the name
attribute has been discontinued since v3.10.0.
You can individually opt to show/hide labels of individual data items using this attribute.
Range: 0/1
The tooltip defined in the category
object appears only when the mouse cursor is hovered over the data plots. However, this will not appear when the cursor is moved over the data labels (except for a situation when long labels are automatically truncated with ellipses. In this situation, if the mouse cursor is hovered over a truncated label, the tooltip will appear with the full label). In case you want to set a short label and show the full label in tooltip, define the full label using this attribute within the category
object. The tooltip with the full label will appear only when the mouse is hovered on the dataplot.
Sets the x-axis label font family for the text.
Sets the x-axis label font color.
Range: Hex Color Code
Specifies the x-axis label font size.
Range: 6 - 72
Flag indicating whether x-axis label font should be bold or not.
Range: 0/1
Flag indicating whether x-axis label font should be italicized or not.
Range: 0/1
Sets the background color for x-axis label text.
Range: Hex Color Code
Sets the color of the border around the x-axis label text.
Range: Hex Color Code
Sets the x-axis label alpha for both font and background.
Range: 0 - 100
Sets the x-axis label background alpha.
Range: 0 - 100
Sets the x-axis label border alpha.
Range: 0 - 100
Sets the x-axis label border padding.
Range: In Pixels
Sets the x-axis label border radius.
Range: In Pixels
Sets the x-axis label border thickness.
Range: In Pixels
Whether the border around x-axis label should be rendered using dashed lines.
Default value: 0 (border rendered using straight lines)
Range: 0/1
Sets the length of each dash when the border around the x-axis label is rendered using dashed lines.
Range: In pixels
Sets the gap between two consecutive dashes when the border around x-axis label is rendered using dashed lines.
Range: In pixels
Vertical Data Separator Lines
Vertical data separator lines help you separate data blocks. These lines run through the height of the chart, thereby segregating the data into two different blocks. Vertical lines are defined as shown in the example below:
"categories": [{
"category": [{
"label": "Grade 1",
},
{
"vLine": "true",
"label": "Appraisal"
}]
}]
You can configure the cosmetics of vertical separator lines using the following attributes:
Set this attribute to true to render a vertical data separator line.
Display label for the vLine.
Note: The label
attribute replaces the name
attribute. Previously, either one of the attributes could be used to set the label. Support for the name
attribute has been discontinued since v3.10.0.
This attribute defines the color of vertical separator line
Range: Hex Color Code
Thickness in pixels of the vertical separator line.
Range: In pixels
Alpha of the vertical separator line.
Range: 0 - 100
Whether the vertical separator line should be rendered as dashed lines.
Default value: 0 (vertical separator line rendered using straight lines)
Range: 0/1
Sets the width of each dash when vertical separator line is rendered as dashed lines.
Range: In pixels
Sets the gap between consecutive dashes when vertical separator line is rendered as dashed lines.
Range: In pixels
The dataset Object
In real-time charts, attributes of the dataset
object are used to define the properties for all data series to be plotted on the chart.
This attribute sets the alpha (transparency) of the entire dataset.
Range: 0 - 100
Whether to run the values of this dataset through alert manager, each time an update is received?
Range: 0/1
This attribute sets the color using which columns, lines, area of that dataset will be drawn. For column chart, you can specify a list of comma separated hex codes to get a gradient plot
Range: Hex Color Code
Whether this dataset border will appear as dashed?
Range: 0/1
Whether to include the seriesName
of this dataset in legend? This can be particularly useful when you're using combination charts and you've used the area/line chart to plot a trend and you do not want the seriesName
of that trend to appear in legend.
Range: 0/1
Lets you specify the series name for a particular dataset. For example, if you're plotting a chart to indicate monthly sales analysis for 2005 and 2006, the seriesName
for the first dataset will be 2005 and that of the second will be 2006. The seriesName
of a dataset is shown in legend.
Whether to show the values for this dataset?
Range: 0/1
Sets whether a dataset will be visible on the chart, when the chart is first loaded. This attribute overrides the initiallyHidden
attribute.
Default Value : 1
Range: 0/1
This attribute can set the hover color for the data plot.
Range: Hex Color Code
This attribute sets the transparency for the data plot when hovered.
Range: 0 - 100
This attribute sets the gradient color of the data plot on hover.
Range: Hex Color Code
This attribute sets the ratio of gradient colors when hovered.
Range: 0 - 100
This attribute specifies the angle of the gradient color when hovered.
Range: 0 - 360
This attribute sets the border color of the data plot on hover.
Range: Hex Color Code
This attribute sets the border's transparency for the data plot on hover.
Range: 0 - 100
This attribute sets the thickness for the data plot's border on hover.
Range: In pixels
When a data plot is hovered, this attribute is used to specify whether a data plot border will be rendered as a dashed line.
Default value: 0 (border rendered using straight lines)
Range: 0/1
When a data plot is hovered, this attribute is used to set the length of each dash if the border around a data plot is rendered using dashed lines.
Range: In pixels
When a data plot is hovered, this attribute is used to set the gap between consecutive dashes if the border around a data plot is rendered using dashed lines.
Range: In pixels
The data Object
In real-time charts, attributes of the data
object, child of the dataset
object, are used to define the values to be plotted for individual data series. For a real-time chart, essentially, the data
object is used to specify the first data value for all data series to be plotted on the chart; the remaining values are fetched in real-time.
The dataset
and data
objects defined for a real-time chart look like this:
"dataset": [{
"seriesName": "clothing.hsm.com",
"data": [{
"value": "12"
}]
},
{
"seriesName": "food.hsm.com",
"data": [{
"value": "20"
}]
}]
For multi-series charts, you can define the alpha of datasets at dataset level. However, if you wish to highlight a particular data element, you can specify its alpha at "set" level using this attribute.
Range: 0 - 100
For multi-series charts, you can define the color of datasets at dataset level. However, if you wish to highlight a particular data element, you can specify it's color at "set" level using this attribute.
Range: Hex Color Code
Whether the border of this data item should appear as dashed? This is particularly useful when you want to highlight a data (such as forecast or trend etc.). This value over-rides the dataset level value.
Range: 0/1
You can define links for individual data items. That enables the end user to click on data items (columns, lines, bars, etc.) and drill-down to other pages. To define the link for data items, use the link attribute. You can define links that open in same window, new window, pop-up window or frames. Please see Drill-Down Charts section for more information. Also, you'll need to URL Encode all the special characters (like ? and &) present in the link.
You can individually opt to show/hide values of individual data items using this attribute. This value over-rides the dataset level value.
Range: 0/1
By default, FusionWidgets XT shows the "label
, value
" as tooltip text for that data item. But, if you want to display more information for the data item as tooltip, you can use this attribute to specify the same.
Numerical value for the data item. This value will be plotted on the chart.
This attribute can set the hover color for a particular data plot.
Range: Hex Color Code
This attribute sets the transparency for a particular data plot when hovered.
Range: 0 - 100
This attribute sets the gradient color of the data plot on hover.
Range: Hex Color Code
This attribute sets the ratio of gradient colors when hovered.
Range: 0 - 100
This attribute specifies the angle of the gradient color when hovered.
Range: 0 - 360
This attribute sets the border color of a particular data plot on hover.
Range: Hex Color Code
This attribute sets the border thickness for a particular data plot on hover.
Range: 0 - 100
This attribute sets the thickness for a particular data plot's border on hover.
Range: In pixels
When a data plot is hovered, this attribute is used to specify whether a data plot border will be rendered as a dashed line.
Default value: 0 (border rendered using straight lines)
Range: 0/1
When a data plot is hovered, this attribute is used to set the length of each dash if the border around a data plot is rendered using dashed lines.
Range: In pixels
When a data plot is hovered, this attribute is used to set the gap between consecutive dashes if the border around a data plot is rendered using dashed lines.
Range: In pixels
Trend-lines
Trend-lines are horizontal lines that aid in interpretation of data with respect to some pre-determined value. For example, if you are plotting the sales data for the current year, you might want to show the previous year's average monthly sales as a trend indicator for ease of comparison. The lines
object, child of the trendlines
object is used to add trend-lines to a chart.
Although the line
object has to be defined within the trendlines
object, the latter cannot be used to collectively customize trend-lines, because it does not have any attributes of its own.
The attributes of the lines
object, child of the trendlines
object, are used to create and customize trend-lines for charts.
Alpha of the trend line.
Color of the trend line and its associated text
Range: Hex Color Code
Whether the trendline should be rendered as dashed lines.
Default value: 0 (trendline rendered using straight lines)
Range: 0/1
Sets the length of each dash when trendline is rendered as dashed lines.
Range: In pixels
Sets the gap between consecutive dashes when trendline is rendered as dashed lines.
Range: In pixels
If you want to display a string caption for the trend line by its side, you can use this attribute. Example: displayValue='Last Month High'
. When you don't supply this attribute, it automatically takes the value of startValue
.
The ending y-axis value for the trendline. Say, if you want to plot a slanted trendline from value 102 to 109, the endValue
will be 109. If you do not specify a value for endValue
, it will automatically assume the same value as startValue
.
Whether the trend will be displayed as a line or a zone (fill-colored rectangle).
Range: 0/1
Whether the trend line/zone will be displayed over data plots or under them?
Range: 0/1
The starting value for the trendline. Say, if you want to plot a slanted trendline from value 102 to 109, the startValue
will be 102.
If you've opted to show the trend as a line, this attribute lets you define the thickness of trend line.
Range: In pixels
Whether to show the trend line value on left side or right side of chart? This is particularly useful when the trend line display values on the chart are colliding with divisional lines values on the chart.
Range: 0/1
Trend-lines (Chart level attributes)
Trend-lines are horizontal lines that aid in interpretation of data with respect to some pre-determined value. For example, if you are plotting the sales data for the current year, you might want to show the previous year's average monthly sales as a trend indicator for ease of comparison. Cosmetics for all the trend-lines rendered can be attained using this set of attributes.
Although there are set of attributes of the line object
, used to create and customize trend-lines, these set of attributes effect all the trend-lines rendered in your chart.
Sets color of all the trend lines and its associated text in the chart.
Range: Hex Color Code
If you've opted to show the trend as a line, this attribute lets you define the thickness of all the trend lines in your chart.
Range: In Pixels
Sets transparency for all the trend lines in your charts.
Range: 0 - 100
Sets the tooltip text of the trend-line. It accepts macros, plain text, and HTML tags, as string.
Whether all the trend line/zone will be displayed over data plots or under them.
Range: 0/1
Trend-lines Display Value Cosmetics
These attributes let you customize the text displayed with a trend-line.
Note: These attributes belong to the chart
object and not to the line
object (child of the trendline
object). They are, therefore, applied to all trend-lines on your chart.
Sets the font family for the trend-line display value.
Range: Font Name
Sets the font size for the trend-line display value.
Range:
Sets whether the trend-line display value will be bold formatted.
Default value: 0 (not bold formatted)
Range: 0/1
Sets whether the trend-line display value will be italicized.
Default value: 0 (not italicized)
Range: 0/1
Sets the background color for the trend-line display value.
Range: Hex Color Code
Sets the border color for the trend-line display value.
Range: Hex Color Code
Sets the transparency for the trend-line display value.
Default value: 100
Range: 0 - 100
Sets the transparency for the background of the trend-line display value.
Default value: 100
Range: 0 - 100
Sets the transparency for the border around the trend-line display value.
Default value: 100
Range: 0 - 100
Sets padding for the border around the trend-line display value.
Range: In pixels
Sets the radius for the border around the trend-line display value.
Range: In pixels
Sets the thickness for the border around the trend-line display value.
Range: In pixels
Whether the border around the trend-line display value should be rendered as dashed lines.
Default value: 0 (border rendered using straight lines)
Range: 0/1
Sets the length of each dash when the border around the trend-line display value is rendered as dashed lines.
Range: In pixels
Sets the gap between two consecutive dashes when the border around the trend-line display value is rendered as dashed lines.
Range: In pixels