ALIAS: selectscatter
Example of Select Scatter Chart:
JavaScript embedding code:
<script type="text/javascript"> FusionCharts.ready(function(){ var myChart = new FusionCharts({ "type": "selectscatter", "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. |
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. |
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 (that is, 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. |
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 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 |
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 would show up as rotated labels on the chart. |
slantLabels |
Boolean | 0/1 | If you have opted to show rotated labels on chart, this attribute lets you set the configuration whether the labels would show as slanted labels or fully vertical ones. |
labelStep |
Number | 1 or above | By default, all the labels are displayed on the chart. However, if you have a set of streaming data (like name of months or days of week), you can opt to show every n-th label for better clarity. This attribute just lets you do so. It allows to display every n(th) x-axis label. |
staggerLines |
Number | 2 or above | If you have 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 would be displayed along with the data plot on chart. |
showLimits |
Boolean | 0/1 | Whether to show chart limit values. If not specified `showYAxisValues` overrides this attribute. |
showDivLineValues |
Boolean | 0/1 | Whether to show div line values. If not specified `showYAxisValues` overrides this attribute. |
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. |
rotateValues |
Boolean | 0/1 | If you have opted to show data values, you can rotate them using this attribute. |
xAxisMaxValue |
Number | Numeric Value | The scatter chart has both x and y axis as numeric. This attribute lets you explicitly set the x-axis upper limit. If you do not specify this value, the chart will automatically calculate the best value for you. |
xAxisMinValue |
Number | Numeric Value | The scatter chart has both x and y axis as numeric. This attribute lets you explicitly set the x-axis lower limit. If you do not specify this value, the chart will automatically calculate the best value for you. |
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. |
showPrintMenuItem |
Boolean | 0/1 | When you right click on the chart it shows a context menu. This attribute allows you to show or hide the "Print" option in the context menu. |
unescapeLinks |
Boolean | 0/1 | Internally the chart decodes a Url that you set as link. Before invoking the link it again encodes the Url. If you are passing multilingual characters via a Url or do not want this decode-encode mechanism to be handled by chart you can set,`unescapeLinks='0'`. |
yAxisValuesStep |
Number | 1 or above | By default, all div lines show their values. However, you can opt to display every x(th) div line value using this attribute. |
adjustDiv |
Boolean | 0/1 | The chart automatically tries to adjust divisional lines and limit values based on the data provided. However, if you want to set your explicit lower and upper limit values and number of divisional lines, first set this attribute to false. That would disable automatic adjustment of divisional lines. |
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 have special characters (UTF8) 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. |
clickURL |
String | 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. | |
setAdaptiveYMin |
Boolean | 0/1 | This attribute lets you set whether the y-axis lower limit would 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. |
setAdaptiveXMin Since 3.2.1 |
Boolean | 0/1 | This attribute lets you set whether the x-axis lower limit will be 0 (in case of all positive values on chart) or should the x-axis lower limit adapt itself to a different figure based on values provided to the chart. |
showRegressionLine Since 3.2.1 |
Boolean | 0/1 | This attribute when set to '1' draws regression lines for all the datasets in the chart. |
showYOnX Since 3.2.1 |
Boolean | 0/1 | When it is set to '1' the regression lines are drawn using Y On X mode and when the attribute is set to '0' the regression lines are drawn using X On Y mode. By default, this attribute is set to '1'. |
regressionLineColor Since 3.2.1 |
Color | Hex Code | This attribute allows you to set the color of all the regression lines in a chart. |
regressionLineThickness Since 3.2.1 |
Number | This attribute allows you to set the thickness of all the regression lines in a chart. | |
regressionLineAlpha Since 3.2.1 |
Number | 0-100 | This attribute allows you to set the transparency of all the regression lines in a chart. |
xAxisLabelMode Since 3.2.1 |
String | AUTO CATEGORIES MIXED | This attribute is used to render the x-axis labels in three different modes. The modes are as following: AUTO - Allows the x-axis labels to inherit the properties of y-axis (numeric calculations), ignoring the properties of the `<categories>` element if present in the data. CATEGORIES - This mode is the default mode of `xAxisLabelMode`. It allows the chart to show the properties of the `<categories> `element on the x-axis labels. MIXED - Allows the chart to show both the properties of y-axis (numeric calculations) and `<categories>` element on the x-axis simultaneously. |
Form Attributes
From the select scatter chart, you can return the selected data as form data or to JavaScript functions.
These attributes let you configure the form, if you use it as the mode to return data.
Name | Type | Range | Description |
---|---|---|---|
submitDataAsXML |
Boolean | 0/1 | Whether the chart should submit data to the given server side script as XML or as comma separated values. |
formAction |
String | URL of your server side script to which you want to submit data. You can either use relative path or absolute path. The name of form variable which is to be requested in this page is `strXML`. | |
formTarget |
String | Target of the form - _blank or _self. | |
formMethod |
String | Method of form submission - POST or GET. We recommend POST method if you're submitting data as XML. | |
showFormBtn |
Boolean | 0/1 | If you do not want to use the form method (and instead use the JavaScript method), you can hide this button by setting this attribute to 0. |
formBtnWidth |
Number | In Pixels | Lets you configure the width of the submit button. |
formBtnTitle |
String | Lets you configure the text for the submit button. By default, it's "Submit" | |
formBtnBorderColor |
Color | Hex Code | Border color for the submit button |
formBtnBgColor |
Color | Hex Code | Background color for the submit button. |
btnPadding |
Number | In Pixels | Padding for the button. |
btnTextColor |
Color | Hex Code | Color of the button text. |
btnSpacing Since 3.2.1 |
Boolean | 0/1 | Spacing between buttons. This attribute is applicable only for JavaScript charts. |
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. |
showVLineLabelBorder |
Boolean | 0/1 | If you have 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. |
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 have opted for gradient background, you need to set a list of alpha(s) separated by comma. |
bgRatio |
Number | 0-100 | If you have 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. |
bgImage Since 3.2. |
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 Since 3.2. |
Number | 0-100 | This attribute specifies the opacity for the loaded background image. |
bgImageDisplayMode Since 3.2.1 |
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.1 |
String | left, center, right | Helps you to vertically align the background image. |
bgImageHalign Since 3.2.1 |
String | left, center, right | Helps you to horizontally align the background image. |
xAxisLineColor |
Color Code | Hex Code | Sets color of the x-axis of the chart. |
bgImageScale Since 3.2.1 |
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. |
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. |
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. |
Quadrants
These attributes let you configure the functional and cosmetic properties of quadrants.
Name | Type | Range | Description |
---|---|---|---|
drawQuadrant Since 3.2 |
Boolean | 0/1 | Whether to draw quadrants on the chart. |
quadrantXVal Since 3.2 |
Number | Numeric Value | This attribute lets you set the position of the vertical quadrant line. |
quadrantYVal Since 3.2 |
Number | Numeric Value | This attribute lets you set the position of the horizontal quadrant line. |
quadrantLineColor Since 3.2 |
Color | Hex Code | Lets you set the color of the quadrant lines. |
quadrantLineThickness Since 3.2 |
Number | In Pixels | Lets you set the thickness of the quadrant lines. |
quadrantLineAlpha Since 3.2 |
Number | 0-100 | Lets you control the transparency of the quadrant lines. |
quadrantLineDashed Since 3.2 |
Boolean | 0/1 | Whether the quadrant lines should appear as dashed. |
quadrantLineDashLen Since 3.2 |
Number | In Pixels | If you have opted to show quadrant lines as dashed, this attribute lets you specify the length of the dash. |
quadrantLineDashGap Since 3.2 |
Number | In Pixels | Sets the gap between two consecutive dashes. |
quadrantLabelTL Since 3.2 |
String | This attribute lets you specify the label text of the top-left quadrant. | |
quadrantLabelTR Since 3.2 |
String | This attribute lets you specify the label text of the top-right quadrant. | |
quadrantLabelBL Since 3.2 |
String | This attribute lets you specify the label text of the bottom-left quadrant. | |
quadrantLabelBR Since 3.2 |
String | This attribute lets you specify the label text of the bottom-right quadrant. | |
quadrantLabelPadding Since 3.2 |
Number | In Pixels | This attribute lets you control the space between quadrant labels and the associated quadrant lines. |
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 |
---|---|---|---|
selectBorderColor |
Color | Hex Code | Border color for the select (drag) rectangle. |
selectBorderAlpha |
Number | 0-100 | Border alpha for the select (drag) rectangle. |
selectFillColor |
Color | Hex Code | Fill color for the select (drag) rectangle. |
selectFillAlpha |
Number | 0-100 | Fill alpha for the select (drag) rectangle. |
lineThickness |
Number | In Pixels | Thickness of the lines on the chart, if you have opted to connect the scatter points using lines. |
lineAlpha |
Number | 0-100 | Alpha of the lines on the chart. |
lineDashed |
Boolean | 0/1 | Configuration whether to show the lines as dashed lines. |
lineDashLen |
Number | In Pixels | If the lines are to be shown as dashes, this attribute defines the length of dash. |
lineDashGap |
Number | In Pixels | Sets the gap between two consecutive dashes. |
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 |
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. If the anchors are not shown, then the tool tip and links won't work. |
anchorSides |
Number | 3-20 | This attribute sets the number of sides the anchor will have. For e.g., an anchor with 3 sides would represent a triangle, with 4 it would be a square and so on. |
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. |
anchorAlpha |
Number | 0-100 | Helps you set the alpha of entire anchors. If you need to hide the anchors on chart but still enable tool tips, set this as 0. |
anchorBgAlpha |
Number | 0-100 | Helps you set the alpha of anchor background. |
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 |
---|---|---|---|
showZeroPlane |
Boolean | 0/1 | Whether to show zero plane. |
numDivLines |
Number | Numeric value > 0 | Number of horizontal axis division lines that you want on the chart. |
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 or 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. |
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. |
adjustVDiv Since 3.2.1 |
Boolean | 0/1 | PowerCharts XT automatically tries to adjust divisional lines and limit values of the x-axis based on the data provided. However, if you want to set your explicit lower and upper limit values and number of divisional lines for the x-axis, first set this attribute to 0. That will disable automatic adjustment of divisional lines. |
showXAxisValues Since 3.2.1 |
Boolean | 0/1 | The x-axis of the chart is divided into horizontal 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 (x-axis) values or not. This attribute shows or hides the x-axis divisional lines and limits. The values of `showVLimits` and `showVDivLineValues` if specified explicitly overrides the value of this attribute. |
showVLimits Since 3.2.1 |
Boolean | 0/1 | Whether to show chart limit values of the x-axis. If not specified `showXAxisValues` attribute overrides this value. |
showVDivLineValues Since 3.2.2 |
Boolean | 0/1 | Whether to show vertical div line values. If not specified `showXAxisValues` attribute overrides this value. |
numVDivLines Since 3.2.1 |
Number | Numeric value > 0 | Number of vertical axis division lines that you want to display on the chart. |
xAxisValuesStep Since 3.2.1 |
Number | Number 1 or above | By default, all div lines show their values. However, you can opt to display every x(th) div line value using this attribute. |
vDivLineColor Since 3.2.1 |
Color | Hex Code | Color for vertical divisional lines. |
vDivLineThickness Since 3.2.1 |
Number | 1-5 | Thickness of vertical divisional lines. |
vDivlineAlpha Since 3.2.1 |
Number | 0-100 | Transparency of the vertical divisional lines. |
vDivLineDashed Since 3.2.1 |
Boolean | 0/1 | Whether the vertical divisional lines should display as dash. |
vDivLineDashLen Since 3.2.1 |
Number | In Pixels | If the vertical divisional lines are to be displayed as dash, this attribute lets you control the length of each dash. |
vDivLineDashGap Since 3.2.1 |
Number | In Pixels | Sets the gap between two consecutive dashes. |
showAlternateVGridColor Since 3.2.1 |
Boolean | 0/1 | Whether to show alternate colored vertical grid bands. |
alternateVGridColor Since 3.2.1 |
Color | Hex Code | Color of the alternate vertical grid bands. |
alternateVGridAlpha Since 3.2.1 |
Number | 0-100 | Transparency of the alternate vertical grid bands. |
showVZeroPlane Since 3.2.1 |
Boolean | 0/1 | Whether to show vertical zero plane. Zero Plane is the line/plane that appears at 0 x-position on canvas, when negative data is being shown on the chart. |
vZeroPlaneColor Since 3.2.1 |
Color | Hex Code | Color of the vertical zero plane. |
vZeroPlaneThickness Since 3.2.1 |
Number | In Pixels | Thickness of the vertical zero plane. |
vZeroPlaneAlpha Since 3.2.1 |
Number | 0-100 | Transparency of the vertical zero plane. |
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. |
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 Since 3.2 |
Number | 1-5 | Scaling of legend icon is possible starting PowerCharts 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 have 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 order of datasets in the legend by setting this attribute to 1. |
interactiveLegend Since 3.2 |
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 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. |
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, for example, 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 - for example, if `formatNumberScale` is set to 1, 1043 would 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 Since 3.2.1 |
Boolean | 0/1 | Whether recursive scaling should be applied. |
maxScaleRecursion Since 3.2.1 |
Number | How many recursions to complete during recursive scaling? -1 completes the entire set of recursion. | |
scaleSeparator Since 3.2.1 |
String | What character to use to separate the scales that are generated after recursion? | |
xScaleRecursively Since 3.2.1 |
Boolean | 0/1 | Whether to scale the number recursively for the x-axis? This attribute will work only if the attribute `xAxisLabelMode` is set to '`AUTO`' or '`MIXED`'. |
xMaxScaleRecursion Since 3.2.1 |
Number | How many recursions to complete during recursive scaling for the numbers on the x-axis? -1 completes the entire set of recursion. | |
xScaleSeparator Since 3.2.1 |
String | This attribute is used to specify the character that will be used to separate the scales that are generated after recursion for the numbers on the x-axis. | |
yScaleRecursively Since 3.2.1 |
Boolean | 0/1 | This attribute is used to specify the character that will be used to separate the scales that generated after recursion for the numbers on the y-axis. |
yMaxScaleRecursion Since 3.2.1 |
Number | How many recursions to complete during recursive scaling for the numbers on the y-axis? -1 completes the entire set of recursion. | |
yScaleSeparator Since 3.2.1 |
String | This attribute is used to specify the character that will be used to separate the scales that are generated after recursion for the numbers on the y-axis. | |
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 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. |
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.1 |
Number | This option helps you specify the position of the thousand separator. | |
inDecimalSeparator |
String | Character | 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 separator from user, so that it can convert it accordingly into the required format. This attribute lets you input the decimal separator. |
inThousandSeparator |
String | Character | 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 separator from user, so that it can convert it accordingly into the required format. This attribute lets you input the thousand separator. |
decimals |
Number | 0-10 | Number of decimal places to which all numbers on the chart would 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 chart will automatically convert the number to 23.40 (note the extra 0 at the end). |
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 have 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, that is, 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, that is, 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, that is, 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, that is, 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, that is, 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 |
Boolean | 0/1 | Whether to show tool tip on chart. |
toolTipBgColor |
Color | Hex Code | Background color for tool tip. |
toolTipColor |
Color Code | Hex Code | Font color for the tool-tip. |
toolTipBorderColor |
Color | Hex Code | Border color for tool tip. |
toolTipSepChar |
String | The character specified as the value of this attribute separates the name and value displayed in tool tip. | |
seriesNameInToolTip |
Boolean | 0/1 | For multi-series charts, PowerCharts XT shows the following information in tool tip (unless tool text is explicitly defined): "Series Name, Category Name, Data Value". This attribute lets you control whether series name would show up in tool tip or not. |
showToolTipShadow |
Boolean | 0/1 | Whether to show shadow for tool-tips on the chart. |
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 and Margins
PowerCharts 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 PowerCharts 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, PowerCharts XT will not plot anything in that space.
It is not necessary for you to specify any padding/margin values. PowerCharts 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. |
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. |
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 or anchors and the value textboxes. |
legendPadding |
Number | In Pixels | Padding of legend from right or 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. Using this attribute, you can control the amount of empty space between the chart left side and canvas left side. By default, the chart 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 have 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. |
verticalLineColor |
Color | Hex Code | You can opt to show vertical lines for each category label. This attribute lets you set the color for all of them. |
verticalLineThickness |
Number | In Pixels | Lets you set the thickness for category lines. |
verticalLineAlpha |
Number | 0-100 | Lets you set the alpha for category lines. |
verticalLineDashed |
Boolean | 0/1 | Whether the category lines should appear as dashed. |
verticalLineDashLen |
Number | In Pixels | If the category lines are to appear as dashed, this attribute defines the length of dash. |
verticalLineDashGap |
Number | In Pixels | Sets the gap between two consecutive dashes. |
The <category> Element
Each <category> element represents an x-axis data label.
These attributes let you configure the x-axis data labels.
Name | Type | Range | Description |
---|---|---|---|
x |
Number | Numeric Value | The bubble/scatter chart have both x and y axis as numeric. This attribute lets you define the x value (numerical position on the x-axis) where this category name would be placed. |
label |
String | This attribute determines the label for the data item. The label appears on the x-axis of chart. | |
lineDashed |
Boolean | 0/1 | Whether the vertical line should appear as dashed. |
showVerticalLine |
Boolean | 0/1 | Whether the vertical line should be shown for this category. |
showLabel |
Boolean | 0/1 | You can individually opt to show or hide labels of individual data items using this attribute. |
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 |
---|---|---|---|
id |
String | Each data set in the XML needs to have an id attribute, using which you can track the dataset returned back to your scripts. | |
seriesName |
String | Lets you specify the series name for a particular data-set. For example, if you're plotting a chart to indicate monthly sales analysis for 2005 and 2006, the seriesName for the first dataset would be 2005 and that of the second would be 2006. The seriesName of a data-set is shown in legend. | |
color |
Color | Hex Code | This attribute sets the color using which columns, lines, area of that data-set would be drawn. For column chart, you can specify a list of comma separated hex codes to get a gradient plot |
alpha |
String | 0-100 or Comma Separated List | This attribute sets the alpha (transparency) of the entire data-set. |
showValues |
Boolean | 0/1 | Whether to show the values for this data-set. |
includeInLegend |
Boolean | 0/1 | Whether to include the `seriesName` of this data-set in legend. This can be particularly useful when you're using combination charts and you have used the area/line chart to plot a trend, and you do not want the seriesName of that trend to appear in legend. |
drawAnchors |
Boolean | 0/1 | Whether to draw anchors for the particular data-set. If the anchors are not shown, then the tool tip and links won't work for the data-set. |
anchorSides |
Number | 3-20 | Sets the number of sides that the anchors of the particular data-set will have. For e.g., an anchor with 3 sides would represent a triangle, with 4 it would be a square and so on. |
anchorRadius |
Number | In Pixels | This attribute sets the radius (in pixels) of the anchors of the particular data-set. |
anchorBorderColor |
Color | Hex Code | Lets you set the border color of anchors of the particular data-set. |
anchorBorderThickness |
Number | In Pixels | Helps you set border thickness of anchors of the particular data-set. |
anchorBgColor |
Color | Hex Code | Helps you set the background color of anchors of the particular data-set. |
anchorAlpha |
Number | 0-100 | Helps you set the alpha of entire anchors of the particular data-set. If you need to hide the anchors for the data-set but still enable tool tips, set this as 0. |
anchorBgAlpha |
Number | 0-100 | Helps you set the alpha of anchor background of the particular data-set. |
drawLine |
Boolean | 0/1 | You can opt to connect the scatter points of any dataset using lines. This attribute helps you configure that. |
lineColor |
Color | Hex Code | Color of the line connecting the scatter points. |
lineAlpha |
Number | 0-100 | Alpha of the lines connecting the scatter points. |
lineThickness |
Number | In Pixels | Thickness of the lines for the particular data-set. |
lineDashed |
Boolean | 0/1 | Configuration whether to show the lines connecting the scatter points as dash. |
lineDashLen |
Number | In Pixels | If the lines are to be shown as dash for the particular data-set, this attribute defines the length of dash. |
lineDashGap |
Number | In Pixels | Sets the gap between two consecutive dashes. |
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 select-scatter chart, a typical <set> element will look like:
<dataset seriesName='2006'> <set id='S1' x='32' y='43'/> .... and so on .... </dataset>
These attributes let you configure individual data values in a data-set.
Name | Type | Range | Description |
---|---|---|---|
id |
String | Each data element in the XML needs to have an id attribute, using which you can track the data returned back to your scripts. | |
y |
Number | Numeric Value | The y-axis value for the set. The scatter point will be placed vertically on the y-axis based on this value. |
x |
Number | Numeric Value | The x-axis value for the set. The scatter point will be placed horizontally on the x-axis based on this value. |
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 Advanced Charting > Drill Down Charts for more information. Also, you'll need to URL Encode all the special characters (like ? and &) present in the link. | |
toolText |
String | By default, PowerCharts XT shows the series name, category name, and 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. | |
showValue |
Boolean | 0/1 | You can individually opt to show or hide values of individual data items using this attribute. This value over-rides the data-set level value. |
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. |
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 | Numeric Value | The starting value for the trendline. Say, if you want to plot a slanted trendline from value 102 to 109, the `startValue` would 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` would be 109. If you do not specify a value for `endValue`, it would 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 |
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 would be displayed over data plots or behind them. |
thickness |
Number | In Pixels | If you have 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 have opted to show the trend as a line, this attribute lets you define whether the trend line would appear as dashed. |
dashLen |
Number | In Pixels | If you have opted to show trend line as dash, this attribute lets you control the length of each dash. |
dashGap |
Number | In Pixels | If you have 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. |
toolText |
String | Custom tool-text for this trendline/zone. |
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 |
---|---|---|---|
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` would 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` would be 109. If you do not specify a value for `endValue`, it would 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 |
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). |
thickness |
Number | In Pixels | If you have 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 have opted to show the trend as a line, this attribute lets you define whether the trend line would appear as dashed. |
dashLen |
Number | In Pixels | If you have opted to show trend line as dash, this attribute lets you control the length of each dash. |
dashGap |
Number | In Pixels | If you have opted to show trend line as dash, this attribute lets you control the length of each dash gap. |