| Quick Links (within this page) |
| Drag-node chart looks as under: |
 |
| Sample XML/JSON for Drag-node chart: |
<chart palette='2' xAxisMinValue='0' xAxisMaxValue='100' yAxisMinValue='0' yAxisMaxValue='100' showFormBtn='1' viewMode='0' is3D='1'> <dataset> <set x='12' y='79' width='70' height='56' name='Node 1 with a long label' color='FE3233' id='1'/> <set x='59' y='15' width='40' height='56' name='Node 2' color='FE9191' id='2' link='n-http://www.fusioncharts.com'/> <set x='88' y='75' radius='37' shape='circle' name='Node 3' color='62D0FE' id='3' link='n-http://www.fusioncharts.com'/> <set x='33' y='35' radius='37' shape='circle' name='Node 4' color='FE8181' id='4' link='n-http://www.fusioncharts.com'/> <set x='40' y='85' width='45' height='67' name='Node 5' color='FE7272' BorderColor='ff5904' id='5' /> <set x='69' y='85' width='45' height='67' name='Node 6' color='72D4FE' id='6' link='n-http://www.fusioncharts.com'/> {
"chart":{
"palette":"2",
"xaxisminvalue":"0",
"xaxismaxvalue":"100",
"yaxisminvalue":"0",
"yaxismaxvalue":"100",
"showformbtn":"1",
"viewmode":"0",
"is3D" : "1"
},
"dataset":[{
"data":[{
"x":"12",
"y":"79",
"width":"70",
"height":"56",
"name":"Node 1 with a long label",
"color":"FE3233",
"id":"1"
},
{
"x":"59",
"y":"15",
"width":"40",
"height":"56",
"name":"Node 2",
"color":"FE9191",
"id":"2",
"link":"n-http://www.fusioncharts.com"
},
{
"x":"88",
"y":"75",
"radius":"37",
"shape":"circle",
"name":"Node 3",
"color":"62D0FE",
"id":"3",
"link":"n-http://www.fusioncharts.com"
},
{
"x":"33",
"y":"35",
"radius":"37",
"shape":"circle",
"name":"Node 4",
"color":"FE8181",
"id":"4",
"link":"n-http://www.fusioncharts.com"
},
{
"x":"40",
"y":"85",
"width":"45",
"height":"67",
"name":"Node 5",
"color":"FE7272",
"bordercolor":"ff5904",
"id":"5"
},
{
"x":"69",
"y":"85",
"width":"45",
"height":"67",
"name":"Node 6",
"color":"72D4FE",
"id":"6",
"link":"n-http://www.fusioncharts.com"
},
{
"x":"87",
"y":"45",
"radius":"47",
"shape":"polygon",
"numsides":"3",
"name":"Node 7",
"color":"FE5151",
"id":"7",
"link":"n-http://www.fusioncharts.com"
},
{
"x":"65",
"y":"60",
"radius":"47",
"shape":"polygon",
"numsides":"5",
"name":"Node 8",
"color":"FE9191",
"id":"8",
"link":"n-http://www.fusioncharts.com"
},
{
"x":"12",
"y":"20",
"radius":"37",
"shape":"circle",
"name":"Node 9",
"color":"33C1FE",
"id":"9",
"link":"n-http://www.fusioncharts.com"
},
{
"x":"80",
"y":"12",
"radius":"47",
"shape":"polygon",
"numsides":"4",
"name":"Node 10",
"color":"33C1FE",
"id":"10",
"link":"n-http://www.fusioncharts.com"
}
]
}
],
"connectors":[{
"color":"FF0000",
"stdthickness":"5",
"connector":[{
"strength":"0.96",
"label":"link label",
"from":"1",
"to":"9",
"color":"BBBB00",
"arrowatstart":"1",
"arrowatend":"1"
},
{
"strength":"0.8",
"label":"link12",
"from":"1",
"to":"5",
"color":"BBBB00",
"arrowatstart":"1",
"arrowatend":"1"
},
{
"strength":"0.8",
"label":"link2",
"from":"1",
"to":"8",
"color":"BBBB00"
},
{
"strength":"0.3",
"label":"link3",
"from":"1",
"to":"4",
"color":"BBBB00",
"arrowatstart":"1",
"arrowatend":"1"
},
{
"strength":"0.4",
"label":"link4",
"from":"2",
"to":"4",
"color":"BBBB00",
"arrowatstart":"1",
"arrowatend":"1"
},
{
"strength":"0.6",
"label":"link5",
"from":"4",
"to":"2",
"color":"BBBB00",
"arrowatstart":"1",
"arrowatend":"1"
},
{
"strength":"0.33",
"label":"link1",
"from":"2",
"to":"8",
"color":"BBBB00"
},
{
"strength":"0.66",
"label":"link7",
"from":"8",
"to":"3",
"color":"BBBB00",
"arrowatstart":"1",
"arrowatend":"1"
},
{
"strength":"0.7",
"label":"link6",
"from":"4",
"to":"5",
"color":"BBBB00",
"arrowatstart":"1",
"arrowatend":"1"
},
{
"strength":"0.6",
"from":"4",
"to":"8",
"color":"FF5904",
"arrowatstart":"1",
"arrowatend":"1"
},
{
"strength":"0.6",
"label":"link9",
"from":"5",
"to":"8",
"color":"BBBB00"
},
{
"strength":"0.5",
"label":"link10",
"from":"7",
"to":"8",
"color":"BBBB00",
"arrowatstart":"1",
"arrowatend":"1"
},
{
"strength":"0.3",
"label":"link11",
"from":"7",
"to":"10",
"color":"BBBB00"
}
]
}
],
"labels":{
"label":[{
"text":"A Note added as Text Label",
"x":"18",
"y":"5"
}
]
}
}
|
|||
Back to top  | |||
| Chart Objects |
| Object Name | Description | Features Supported | Animation Parameters Supported |
| BACKGROUND | BACKGROUND refers to the entire background of the chart. |
|
|
| CANVAS | CANVAS refers to the area in which the actual chart is plotted. |
|
|
| CAPTION | CAPTION refers to the heading of the chart. |
|
|
| CONNECTOR | CONNECTOR refers to the connector links between two nodes. |
|
|
| CONNECTORLABELS | CONNECTORLABELS refer to the labels of the links between any two nodes. |
|
|
| DATAPLOT | DATAPLOT refers to the nodes on the chart. |
|
|
| DIVLINES | DIVLINES are horizontal lines running through the canvas. Each divisional line signifies a smaller unit of the entire axis thus aiding the users in interpreting the chart. By default, it is not visible in a drag node chart. |
|
|
| HGRID | HGRID refers to alternate color bands between two successive horizontal divisional lines. |
|
|
| LEGEND | LEGEND is the object in which the series names of all data-sets show up. |
|
|
| SUBCAPTION | SUBCAPTION refers to the sub-heading of the chart. |
|
|
| TOOLTIP | TOOLTIP refers to the tool tip shown when mouse is hovered over the data plots. |
|
|
| TRENDLINES | TRENDLINES refer to horizontal or vertical lines spanning the chart canvas which aid in interpretation of data with respect to some pre-determined value. |
|
|
| TRENDVALUES | TRENDVALUES refer to the display values of trend-lines (if any). |
|
|
| VLINES | 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. In case of bar charts, they are horizontal and run through the width of chart. |
|
|
| VTRENDLINES | VTRENDLINES refer to vertical lines spanning the chart canvas which aid in interpretation of data with respect to some pre-determined value. |
|
|
| VTRENDVALUES | VTRENDVALUES refer to the display values of vertical trend-lines. |
|
|
|
Back to top |
|||
| <chart> element Attributes |
| Functional Attributes |
|
These attributes let you control a variety of functional elements on the chart. For example, you can opt to show or hide data labels, data values, y-axis values. You can also set chart limits and extended properties. |
| Attribute Name | Type | Range | Description |
| viewMode | Boolean | 0/1 | Whether to set the chart in view mode or edit mode. In view mode, end users will only be able to drag the nodes (which are marked as drag-able). In edit mode, they can add/delete nodes or add/delete connectors. |
| enableLinks | Boolean | 0/1 | If there are any links defined on the nodes, you can opt to start the chart in link mode (rather than dragging mode) by setting this attribute as 1. Your users can, at runtime, toggle between link mode and drag mode using the right-click context menu of chart. |
| 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. Valid values are 1-5. |
| 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, for example, <chart 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 XML. |
| showAboutMenuItem | Boolean | 0/1 | Setting this to 1 shows up a custom context menu in the chart, which can be customized to show your text and can be linked to your URL. For example, you can set the context menu of the chart to include "About your company name" and then link to your company home page. By default, the chart shows "About FusionCharts" when right clicked. |
| aboutMenuItemLabel | String | The menu item label for the custom context menu item. | |
| aboutMenuItemLink | String | URL | Link for the custom context menu item. You can specify the link in FusionCharts Link Format to be able to open the same in new window, pop-ups, frames or as JavaScript links. |
| showLabels | Boolean | 0/1 | It sets the configuration whether the x-axis labels will be displayed or not. |
| labelDisplay | String | AUTO Since v 3.2 WRAP STAGGER ROTATE or 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 v 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. |
| 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. |
| showLimits | Boolean | 0/1 | Whether to show chart limit values. |
| showDivLineValues | Boolean | 0/1 | Whether to show div line values. |
| yAxisMaxValue | Number | Numeric Value | This attribute helps you explicitly set the upper limit of the chart. If you do not 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 do not specify this value, it is automatically calculated by the chart based on the data provided by you. |
| xAxisMinValue | Number | Numeric Value | The node chart has both x and y axes 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. |
| xAxisMaxValue | Number | Numeric Value | The node chart has both x and y axes 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. |
| use3DLighting | Boolean | 0/1 | Whether to use 3D lighting effects while filling the nodes. |
| 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. | |
| defaultAnimation | Boolean | 0/1 | By default, each chart animates some of its elements. If you wish to switch off the default animation patterns, you can set this attribute to 0. It can be particularly useful when you want to define your own animation patterns using Styles feature. |
| 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. |
| showTooltipforWrappedLabels | Boolean | 0/1 | When the labels of the chart are too lengthy, the chart truncates them and displays a part of the label. In this situation, this attribute shows a tooltip displaying the complete label when the mouse is hovered on the shortened labels. |
| 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. |
| 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. |
|
Back to top |
|||
| Form & Button Parameters |
The drag-node chart allows you to submit the updated positions of node (or new nodes added on chart) to a form (or JavaScript functions). Using the attributes below, you can configure the form and submit button properties. |
| Attribute Name | Type | Range | Description |
| showFormBtn | Boolean | 0/1 | If you want the user to be able to submit the data as form, you need to set this attribute to 1. If you are using JavaScript methods to get the data from chart, you can hide the button by setting this attribute to 0. |
| 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. | |
| formMethod | String | GET or POST | Method of form submission - POST or GET. We recommend POST method if you're submitting data as XML. |
| formTarget | String | _blank or _self | Target of the form - _blank or _self. |
| formBtnTitle | String | Lets you configure the text for the submit button. By default, it's "Submit" | |
| btnTextColor | Color | Hex Code | Color of button text. |
| formBtnWidth | Number | Pixels | Lets you configure the width of the submit button. |
| formBtnBorderColor | Color | Hex Code | Border color for the submit button |
| formBtnBgColor | Color | Hex Code | Background color for the submit button. |
| btnPadding | Number | Pixels | Padding for the button. |
|
Back to top |
|||
| Chart Titles and Axis Names |
|
Using these attributes, you can set the various headings and titles of chart like caption, sub-caption, x-axis and y-axis names etc. |
| Attribute 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. | |
|
Back to top |
|||
| Chart Cosmetics |
|
The following attributes let you configure chart cosmetics like background color, background alpha, canvas color & alpha etc. |
| Attribute 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. Remember to remove # and any spaces in between. See Advanced Charting > Using Gradients for more details. |
| 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. See Advanced Charting > Using Gradients for more details. |
| bgRatio | Number | 0-100 | If you have opted for a gradient background, this attribute lets you set the ratio of each color constituent. See Advanced Charting > Using Gradients for more details. |
| bgAngle | Number | 0-360 | Angle of the background color, in case of a gradient. See Advanced Charting > Using Gradients for more details. |
| bgImage
Since v3.2.1
or bgSWF - deprecated |
String |
To place any image (JPG/PNG/GIF) or Flash movie (SWF) as background of the chart, enter the (path and) name of the background image or SWF file. It should be in the same domain as the chart. Loading of Flash movie is deprecated and is not supported by JavaScript charts. |
|
| bgImageAlpha
Since v3.2.1
or bgSWFAlpha - deprecated |
Number | 0-100 |
Helps you specify the opacity for the loaded background image or Flash movie. Loading of Flash movie is deprecated and is not supported by JavaScript charts. |
| bgImageDisplayMode Since v3.2.1 |
String | stretch, tile, fit, fill, center, none |
Helps you specify the mode in which the background image is to be displayed.
|
| bgImageValign Since v3.2.1 |
String | left, center, right | Helps you to vertically align the background image. |
| bgImageHalign Since v3.2.1 |
String | left, center, right | Helps you to horizontally align the background image. |
| bgImageScale Since v3.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/SWF) on the chart once it has rendered. This attribute lets you specify the URL of the same. Owing to Flash Player security settings, you can only specify logo that are on the sub-domain as the SWF file of the chart. |
| logoPosition | String | TL, TR, BL, BR, CC | Where to position the logo on the chart:
|
| 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 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. |
|
Back to top |
|||
| Data Plot Cosmetics |
|
These attributes let you configure how your nodes would appear on the chart. |
| Attribute Name | Type | Range | Description |
| is3D | Boolean | 0/1 | Whether to use 3D lighting effects while filling the nodes. |
| showPlotBorder | Boolean | 0/1 | Whether the node borders would show up. |
| plotBorderColor | Color | Hex Code | Color for node borders. |
| plotBorderThickness | Number | 0-5 (Pixels) | Thickness for node borders. |
| plotBorderAlpha | Number | 0-100 | Alpha for node borders. |
| plotFillAlpha | Number | 0-100 | If you have opted to fill the node as gradient, this attribute lets you set the fill alpha for gradient. |
|
Back to top |
|||
| Divisional Lines & Grids |
|
Using this set of attributes, you can control the properties of divisional lines, zero plane and alternate color bands. |
| Attribute Name | Type | Range | Description |
| 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. |
| divLineIsDashed | Boolean | 0/1 | Whether the divisional lines should display as dash. |
| divLineDashLen | Number | In Pixels | If the divisional lines are to be displayed as dash, this attribute lets you control the length of each dash. |
| divLineDashGap | Number | In Pixels | If the divisional lines are to be displayed as dash, this attribute lets you control the length of each gap between dash. |
| zeroPlaneColor | Color | Hex Code | Color for the zero plane. Zero Plane is the line or plane that appears at 0 y-position on canvas, 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. |
| showZeroPlane | Boolean | 0/1 | Whether to show zero plane. |
|
Back to top |
|||
| Legend Properties |
| Using the attributes below, you can configure the functional and cosmetic properties of the legend. The legend remains hidden by default. To show the legend use showLegend='1'. |
| Attribute Name | Type | Range | Description |
| showLegend | Boolean | 0/1 | Whether to show legend for the chart. |
| legendPosition | String | BOTTOM or RIGHT | The legend can be plotted at two positions on the chart - below the chart (BOTTOM) and on the RIGHT side of the chart. |
| legendCaption | String | You can add a caption for the entire legend by setting the same here. | |
| legendIconScale
Since v 3.2 |
Number | 0-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. |
| legendScrollBtnColor | 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 color of buttons of the scroll bar. |
| 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. |
| legendScrollBarColor | 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 bar 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 v 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 v 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 v 3.2 |
Boolean | 0/1 | Whether to minimize legend item text wrapping. |
| legendMarkerCircle deprecated. Not applicable. |
Boolean | 0/1 | Whether to use square legend keys or circular ones. |
|
Back to top |
|||
| Number Formatting |
|
PowerCharts XT offers you a lot of options to format your numbers on the chart. Using the attributes below, you can control a myriad of options like:
|
| Attribute 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'. For more details, please see Advanced Charting > Number Formatting section. |
| 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. For more details, please see Advanced Charting > Number Formatting section. |
| defaultNumberScale | String | The default unit of the numbers that you're providing to the chart. For more details, please see Advanced Charting > Number Formatting section. | |
| numberScaleUnit | String | Unit of each block of the scale. For more details, please see Advanced Charting > Number Formatting section. | |
| numberScaleValue | String | Range of the various blocks that constitute the scale. For more details, please see Advanced Charting > Number Formatting section. | |
| 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. For more details, please see Advanced Charting > Number Formatting section. |
| numberSuffix | String | Character | Using this attribute, you could add suffix to all the numbers visible on the graph. For example, to represent all figure quantified as per annum on the chart, you could specify this attribute to ' /a' to show like 40000/a, 50000/a. For more details, please see Advanced Charting > Number Formatting section. |
| decimalSeparator | String | Character | This option helps you specify the character to be used as the decimal separator in a number. For more details, please see Advanced Charting > Number Formatting section. |
| thousandSeparator | String | Character | This option helps you specify the character to be used as the thousands separator in a number. For more details, please see Advanced Charting > Number Formatting section. |
| 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. For more details, please see Advanced Charting > Number Formatting section. |
| 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. For more details, please see Advanced Charting > Number Formatting section. |
| decimals | Number | 0-10 | Number of decimal places to which all numbers on the chart would be rounded to. For more details, please see Advanced Charting > Number Formatting section. |
| forceDecimals | Boolean | 0-1 | Whether to add 0 padding at the end of decimal numbers. For example, if you set decimals as 2 and a number is 23.4. If forceDecimals is set to 1, the number will automatically be converted to 23.40 (note the extra 0 at the end). For more details, please see Advanced Charting > Number Formatting section. |
| 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. For more details, please see Advanced Charting > Number Formatting section. |
|
Back to top |
|||
| Font Properties |
|
Using the attributes below, you can define the generic font properties for all the text on the chart. These attributes allow you a high level control over font properties. If you intend to specify font properties for individual chart elements (like Caption, sub-caption etc.), you'll need to use the Styles feature of PowerCharts XT. Using Styles, you can also specify advanced font properties like Bold, Italics, HTML Mode etc. |
| Attribute 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 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 font 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. |
|
Back to top |
|||
| Tool-tip |
|
These attributes let you control the tool tip. You can set the background color, border color, separator character and few other details. |
| Attribute Name | Type | Range | Description |
| showToolTip | Boolean | 0/1 | Whether to show tool tip on chart. |
| toolTipBgColor | Color | Hex Code | Background color for tool tip. |
| toolTipBorderColor | Color | Hex Code | Border color for tool tip. |
| showToolTipShadow | Boolean | 0/1 | Whether to show shadow for tool tips on the chart. |
|
Back to top |
|||
| Chart Padding & Margins |
|
The following attributes help you control chart margins and paddings. PowerCharts XT allows you 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 would not plot anything in that space. It's not necessary for you to specify any padding or margin values. PowerCharts XT automatically assumes the best values for the same, if you do not specify the same. |
| Attribute Name | Type | Range | Description |
| legendPadding | Number | In Pixels | Padding of legend from right or bottom side of canvas. |
| 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 or 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 on the bottom of your chart. Nothing is rendered in this space. |
| 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 does not 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. |
|
Back to top |
|||
| <categories> element |
|
The <categories> element lets you bunch together x-axis labels of the chart, if you want any on the chart. The following properties of <categories> element help you control the font properties of data labels. |
| Attribute Name | Type | Range | Description |
| font | String | Valid font face | Lets you specify font face for the x-axis data labels. |
| fontSize | Number | Numeric Value | 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 dash, this attribute defines the length of dash. |
| verticalLineDashGap | Number | In Pixels | If the category lines are to appear as dash, this attribute defines the length of gap between two consecutive dashes. |
|
Back to top |
|||
| <category> element |
|
Each <category> element represents an x-axis data label. You can specify the following attributes for <category> element: |
| Attribute Name | Type | Range | Description |
| x | Number | Numeric Value | The node chart has 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. Note that the x value is not pixel based. |
| 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. |
| toolText | String |
The tooltip defined in the <category> element appears only when the mouse cursor is hovered over the nodes. However, this will not appear when the cursor is moved over the data labels (except for a situation when long labels are automatically truncated with ellipses. In this situation, if the mouse cursor is hovered over a truncated label, the tooltip will appear with the full label). In case you want to set a short label and show the full label in tooltip, define the full label using this attribute within the <category> element. The tooltip with the full label will appear only when the mouse is hovered on the particular node. |
|
|
Back to top |
|||
| <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. Also, each data-set can be named using the seriesName attribute of <dataset> element. The series name appears in the legend of the chart. |
| Attribute 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. | |
| allowDrag | Boolean | 0/1 | Whether to allow the end users to drag the nodes belonging to this data-set. |
| seriesName | String | Lets you specify the series name for a particular data-set. | |
| color | Color | Hex Code (Or Comma separated list) | 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 | Number | 0-100 | This attribute sets the alpha (transparency) of the entire data-set. |
| includeInLegend | Boolean | 0/1 | Whether to include the seriesName of this data-set in legend. This can be particularly useful when you are using combination charts and you have used the Area or Line chart to plot a trend, and you do not want the seriesName of that trend to appear in legend. |
| showPlotBorder | Boolean | 0/1 | Whether to show the border of this data-set. |
| plotBorderColor | Color | Hex Code | Color for data plot border of this data-set. |
| plotBorderThickness | Number | 0-5 (Pixels) | Thickness for data plot border of this data-set. |
| plotBorderAlpha | Number | 0-100 | Alpha for data plot border of this data-set. |
| plotFillAlpha | Number | 0-100 | If you have opted to fill the node as gradient, this attribute lets you set the fill alpha for gradient for the data-set. |
|
Back to top |
|||
| <set> element |
|
Each <set> element (child of <dataset> element) represents a node which is to be plotted on the chart. |
| Attribute Name | Type | Range | Description |
| Id | String | Each node in the XML needs to have an id attribute, using which you can track the data returned back to your scripts. | |
| allowDrag | Boolean | 0/1 | Whether to allow user to drag this particular node. |
| shape | String | RECTANGLE / CIRCLE or POLYGON | Lets you define the shape of node. Valid values are RECTANGLE / CIRCLE or POLYGON. |
| height | Number | Pixels | If you have selected Rectangle as the shape, this attribute lets you define the height of the same. |
| width | Number | Pixels | If you have selected Rectangle as the shape, this attribute lets you define the width of the same. |
| radius | Number | Pixels | If you have selected Polygon or circle as the shape for node, this attribute lets you define the radius of the same. |
| numSides | Number | More than 3. | If you have selected Polygon as the shape for node, this attribute lets you define the sides for the same. |
| imageNode | Boolean | 0/1 | Whether this node should contain an image. You can load GIF/JPG or PNG images in the chart. |
| imageURL | String | URL | If the node contains image, this attribute lets you set the path for it. Note that the image should be on the same sub-domain as the chart SWF. |
| imageAlign | String | TOP, MIDDLE or BOTTOM | Vertical alignment of image in the node - TOP, MIDDLE or BOTTOM |
| imageWidth | Number | Pixels | Width of the image that you intend to load. |
| imageHeight | Number | Pixels | Height of the image that you intend to load. |
| labelAlign | String | TOP, MIDDLE or BOTTOM | Vertical alignment of the node label in the node -TOP, MIDDLE or BOTTOM. This is applicable only when imageNode='1'. |
| x | Number | Numeric Value | The x-axis value for the node. The node will be placed horizontally on the x-axis based on this value. The x value (numerical position on the x-axis) is not based on pixels. All the values contribute to form a numeric scale on the x axis. You can modify this scale using xAxisMaxValue and xAxisMinValue attributes. |
| y | Number | Numeric Value | The y-axis value for the node. The node will be placed vertically on the y-axis based on this value. The y value (numerical position on the y-axis) is not based on pixels. All the values contribute to form a numeric scale on the y-axis. You can modify this scale using yAxisMaxValue and yAxisMinValue attributes. |
| label | String | This attribute helps you set the name of this node, which would be displayed over the node. | |
| color | Color | Hex Code | For Multi-series and Combination charts, you can define the color of data-sets at dataset level. However, if you wish to highlight a particular data element, you can specify it's color at "set" level using this attribute. This attribute accepts hex color codes without #. |
| link | String | You can define links for individual data items. That enables the end user to click on node 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 need to URL Encode all the special characters (like ? and &) present in the link. | |
| toolText | String | Lets you define the tool text for the node. | |
| alpha | Number | 0-100 | You can define the alpha of data-sets at dataset level. However, if you wish to highlight a particular data element, you can specify it's alpha at "set" level using this attribute. |
|
Back to top |
|||
| <connectors> element |
| The Drag-node chart allows you to connect any two nodes on the chart using connectors. You can have any number of connectors on the chart, as long as two nodes are connected by one connector only. The following properties let you define the cosmetics for all the connectors on the chart: |
| Attribute Name | Type | Range | Description |
| stdThickness | Number | 0-5 | Using this value, you can specify a number which will be multiplied by individual connectors strength to get the line thickness. Say, you have a connector whose thickness should be 2 pixels and another whose thickness should be 4. So, you can define this attribute as 2 and then specify the strength of first connector as 1 and second one as 2. This is useful when you're plotting network diagrams and you have to show link strength as connector thickness. |
| Color | Color | Hex Code | Color for all the connectors on the chart. |
| alpha | Number | 0-100 | Alpha for all the connectors on the chart. |
| dashed | Boolean | 0/1 | Whether the connectors on the chart should appear as dashed. |
| dashGap | Number | Pixels | If the connectors are to appear as dashed, this attribute lets you define the gap between two consecutive dashes. |
| dashLen | Number | Pixels | If the connectors are to appear as dashed, this attribute lets you define the length of each dash. |
| arrowAtStart | Boolean | 0/1 | Whether to show arrows at the origin of connectors. |
| arrowAtEnd | Boolean | 0/1 | Whether to show arrows at the end point of connectors. |
| strength | Number | 0-2 | Default strength for all connectors. |
|
Back to top |
|||
| <connector> element |
Each <connector> element lets you connect two nodes on the chart. Please note that two nodes can be connected only using 1 connector. |
| Attribute Name | Type | Range | Description |
| from | String | ID of the node from where you want the connector to start. The id should refer to the user defined id of each node (defined in XML). | |
| to | String | ID of the node from where you want the connector to end. The id should refer to the user defined id of each node (defined in XML). | |
| label | String | Label of the connector which will show up on the chart. | |
| Color | Color | Hex Code | Color of the connector. |
| alpha | Alpha | 0-100 | Alpha of the connector. |
| link | String | You can define links for individual connectors. That enables the end user to click on a connector and drill down to other pages. To define the link for connectors, 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 need to URL Encode all the special characters (like ? and &) present in the link. | |
| strength | Number | 0-2 | Strength of this connector. The thickness of this connector would be strength*stdThickness (defined for <connectors> element). |
| arrowAtStart | Boolean | 0/1 | Whether to show arrows at the origin of connector. |
| arrowAtEnd | Boolean | 0/1 | Whether to show arrows at the end point of connector. |
| dashed | Boolean | 0/1 | Whether the connector should appear dashed. |
| dashLen | Number | Pixels | If the connector is to appear as dashed, this attribute lets you define the length of each dash. |
| dashGap | Number | Pixels | If the connector is to appear as dashed, this attribute lets you define the gap between two consecutive dashes. |
|
Back to top |
|||
| <labels> ... <label> element Since v 3.2 |
|
<labels> element is a collection of <label> element which helps you create free text labels on the chart. <labels> element does not have any attribute to set. The attributes of <label> element are discussed below: |
| <label> Element
Since v 3.2 |
|||
| Attribute Name | Type | Range | Description |
| text Since v 3.2 |
String | The text that is displayed on the label. | |
| x Since v 3.2 |
Number | x-axis value for the label. The label will be placed horizontally on the x-axis based on this value. | |
| y Since v 3.2 |
Number | y-axis value for the label. The label will be placed vertically on the y-axis based on this value. | |
| Color Since v 3.2 |
Color | Hex Code | Text color of the label. |
| alpha Since v 3.2 |
Alpha | 0-100 | Alpha of the label. |
| bgColor Since v 3.2 |
Color | Hex Code | Background color of the label. |
| borderColor Since v 3.2 |
Color | Hex Code | Border color of the label. |
| fontsize | Number | Sets the font size of the label. | |
| allowdrag | Boolean | 0/1 | Whether to allow the user to drag this particular label. |
| padding Since v 3.2 |
Boolean | 0/1 | Padding space around the text. The background color of the label spreads till this padding space. Around this padding space the border is drawn. |
|
Back to top |
|||
| Trend-lines |
|
Using the <trendLines> element (and children <line> elements), you can define trend lines on the chart. Trend lines are horizontal or vertical 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. For each trend line on the chart, you need to define a <line> element under <trendLines> element as under: <trendLines> <line startValue='895' color='FF0000' displayvalue='Average' /> </trendLines> You can control the cosmetic and functional properties of trend-lines using the following attributes: |
| Attribute Name | Type | Range | Description |
| startValue | Number | Numeric Value | The starting value for the trend line. Say, if you want to plot a slanted trend line from value 102 to 109, the startValue would be 102. |
| endValue | Number | Numeric Value | The ending y-axis value for the trend line. Say, if you want to plot a slanted trend line 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 | Numeric Value |
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 would display a line, or a zone (filled colored rectangle). |
| showOnTop | Boolean | 0/1 | Whether the trend line or 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. |
|
Back to top |
|||
| Vertical Trend-lines |
|
Vertical trend lines help you create vertical trend lines or zones on your Drag-node charts. These are vertical lines spanning the chart canvas which aid in interpretation of data with respect to some pre-determined value. By default, vertical trend zones are created. To set vertical trend lines you need to explicitly set isTrendZone='0'. Usage: <vTrendLines> <line startValue='895' endValue='980' color='FF0000' displayvalue='Zone 1' isTrendZone='1'/> </vTrendLines> You can control the cosmetic and functional properties of vertical trend lines using the following attributes: |
| Attribute Name | Type | Range | Description |
| startValue | Number | Numeric Value | The starting value for the trend line. Say, if you want to plot a slanted trend line from value 102 to 109, the startValue would be 102. |
| endValue | Number | Numeric Value | The ending y-axis value for the trend line. Say, if you want to plot a slanted trend line 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 | Numeric Value |
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 do not 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 would display a line, or a zone (filled 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. |
| toolText | String | Custom tool-text for this trend line or zone. | |
|
Back to top |
|||
The chart also accepts the following features, which have not been discussed here:
|
