ALIAS: zoomline
Example of Zoom line Chart:
JavaScript embedding code:
<script type="text/javascript"> FusionCharts.ready(function(){ var myChart = new FusionCharts({ "type": "zoomline", "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 |
---|---|---|---|
palette |
Number | 1-5 | FusionCharts XT uses the concept of Color Palettes. Each chart has 5 pre-defined color palettes which you can choose from. Each palette renders the chart in a different color theme. |
paletteColors |
String | List of hex color codes separated by comma | While 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 data items (i.e., column, line, pie etc.). Using `paletteColors` attribute, you can specify your custom list of hex colors for the data items. 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. |
connectNullData |
Boolean | 0/1 | This attribute lets you control whether empty data sets in your data will be connected to each other OR do they appear as broken data sets. |
showLabels |
Boolean | 0/1 | It sets the configuration whether the x-axis labels will be displayed or not. |
maxLabelHeight Since 3.5.0 |
Number | In Pixels | 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. |
labelDisplay |
String | 'AUTO', 'WRAP':, 'STAGGER', 'ROTATE', 'NONE' | Using this attribute, you can customize the alignment of data labels (x-axis labels). There are 5 options: AUTO, WRAP, STAGGER, ROTATE or NONE. By default, this attribute is set to AUTO mode which means that the alignment of the data labels is determined automatically depending on the size of the chart. WRAP wraps the label text if it is too long to fit in one line. ROTATE rotates the labels vertically. STAGGER divides the labels into multiple lines. |
useEllipsesWhenOverflow Since 3.2.1 |
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. |
rotateLabels |
Boolean | 0/1 | This attribute lets you set whether the data labels will show up as rotated labels on the chart. |
showValues |
Boolean | 0/1 | Sets the configuration whether data values will be displayed along with the data plot on chart. |
valuePosition Since 3.2 |
String | "ABOVE", "BELOW", "AUTO" | If you've opted to show data values on the chart, this attribute lets you adjust the vertical alignment of data values with respect to dataplots. By default, this attribute is set to AUTO mode in which the alignment of each data value is determined automatically based on the position of each plot point. In ABOVE mode, data values are displayed above the plot points unless a plot point is too close to the upper edge of the canvas while in BELOW mode, data values are displayed below the plot points unless a plot point is too close to the lower edge of the canvas. |
rotateValues |
Boolean | 0/1 | If you've opted to show data values, you can rotate them using this attribute. |
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 FusionCharts XT 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 FusionCharts XT based on the data provided by you. |
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. |
showShadow |
Boolean | 0/1 | Whether to apply the shadow effects for data plot. |
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. |
setAdaptiveYMin |
Boolean | 0/1 | This attribute lets you set whether the y-axis lower limit will be 0 (in case of all positive values on chart) or should the y-axis lower limit adapt itself to a different figure based on values provided to the chart. |
compactDataMode |
Boolean | 0/1 | Indicates whether the XML is in compact form or not. |
dataSeparator |
Character | Any character | Specifies the separation character used in compact XML. |
numMinorLogDivLines |
Number | Any number | Specifies the number of minor divisional lines to display between two major log divisions. If not specified the chart will automatically display certain number of minor divisional lines. |
allowPinMode |
Boolean | 0/1 | Used for enabling/disabling the pin mode feature, which is active by default. |
numVisibleLabels |
Number | Any number | Specifies the number of data labels that are to be visible in one screen. |
anchorMinRenderDistance |
Number | Any number | Sets the minimum distance in pixels at which to show anchors. This helps in making the chart clutter free. |
displayStartIndex |
Number | Any number > 1 | Indicates the index of the data label that will appear to the extreme left of the chart. |
displayEndIndex |
Number | Any Number > 1 | Indicates the index of the data label that is to appear at the extreme right of the chart. Using `displayStartIndex` and `displayEndIndex` attributes you can set the range of data labels that'll be visible when the chart first renders. |
pixelsPerPoint |
Number | Any number | Specifies the number of pixels to be used for producing a data point. A greater number will result in high quality display. |
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 | 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. |
Chart Caption Cosmetics
These attributes let you customize the cosmetic properties for 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 Cosmetics
These attributes let you customize chart cosmetics like the background color, background alpha, canvas color, canvas alpha etc.
Name | Type | Range | Description |
---|---|---|---|
showBorder |
Boolean | 0/1 | Whether to show a border around the chart or not. |
borderColor |
Color | 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. |
bgColor |
Color | 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 |
Number | 0-100 | If you've opted for a gradient background, this attribute lets you set the ratio of each color constituent. |
bgAngle |
Number | 0-360 | Sets the angle of the background color, in case of a gradient. |
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.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.2 |
String | top, middle, bottom | Helps you to vertically align the background image. |
bgImageHAlign Since 3.2.2 |
String | left, middle, right | Helps you to horizontally align the background image. |
bgImageScale Since 3.2.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. |
canvasBgColor |
Color | 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 |
Number | 0-100 | Helps you specify canvas background ratio for gradients. |
canvasBgAngle |
Number | 0-360 | Helps you specify canvas background angle in case of gradient. |
canvasBorderColor |
Color | Hex Code | Lets you specify canvas border color. |
canvasBorderThickness |
Number | 0-5 | Lets you specify canvas border thickness. |
canvasBorderAlpha |
Number | 0-100 | Lets you control transparency of canvas border. |
showVLineLabelBorder |
Boolean | 0/1 | If you've opted to show a label for any of your vLines in the chart, you can collectively configure whether to show border for all such labels using this attribute. If you want to show label border for just a particular vLine, you can over-ride this value by specifying border configuration for that specific vLine. |
logoURL |
String | URL | 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-300 | You can also change the scale of an externally loaded logo at run-time by specifying a value for this parameter. |
logoLink |
String | URL | 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. |
paletteThemeColor |
Color code | Any (color code without the # prefix) | Specifies a color theme that will be applied throughout the chart. |
toolbarButtonColor |
Color code | Any (color code without the # prefix) | Sets the color of the toolbar buttons. |
zoomPaneBorderColor |
Color code | Any (color code without the # prefix) | Sets the color of the zoom pane border. |
zoomPaneBgColor |
Color code | Any (color code without the # prefix) | Sets the background color of the zoom pane. |
zoomPaneBgAlpha |
Number | 0-100 | Sets the alpha of the zoom pane. |
pinLineThicknessDelta |
Number | Any number | Sets the thickness of the pinned line when the chart is put to pin line mode. |
pinPaneBgColor |
Color code | Any (color code without the # prefix) | Sets the background color of the pin pane. |
pinPaneBgAlpha |
Number | 0-100 | Sets the alpha of the pin pane. |
btnZoomOutTitle |
String | Any string | Replaces the title of the 'Zoom Out' button with the provided string. |
btnSwitchtoZoomModeTitle |
String | Any string | Replaces the title of the 'Switch to Zoom Mode' button with provided string. |
btnSwitchToPinModeTitle |
String | Any string | Replaces the title of the "Switch to Pin Mode' button with provided string. |
showToolBarButtonTooltext |
Boolean | 0/1 | Enables/disables display of tooltips for toolbar buttons. |
btnResetChartTooltext |
String | Any string | Replaces the default tooltext of the 'Reset Chart' button with provided string. |
btnSwitchToPinModeTooltext |
String | Any string. | Replaces the default tooltext of 'Switch to Pin Mode' button with provided string. |
resetChartMenuItemLabel |
String | Any string | Replaces the 'Reset Chart' menu item with provided string. |
zoomModeMenuItemLabel |
String | Any string | Replaces the 'Zoom Mode' menu item with provided string. |
pinModeMenuItemLabel |
String | Any string | Replaces the 'Pin Mode' menu item with provided string. |
toolBarBtnTextHMargin |
Number | in pixels | Sets the Horizontal margin of toolbar buttons (i.e., padding between text and button border). |
toolBarBtnHPadding |
Number | in pixels | Sets horizontal spacing between toolbar buttons. |
toolBarBtnVPadding |
Number | in pixels | Sets the vertical spacing between toolbar buttons. |
Data Plot Cosmetics
These attributes let you customize the cosmetics (columns, lines, area, pie or any data that you're plotting) of the data plots in the chart.
If the plots can show borders, you can control the border properties using the attributes listed below. Or, if they support gradient fills, you can again configure various properties of the gradient using these attributes.
Various other controls over plot cosmetics can be attained using this set of attributes.
Name | Type | Range | Description |
---|---|---|---|
lineColor |
Color | Hex Code | Color using which the lines on the chart will be drawn. |
lineThickness |
Number | In Pixels | Thickness of the lines on the chart. |
lineAlpha |
Number | 0-100 | Alpha of the lines on the chart. |
Data Value Cosmetics
These attributes let you customize the font, background, and border cosmetics of the data values on the chart.
Name | Type | Range | Description |
---|---|---|---|
valueFont |
String | Font Name | Sets the font of the values in the chart |
valueFontColor |
Color | Hex Code | Specifies the value font color |
valueFontSize |
Number | 0 - 72 | Specifies the value font size |
valueFontBold |
Boolean | 0/1 | Whether value font should be bold |
valueFontItalic |
Boolean | 0/1 | Whether value font should be italicized |
valueBgColor |
Color | Hex Code | Sets the background color for value text |
valueBorderColor |
Color | Hex Code | Sets the border color around the value text |
valueAlpha |
Number | 0-100 | Sets the value alpha including font and background |
valueFontAlpha |
Number | 0-100 | Sets the value font alpha |
valueBgAlpha |
Number | 0-100 | Sets the value background alpha |
valueBorderAlpha |
Number | 0-100 | Sets the value border alpha |
valueBorderThickness |
Number | In Pixels | Sets the value border thickness |
valueBorderRadius |
Number | In Pixels | Sets the value border radius |
valueBorderDashed |
Boolean | 0/1 | Whether the border around the value should be rendered as a dashed border |
valueBorderDashGap |
Number | In Pixels | Sets the gap between two consecutive dashes. |
valueBorderDashLen |
Number | In Pixels | Sets the length of each dash |
valueHoverAlpha |
Number | 0-100 | Sets the value alpha on hover |
valueFontHoverAlpha |
Number | 0-100 | Sets the value font alpha on hover |
valueBgHoverAlpha |
Number | 0-100 | Sets the value background alpha on hover |
valueBorderHoverAlpha |
Number | 0-100 | Sets the value border alpha on hover |
showValuesOnHover |
Boolean | 0/1 | Displays the value while dataplot on hover |
Scroll Properties
These attributes let you configure the scroll properties.
Name | Type | Range | Description |
---|---|---|---|
scrollColor |
Color | Hex Code | Color for scroll bar. |
scrollHeight |
Number | In Pixels | Required height for scroll bar. |
Anchors
Anchors (or marker points) are polygons which appear at the joint of two consecutive lines/area points. These are indicators to show the position of data points.
The anchors handle tool tips and links for the data points. So, if you opt to not render anchors on a chart, the tool tips and links won't function. You can, however, hide them by setting their transparency to 0 and still enable tool tips and links.
In area charts, anchors are set transparent by default. In case you wish to show the anchor, use anchorAlpha="100"
attribute.
These attributes let you configure and customize the anchors on your chart.
Name | Type | Range | Description |
---|---|---|---|
drawAnchors |
Boolean | 0/1 | Whether to draw anchors on the chart. |
anchorRadius |
Number | In Pixels | This attribute sets the radius (in pixels) of the anchor. |
anchorBorderColor |
Color | Hex Code | Lets you set the border color of anchors. |
anchorBorderThickness |
Number | In Pixels | Helps you set border thickness of anchors. |
anchorBgColor |
Color | Hex Code | Helps you set the background color of anchors. |
anchorBgAlpha |
Number | 0-100 | Helps you set the alpha of anchor background. |
anchorMinRenderDistance |
Number | This attribute is used for specifying the minimum distance (between dataplots) for the anchors to become visible. |
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.
The zero plane is a 2D/3D plane that signifies the 0 position on the chart. If there are no negative numbers on the chart, you won't see a visible zero plane.
Alternate color bands are colored blocks between two successive divisional lines.
These attributes let you configure the cosmetics for the divisional lines and grids.
Name | Type | Range | Description |
---|---|---|---|
divLineColor |
Color | Hex Code | Color for divisional lines. |
divLineThickness |
Number | 1-5 | 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. |
zeroPlaneColor |
Color | 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.2 - SR3 |
Boolean | 0/1 | Allows you to show or hide the value on which the zero plane exists on the y-axis. By default, the value is displayed. This attribute is not supported in JavaScript charts. |
showAlternateHGridColor |
Boolean | 0/1 | Whether to show alternate colored horizontal grid bands. |
alternateHGridColor |
Color | Hex Code | Color of the alternate horizontal grid bands. |
alternateHGridAlpha |
Number | 0-100 | Alpha (transparency) of the alternate horizontal grid bands. |
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 on the chart. |
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 | BOTTOM or RIGHT | 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 |
legendIconScale |
Number | 1-5 | Scaling of legend icon is possible in FusionCharts XT. This attribute lets you control the size of legend icon. |
legendBgColor |
Color | Hex Code | Background color for the legend. |
legendBgAlpha |
Number | 0-100 | Background alpha for the legend. |
legendBorderColor |
Color | 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. |
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 | 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. |
interactiveLegend |
Boolean | 0/1 | 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. |
legendNumColumns |
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 |
Boolean | 0/1 | Whether to minimize legend item text wrapping. |
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"`. |
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, 10434 will become 1.04K . 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 Since 3.2.2 - SR3 |
Boolean | 0/1 | Whether recursive scaling should be applied. |
maxScaleRecursion Since 3.2.2 - SR3 |
Number | How many recursions to complete during recursive scaling? -1 completes the entire set of recursion. | |
scaleSeparator Since 3.2.2 - SR3 |
String | What character to use to separate the scales that are generated after recursion? | |
numberPrefix |
String | Character | 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 | Character | Using this attribute, you could add prefix 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. |
decimalSeparator |
String | Character | This attribute helps you specify the character to be used as the decimal separator in a number. |
thousandSeparator |
String | Character | This attribute helps you specify the character to be used as the thousands separator in a number. |
thousandSeparatorPosition Since 3.2.2 - SR3 |
Number | This option helps you specify the position of the thousand separator. | |
decimals |
Number | 0-10 | 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 limit the maximum number of decimal digits to 2, a number like 55.345 will be rounded to 55.34. This does not mean that all numbers will be displayed with a fixed number of decimal places. For instance 55 will not be displayed as 55.00 and 55.1 will not become 55.10. In order to have fixed number of decimal places attached to all the numbers, set this attribute to 1. |
forceYAxisValueDecimals Since 3.2 |
Boolean | 0/1 | Whether to forcefully attach decimal places to all y-axis values. For example, If you limit the maximum number of decimal digits to 2, a number like 55.345 will be rounded to 55.34. This does not mean that all y-axis numbers will be displayed with a fixed number of decimal places. For instance 55 will not be displayed as 55.00 and 55.1 will not become 55.10. In order to have fixed number of decimal places attached to all y-axis numbers, set this attribute to 1. |
yAxisValueDecimals |
Number | 0-10 | If you've opted to not adjust div lines, you can specify the div line values decimal precision using this attribute. |
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 |
String | 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 | 0-72 | 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 | 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 |
String | 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 | 0-72 | 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 | 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. |
Tool-tip Properties
These attributes let you configure the functional and cosmetic properties of tool-tips.
Name | Type | Range | Description |
---|---|---|---|
showToolTip Since 3.6.0 |
Boolean | 0/1 | Whether to show tool tip on chart. |
toolTipBgColor Since 3.6.0 |
Color | Hex Code | Background color for tool tip. |
toolTipColor |
Color Code | Hex Code | Font color for the tool-tip. |
toolTipBorderColor Since 3.6.0 |
Color | Hex Code | Border color for tool tip. |
toolTipSepChar Since 3.6.0 |
String | The character specified as the value of this attribute separates the name and value displayed in tool tip. | |
useCrossLine Since 3.6.0 |
Boolean | 0/1 | There are two ways of displaying tool-tips in a zoomline chart. One is to use a cross-line, which is a vertical line that displays data values for all series on that data point. The other way is to use traditional tool-tips that display values on a data point when hovered upon. Default value is 1 which uses cross-line. Set this attribute value to 0 to use traditional tool-tips. |
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 it, you can apply the hover effects to a data plot.
These attributes let you configure the hover effect for all data plots in the chart.
Name | Type | Range | Description |
---|---|---|---|
showHoverEffect |
Boolean | 0/1 | Whether to enable hover effect on charts for all elements |
plotHoverEffect |
Boolean | 0/1 | Whether to enable hover effect on charts for data plots (e.g., column, pie) only |
plotFillHoverColor |
Color | Hex Code | Specifies the hover color for the data plots |
plotFillHoverAlpha |
Number | 1 - 100 | Specifies the hover alpha for data plots |
Chart Paddings & Margins
FusionCharts 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 FusionCharts 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, FusionCharts XT will not plot anything in that space.
It is not necessary for you to specify any padding/margin values. FusionCharts 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. |
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. |
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. |
legendPadding |
Number | In Pixels | Padding of legend from right/bottom side of canvas |
canvasLeftMargin |
Number | In Pixels | This attribute lets you control the space between the start of chart canvas and the start (x) of chart. In case of 2D charts, the canvas is the visible rectangular box. In case of 3D charts, the canvas box is the imaginary box around the 3D canvas. Using this attribute, you can control the amount of empty space between the chart left side and canvas left side. By default, FusionCharts XT automatically calculates this space depending on the elements to be placed on the chart. However, if you want to over-ride this value with a higher value, you can use this attribute to specify the same. Please note that you cannot specify a margin lower than what has been calculated by the chart. This attribute is particularly useful, when you've multiple charts placed in a page and want all their canvas start position to align with each other - so in such a case, you can set same margin value (a value large enough that it doesn't get rejected by chart owing to it being lower than the calculated value) for all such charts in the page. |
canvasRightMargin |
Number | In Pixels | Like `canvasLeftMargin`, this attribute lets you set the space between end of canvas and end of chart. |
canvasTopMargin |
Number | In Pixels | Like `canvasLeftMargin`, this attribute lets you set the space between top of canvas and top of chart. |
canvasBottomMargin |
Number | In Pixels | Like `canvasLeftMargin`, this attribute lets you set the space between bottom of canvas and bottom of chart. |
The <categories> Element
These attributes of the <categories> element let you control the font properties of data labels. It can also be used to define the cosmetics of vertical chart lines.
Name | Type | Range | Description |
---|---|---|---|
font |
String | Valid font face | 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 | Hex Code | Lets you specify font color for the x-axis data labels. |
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 | Hex Code | This attribute sets the color using which line of that dataset will be drawn |
alpha |
String | 0-100 or Comma Separated List | This attribute sets the alpha (transparency) of the entire dataset. |
showValues |
Boolean | 0/1 | Whether to show the values for this dataset. |
valuePosition Since 3.2 |
String | "ABOVE", "BELOW", "AUTO" | This attribute lets you adjust the vertical alignment of data values for all dataplots in the dataset. The alignment is set with respect to the position of the dataplots on the chart. By default, the attribute is set to AUTO mode in which the alignment of each data value is determined automatically based on the position of each plot point. In ABOVE mode, data values are displayed above the plot points unless a plot point is too close to the upper edge of the canvas. While in BELOW mode, data values are displayed below the plot points unless a plot point is too close to the lower edge of the canvas. The attribute will function only if showValue attribute is set to 1 in this particular dataset. |
drawAnchors |
Boolean | 0/1 | Whether to draw anchors for the particular dataset. |
anchorRadius |
Number | In Pixels | This attribute sets the radius (in pixels) of the anchors of the particular dataset. |
lineThickness |
Number | In Pixels | Thickness of the lines for the particular dataset. |
anchorBorderColor |
Color | Hex Code | Lets you set the border color of anchors of the particular dataset. |
anchorBorderThickness |
Number | In Pixels | Helps you set border thickness of anchors of the particular dataset. |
anchorBgColor |
Color | Hex Code | Helps you set the background color of anchors of the particular dataset. |
anchorBgAlpha |
Number | 0-100 | Helps you set the alpha of anchor background of the particular dataset. |
includeInLegend |
Boolean | 0/1 | Whether to include the seriesName of this dataset in legend. |
dashed |
Boolean | 0/1 | Whether the line should 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 multi-series chart, a typical <set> element will look like:
<dataset seriesName='2006'> <set value='35445' /> <set value='35675' /> .... and so on .... </dataset>
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. | |
displayValue |
String | If instead of the numerical value of this data, you wish to display a custom string value, you can specify the same here. Examples are annotation for a data item etc. | |
toolText |
String | By default, FusionCharts XT shows the value as tool tip text for that data item. But, if you want to display more information for the data item as tool tip, you can use this attribute to specify the same. |
Vertical Trend-lines and Trend-zones
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 |
---|---|---|---|
startIndex |
Number | Numeric Value | The starting index for the vertical trendline. Index represents the relative position of a data-point from the first data-point. The index of the first data-point is 1. A vertical trendzone is created when both `startIndex` and `endIndex `attributes are specified. In case, only `startIndex` is specified, a vertical trendline is drawn. |
endIndex |
Number | Numeric Value | The end index for the vertical trendline. Index represents the relative position of a data-point from the first data-point. The index of the first data-point is 1. A vertical trendzone is created when both `startIndex` and `endIndex `attributes are specified. In case, only `startIndex` is specified, a vertical trendline is drawn. |
displayValue |
String | If you want to display a string caption for the vertical trendline/zone, you can use this attribute. Example:` displayValue='Last Month High'`. By default, the value is shown as the top of the vertical trendline/zone. | |
displayAlways |
Boolean | 0/1 | It allows you to show or hide the vertical trendline/zone in macroscopic view. By default, it is set to 1 which makes the vertical trendline/zone visible in both microscopic and macroscopic views. If you set it to '0,' it will hide the vertical trendline in macroscopic view. |
displayWhenCount |
Number | Numeric Value | The `displayWhenCount` attribute sets the condition for visibility of the vertical trendline. For example, if the value of this attribute is set to `10`, the vertical trendline will be visible only if 10, or less than 10 dataplots are displayed on a single screen. The value of the `displayWhenCount` can be any number, which is greater than 1 and less than the total number of dataplots that are plotted on the chart. |
color |
String | Hex Code | Color of the vertical trendline and its associated text |
showOnTop |
Boolean | 0/1 | Whether the vertical trendline will appear on top of the dataplots. By default, it is set to 0. |
thickness |
Number | In Pixels | If you've opted to show the trend as a line, this attribute lets you define the thickness of the line. |
alpha |
Number | 0-100 | Alpha of the vertical trendline/zone. |
valueOnTop |
String | Allows you to display the value of the trendline/zone at the top of the trendline/zone. By default, it is set to '1'. Thus, the value appears on the top of the trendline. If you set it to '0' the value will appear at the bottom of the trendline/zone. |
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 |
---|---|---|---|
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. |
color |
String | Hex Code | Color of the trend line and its associated text |
isTrendZone |
Boolean | 0/1 | Whether the trend will be displayed as a line or a zone (fill-colored rectangle). |
showOnTop |
Boolean | 0/1 | Whether the trend line/zone will be displayed over data plots or under them. |
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. |
alpha |
Number | 0-100 | Alpha of the trend line. |
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. |
startValue |
Number | Numeric Value | 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 | Numeric Value | 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`. | |
toolText |
String | Custom tool-text for this trendline/zone. |