Real-time Stacked Column

ALIAS: realtimestackedcolumn

Example of Real Time Stacked Column Chart:

FusionCharts should load here..

JavaScript embedding code:

    <script type="text/javascript">
    FusionCharts.ready(function(){
        var myChart = new FusionCharts({
            "type": "realtimestackedcolumn",
            "dataFormat": "jsonurl",
            "dataSource": "chartdata.json"
        });
    });
    </script>

Data for this chart:

...

Chart Attributes

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, y-axis values. You can also set chart limits and extended properties.

Name Type Range Description
animation Boolean 0/1 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.
clickURL URL in FusionCharts format 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.
palette Number 1-5 Each chart has 5 pre-defined color palettes which you can choose from. Each palette renders the chart in a different color theme.
paletteThemeColor Color Code Hex Code 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.
paletteColors String List of hex color codes separated by comma 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.
showRTMenuItem Boolean 0/1 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 `<chart>` element. 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.
showPrintMenuItem Boolean 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.
useRoundEdges
Since 3.2
Boolean 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.
refreshInstantly
Since 3.2
Boolean 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.
stack100Percent
Since 3.2
Boolean 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%.
showPercentValues
Since 3.2
Boolean 0/1 Whether to show percentage figures in data values of the chart.
showPercentInToolTip
Since 3.2
Boolean 0/1 Whether to show percentage figures in tooltip.
manageResize
Since 3.2
Boolean 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.
useEllipsesWhenOverflow
Since 3.2
Boolean 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.

Chart Titles and Axis Names

These attributes let you customize the various headings and titles for a chart, like the caption, sub-caption, x-axis and y-axis names etc.

Name Type Range Description
caption String Caption of the chart.
subCaption String Sub-caption of the chart.
xAxisName String X-axis title of the chart.
yAxisName String Y-axis title of the chart.
rotateYAxisName Boolean 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.
yAxisNameWidth Number In pixels If you opt to not rotate y-axis name, you can choose a maximum width that will be applied to y-axis name.

Chart Caption Cosmetics

These attributes let you customize the cosmetic properties of the chart caption and sub-caption.

Name Type Range Description
captionAlignment String "left", "center", "right" Sets horizontal alignment of caption
captionOnTop Boolean 0/1 Whether caption should be on top of the data plot area
captionFontSize Number 0 - 72 Sets the caption font size in pixels
subCaptionFontSize Number 0 - 72 Sets the sub-caption font size (in pixels)
captionFont String Font Name Sets the caption font family
subCaptionFont String Font Name Sets the sub-caption font family
captionFontColor Color Hex Code Sets the caption font color
subCaptionFontColor Color Hex Code Sets the sub-caption font color
captionFontBold Boolean 0/1 Whether the caption font should be displayed in bold
subCaptionFontBold Boolean 0/1 Whether the sub caption font should be displayed in bold
alignCaptionWithCanvas Boolean 0/1 Whether the caption is aligned with the canvas. Else, it will be aligned with the entire chart area
captionHorizontalPadding Number In Pixels If caption is not centre aligned, lets you configure the padding (in pixels) from either edge. Will be ignored if caption is centre aligned.

X-axis Name Cosmetics

These attributes let you control the cosmetic properties for the x-axis label.

Name Type Range Description
xAxisNameFontColor Color Hex Code Sets the x-axis font color
xAxisNameFontSize Number 0 - 72 Specifies the x-axis font size
xAxisNameFontBold Boolean 0/1 Whether x-axis font should be bold
xAxisNameFontItalic Boolean 0/1 Whether x-axis font should be italicized
xAxisNameBgColor Color Hex Code Sets the background color for x-axis text
xAxisNameBorderColor Color Hex Code Sets the border around the x-axis text
xAxisNameAlpha Number 0-100 Sets the x-axis alpha including font and background
xAxisNameFontAlpha Number 0-100 Sets the x-axis font alpha
xAxisNameBgAlpha Number 0-100 Sets the x-axis background alpha
xAxisNameBorderAlpha Number 0-100 Sets the x-axis border alpha
xAxisNameBorderPadding Number In Pixels Sets the x-axis border padding
xAxisNameBorderRadius Number In Pixels Sets the x-axis border radius
xAxisNameBorderThickness Number In Pixels Sets the x-axis border thickness
xAxisNameBorderDashed Boolean 0/1 Whether the x-axis border should be rendered using dashed lines
xAxisNameBorderDashLen Number In Pixels Sets the length of each dash
xAxisNameBorderDashGap Number In Pixels Sets the gap between two consecutive dashes.

Y-axis Name Cosmetics

These attributes let you control the cosmetic properties for the y-axis label.

Name Type Range Description
yAxisNameFont String Font Name Sets the y-axis (primary / secondary) font family for the text
yAxisNameFontColor Color Hex Code Sets the y-axis (primary / secondary) font color
yAxisNameFontSize Number 0 - 72 Specifies the y-axis (primary / secondary) font size
yAxisNameFontBold Boolean 0/1 Whether y-axis (primary / secondary) font should be bold
yAxisNameFontItalic Boolean 0/1 Whether y-axis (primary / secondary) font should be italicized
yAxisNameBgColor Color Hex Code Sets the background color for y-axis (primary / secondary) text
yAxisNameBorderColor Color Hex Code Sets the border around the y-axis (primary / secondary) text
yAxisNameAlpha Number 0-100 Sets the y-axis (primary / secondary) alpha including font and background
yAxisNameFontAlpha Number 0-100 Sets the y-axis (primary / secondary) font alpha
yAxisNameBgAlpha Number 0-100 Sets the y-axis (primary / secondary) background alpha
yAxisNameBorderAlpha Number 0-100 Sets the y-axis (primary / secondary) border alpha
yAxisNameBorderPadding Number In Pixels Sets the y-axis (primary / secondary) border padding
yAxisNameBorderRadius Number In Pixels Sets the y-axis (primary / secondary) border radius
yAxisNameBorderThickness Number In Pixels Sets the y-axis (primary / secondary) border thickness
yAxisNameBorderDashed Boolean 0/1 Whether y-axis (primary / secondary) border should be rendered using dashed lines
yAxisNameBorderDashLen Number In Pixels Sets the length of each dash
yAxisNameBorderDashGap Number In Pixels Sets the gap between two consecutive dashes.

Chart Y-Axis

These attributes let you configure the functional properties of the y-axis.

Name Type Range Description
yAxisMaxValue Number 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.
yAxisMinValue Number Numeric Value 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.
showYAxisValues Boolean 0/1 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.
showLimits Boolean 0/1 Whether to show chart limit values. If not specified `showYAxisValues` attribute overrides this value.
showDivLineValues Boolean 0/1 Whether to show div line values. If not specified `showYAxisValues` attribute overrides this value.
yAxisValuesStep Number By default, all div lines show their values. However, you can opt to display every x(th) div line value using this attribute.
yAxisValueDecimals Number Decimal places for y-axis values.
forceYAxisDecimals Boolean 0/1 Whether to force decimal places for y-axis values.

Chart Labels and 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.

These attributes let you configure the functional and cosmetic properties of chart labels and values.

Name Type Range Description
showLabels Boolean 0/1 It sets the configuration whether the x-axis labels will be displayed or not.
labelDisplay String 'AUTO', 'WRAP':, 'STAGGER', 'ROTATE', 'NONE' 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.
slantLabels Boolean 0/1 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.
labelStep Number 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.
staggerLines Number 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.
showValues Boolean 0/1 Sets the configuration whether data values will be displayed along with the data plot on chart.
placeValuesInside Boolean 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.
rotateValues Boolean 0/1 If you've opted to show data values, you can rotate them using this attribute.
showSum Boolean 0/1 If you want to show sum of all the columns in a given stacked column, set this attribute to 1.

Real-time Properties

The real-time feature allows you to update data for a chart at specified intervals, without any page refreshes. These attributes let you configure the real-time feature.

Name Type Range Description
dataStreamURL URL 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.
refreshInterval Number 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.
clearChartInterval Number The time after which the chart will keep clearing its contents.
updateInterval Number 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`).
numDisplaySets Number 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.
dataStamp String 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
showRealTimeValue Boolean 0/1 This parameter lets you set whether you want the latest value (received from server) to be displayed on the chart or not.
realTimeValueSep String 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

FusionCharts XT offers you a lot of options to format your numbers on the chart.

These attributes let you 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

These attributes let you appropriately format the numbers displayed on the chart.

Name Type Range Description
formatNumber Boolean 0/1 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"`.
numberPrefix String 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.
numberSuffix String 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.
decimals Number Number of decimal places to which all numbers on the chart will be rounded to.
forceDecimals Boolean 0/1 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).
formatNumberScale Boolean 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.
defaultNumberScale String The default unit of the numbers that you're providing to the chart.
numberScaleUnit String Unit of each block of the scale.
numberScaleValue String Range of the various blocks that constitute the scale.
scaleRecursively Boolean 0/1 Whether recursive scaling should be applied.
maxScaleRecursion Number How many recursions to complete during recursive scaling? -1 completes the entire set of recursion.
scaleSeparator String What character to use to separate the scales that are generated after recursion?
decimalSeparator String This attribute helps you specify the character to be used as the decimal separator in a number.
thousandSeparator String This attribute helps you specify the character to be used as the thousands separator in a number.
thousandSeparatorPosition
Since 3.2 - SR1
Number This option helps you specify the position of the thousand separator.
inDecimalSeparator String 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.
inThousandSeparator String 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 uses the 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. These attributes let you to configure the message logger.

Name Type Range Description
useMessageLog Boolean 0/1 Whether to use message logger for the chart?
messageLogWPercent Number In percent 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.
messageLogHPercent Number In percent This attribute lets you set the height percent of the message logger window w.r.t entire chart height.
messageLogShowTitle Boolean 0/1 Whether to show the title for message logger?
messageLogTitle String 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.
messageLogColor Color Code Hex Code You can customize the color of the entire message log window by setting a hex value for this attribute.
messageGoesToLog Boolean 0/1 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.
messageGoesToJS Boolean 0/1 This attribute lets you configure whether each message streamed from the server should be passed to a local JavaScript function.
messageJSHandler String 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.
messagePassAllToJS Boolean 0/1 Whether to pass all message envelope parameters to the custom JavaScript function.

Plot (Column) Properties

These attributes let you customize the cosmetic properties of the plot (column).

Name Type Range Description
showShadow Boolean 0/1 Whether to apply the shadow effects for data plot?
showPlotBorder Boolean 0/1 Whether the column border will show up.
plotBorderColor Color Code Hex Code Color for border
plotBorderThickness Number In pixels Border thickness.
plotBorderAlpha Number 0-100 Border alpha.
plotBorderDashed Boolean 0/1 Whether border will appear as dashed?
plotBorderDashLen Number 0/1 If dashed, then what will be length of dash?
plotBorderDashGap Number In pixels Sets the gap between two consecutive dashes.
plotFillAngle Number 0-360 If you've opted to fill the plot as gradient, this attribute lets you set the fill angle for gradient.
plotFillRatio Numbers separated by comma If you've opted to fill the plot as gradient, this attribute lets you set the fill ratio for gradient.
plotFillAlpha Number 0-100 If you've opted to fill the plot as gradient, this attribute lets you set the fill alpha for gradient.
plotGradientColor Color Code Hex Code 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.

Chart Cosmetics

These attributes let you customize chart cosmetics like the background color, background alpha, canvas color, canvas alpha etc.

Name Type Range Description
bgColor Color Code Hex Code 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`.
bgAlpha Number 0-100 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.
bgRatio Numbers separated by comma If you've opted for a gradient background, this attribute lets you set the ratio of each color constituent.
bgAngle Number 0-360 Angle of the background color, in case of a gradient.
showBorder Boolean 0/1 Whether to show a border around the chart or not?
borderColor Color Code Hex Code Border color of the chart.
borderThickness Number In pixels Border thickness of the chart.
borderAlpha Number 0-100 Border alpha of the chart.
bgImage String 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.
bgImageAlpha Number 0-100 This attribute specifies the opacity for the loaded background image.
bgImageDisplayMode
Since 3.2
String 'stretch', 'tile', 'fit', 'fill', 'center', 'none' 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.
bgImageVAlign
Since 3.2
String 'top', 'middle', 'bottom' Helps you to vertically align the background image.
bgImageHAlign
Since 3.2
String 'left', 'middle', 'right' Helps you to horizontally align the background image.
bgImageScale
Since 3.2
Number 0-300 Helps you magnify the background image. This attribute will only work when the attribute `bgImageDisplayMode` is set to none, center, or tile.
xAxisLineColor Color Code Hex Code Sets color of the x-axis of the chart.
logoURL String 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.
logoPosition String 'TL', 'TR', 'BL', 'BR', 'CC' Where to position the logo on the chart: TL - Top-left TR - Top-right BR - Bottom right BL - Bottom left CC - Center of screen
logoAlpha Number 0-100 Once the logo has loaded on the chart, you can configure its opacity using this attribute.
logoScale Number 0-100 You can also change the size of externally loaded logo at run-time by specifying a value for this parameter.
logoLink String 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.

These attributes let you customize the cosmetic properties of the chart canvas.

Name Type Range Description
canvasBgColor Color Code Hex Code Sets Canvas background color. For Gradient effect, enter colors separated by comma.
canvasBgAlpha Number 0-100 Sets alpha for Canvas Background. For gradient, enter alpha list separated by commas.
canvasBgRatio Numbers separated by comma Helps you specify canvas background ratio for gradients.
canvasBgAngle Number 0-360 Helps you specify canvas background angle in case of gradient.
canvasBorderColor Color Code Hex Code Lets you specify canvas border color.
canvasBorderThickness Number In pixels Lets you specify canvas border thickness.
canvasBorderAlpha Number 0-100 Lets you control transparency of canvas border.

Divisional Lines and Grids

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.

These attributes let you configure the cosmetics of the divisional lines and grids.

Name Type Range Description
numDivLines Number Number of horizontal axis division lines that you want on the chart.
divLineColor Color Code Hex Code Color for divisional lines.
divLineThickness Number In pixels Thickness of divisional lines.
divLineAlpha Number 0-100 Alpha of divisional lines.
divLineDashed Boolean 0/1 Whether the divisional lines should be displayed as dashed lines instead of whole lines.
divLineDashLen Number In pixels If the divisional lines are to be displayed as dashed lines, this attribute lets you control the length of each dash.
divLineDashGap Number In pixels Sets the gap between two consecutive dashes.
showAlternateHGridColor Boolean 0/1 Whether to show alternate colored horizontal grid bands?
alternateHGridColor Color Code Hex Code Color of the alternate horizontal grid bands.
alternateHGridAlpha Number 0-100 Alpha (transparency) of the alternate horizontal grid bands.

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.

These attributes let you customize the cosmetic properties of the zero plane.

Name Type Range Description
zeroPlaneColor Color Code Hex Code 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.
zeroPlaneThickness Number In pixels Thickness of zero plane.
zeroPlaneAlpha Number 0-100 Alpha of zero plane.
showZeroPlaneValue
Since 3.2
Boolean 0/1 To display the value of the zero plane set this attribute to 1.

Font Properties

These attributes let you define the generic font properties for all the text on the chart, allowing you a high level control over font properties.

Name Type Range Description
baseFont Font Name 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.
baseFontSize Number 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.
baseFontColor Color Code Hex Code 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.
outCnvBaseFont Font Name 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.
outCnvBaseFontSize Number 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.
outCnvBaseFontColor Color Code Hex Code 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.
realTimeValueFont Font Name If real time value is to be displayed on the chart, this attribute lets you set the font face of the same.
realTimeValueFontSize Number If real time value is to be displayed on the chart, this attribute lets you set the font size of the same.
realTimeValueFontColor Color Code Hex Code If real time value is to be displayed on the chart, this attribute lets you set the font color of the same.

Legend Properties

In multi-series charts, by default, the series name of each dataset 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 legends you can correlate a data plot to its series name using its color representation in the legend.

These attributes let you configure the functional and cosmetic properties of the legend.

Name Type Range Description
showLegend Boolean 0/1 Whether to show legend for the chart (only multi-series and combination charts)?
legendItemFontBold Boolean 0/1 Whether legend keys should be displayed in bold
legendItemFont String Font Name Sets legend item font
legendItemFontSize Number 0 - 72 Sets legend item font size
legendItemFontColor Color Hex Code Sets legend item font color
legendPosition String 'RIGHT' or 'BOTTOM' The legend can be plotted at two positions on the chart - below (BOTTOM) the chart and to the right (RIGHT) of the chart.
legendCaptionAlignment String "left", "center", "right" Sets the legend caption horizontal alignment .
legendCaptionBold Boolean 0/1 Whether legend caption should be displayed in bold
legendCaptionFont String Font Name Sets legend caption font
legendCaptionFontSize Number 0 - 72 Sets legend caption font size
legendCaptionFontColor Color Hex Code Sets legend caption font color
legendItemHiddenColor Color Hex Code Sets the color that applies on both text font and icon when they are in a disabled / hidden state
legendCaption String You can add a caption for the entire legend by setting the same here.
legendBorderColor Color Code Hex Code Border Color for the legend.
legendBorderThickness Number In pixels Border thickness for the legend.
legendBorderAlpha Number 0-100 Border alpha for the legend.
legendBgColor Color Code Hex Code Background color for the legend.
legendBgAlpha Number 0-100 Background alpha for the legend.
legendShadow Boolean 0/1 Whether to show a shadow for legend?
legendAllowDrag Boolean 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.
legendScrollBgColor Color Code Hex Code 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.
reverseLegend Boolean 0/1 You can reverse the ordering of datasets in the legend by setting this attribute to 1.
legendIconScale
Since 3.2
Number 1-5 Scaling of legend icon is possible starting FusionWidgets XT. This attribute lets you control the size of legend icon.
legendNumColumns
Since 3.2
Number positive integer 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.
minimiseWrappingInLegend
Since 3.2
Boolean 0/1 Whether to minimize legend item text wrapping.

Tool-tip Properties

These attributes let you configure the functional and cosmetic properties of tool-tips.

Name Type Range Description
showToolTip Boolean 0/1 Whether to show tooltip on chart?
seriesNameInToolTip Boolean 0/1 This attribute lets you control whether series name will show up in tooltip or not.
toolTipBgColor Color Code Hex Code Background color for tooltip.
toolTipColor Color Code Hex Code Font color for the tool-tip.
toolTipBorderColor Color Code Hex Code Border color for tooltip.
toolTipSepChar String The character specified as the value of this attribute separates the name and value displayed in tooltip.
showToolTipShadow Boolean 0/1 Whether to show shadow for tooltips.

Chart Paddings and Margins

FusionWidgets XT allows you to 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).

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. That means, FusionWidgets XT will not plot anything in that space.

It is not necessary for you to specify any padding/margin values. FusionWidgets XT automatically assumes the best values for the same.

These attributes let you configure the functional and cosmetic properties of chart paddings and margins.

Name Type Range Description
captionPadding Number In pixels 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.
xAxisNamePadding Number 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).
yAxisNamePadding Number 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).
yAxisValuesPadding Number 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.
labelPadding Number 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.
valuePadding Number 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.
plotSpacePercent Number 20%-80% 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.
realTimeValuePadding Number In pixels Vertical distance between the real-time value and x-axis labels.
legendPadding Number In pixels Padding of legend from right/bottom side of canvas
chartLeftMargin Number In pixels Amount of empty space that you want to put on the left side of your chart. Nothing is rendered in this space.
chartRightMargin Number In pixels Amount of empty space that you want to put on the right side of your chart. Nothing is rendered in this space.
chartTopMargin Number In pixels Amount of empty space that you want to put on the top of your chart. Nothing is rendered in this space.
chartBottomMargin Number In pixels Amount of empty space that you want to put at the bottom of your chart. Nothing is rendered in this space.
canvasLeftMargin Number In pixels Left margin of canvas. Canvas will start from that position.
canvasRightMargin Number In pixels Right margin of canvas. Canvas will end at that position.
canvasTopMargin Number In pixels Top margin of canvas.
canvasBottomMargin Number In pixels Bottom margin of canvas.

The <categories> Element

The <categories> element lets you bunch together x-axis labels of the chart. For a multi-series chart, it's necessary to provide data labels using <category> elements under <categories> element. The following properties of <categories> element help you control the font properties of data labels.

Name Type Range Description
font String Lets you specify font face for the x-axis data labels.
fontSize Number Lets you specify font size for the x-axis data labels.
fontColor Color Code Hex Code Lets you specify font color for the x-axis data labels.

The <category> Element

Each <category> element represents an x-axis data label. In multi-series charts, it's necessary to provide an equal number of <category> elements and data items (<set> elements within each <dataset>).

These attributes let you configure the <category> element.

Name Type Range Description
label String This attribute determines the label for the data item. The label appears on the x-axis of chart.
showLabel Boolean 0/1 You can individually opt to show/hide labels of individual data items using this attribute.
tooltext String The tooltip defined in the `<category>` element 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>` element. The tooltip with the full label will appear only when the mouse is hovered on the dataplot.

Vertical Data Separator Lines

vLines are vertical separator lines that help you separate blocks of data. These lines run through the height of the chart, thereby segregating data into different blocks.

Use the code snippet shown below to render a vertical trend-line on the chart:

    "data": [{
        ...
    },
    {
        "linePosition": "0.8",
        "vLine": "true"
    },
    ...

These attributes let you configure the functional and cosmetic properties for vertical trend-lines and trend-zones.

Name Type Range Description
label String Display label for the vLine.
color Color Code Hex Code This attribute defines the color of vertical separator line
thickness Number In pixels Thickness in pixels of the vertical separator line.
alpha Number 0-100 Alpha of the vertical separator line.
dashed Boolean 0/1 Whether the vertical separator line should appear as dashed?
dashLen Number In pixels If the vertical separator line is to appear as dashed, this attribute defines the length of dash.
dashGap Number In pixels If the vertical separator line is to appear as dashed, this attribute defines the length of dash gap.

The <dataset> Element

Each <dataset> element contains a series of data.You can provide data-set level cosmetics so that all data within that data-set will be plotted in the same color/alpha/etc.

These attributes let you customize the cosmetic properties for a data-set.

Name Type Range Description
seriesName String 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.
color Color Code Hex Code 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
alpha Number 0-100 This attribute sets the alpha (transparency) of the entire dataset.
showValues Boolean 0/1 Whether to show the values for this dataset?
includeInLegend Boolean 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.
checkForAlerts Boolean 0/1 Whether to run the values of this dataset through alert manager, each time an update is received?
dashed Boolean 0/1 Whether this dataset border will appear as dashed?

The <set> Element

Each <set> element (child of <dataset> element) represents a set of data which is to be plotted on the graph and determines a set of data which will appear on the chart.

For a single series chart, a typical <set> element will look like:

<set label='January' value='17400' />

These attributes let you configure individual data values in a data-set.

Name Type Range Description
value Number Numerical value for the data item. This value will be plotted on the chart.
link String 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.
toolText String 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.
color Color Code Hex Code 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.
alpha Number 0-100 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.
showValue Boolean 0/1 You can individually opt to show/hide values of individual data items using this attribute. This value over-rides the dataset level value.
dashed Boolean 0/1 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.

Trend-lines

Using the <trendlines> element (and the children <line> elements), you can define trend lines on the chart.

Trend lines are horizontal lines spanning the chart canvas which aid in interpretation of data with respect to some pre-determined value. For example, if you are plotting sales data of current year, you might want to add previous year's average monthly sales as trend indicator for ease of comparison.

Use the code snippet shown below to render a horizontal trend-line on the chart:

    ...
    "chart": {
                ...
        };

    "trendlines": [{
          "line": [{
              "startvalue": "177500",
              "color": "#00cc00",
              "displayvalue": "Target"
         }]
    }]

    ...

These attributes let you customize the functional and cosmetic properties for trend-lines.

Name Type Range Description
startValue Number 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.
endValue Number 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`.
displayValue String 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`.
color Color Code Hex Code Color of the trend line and its associated text
thickness Number In pixels If you've opted to show the trend as a line, this attribute lets you define the thickness of trend line.
isTrendZone Boolean 0/1 Whether the trend will be displayed as a line or a zone (fill-colored rectangle).
alpha Number Alpha of the trend line.
showOnTop Boolean 0/1 Whether the trend line/zone will be displayed over data plots or under them?
dashed Boolean 0/1 If you've opted to show the trend as a line, this attribute lets you define whether the trend line will appear as dashed?
dashLen Number In pixels If you've opted to show trend line as dash, this attribute lets you control the length of each dash.
dashGap Number In pixels If you've opted to show trend line as dash, this attribute lets you control the length of each dash gap.
valueOnRight Boolean 0/1 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.