| Quick Links (within this page) |
| Candlestick chart looks as under: |
|
| Sample XML for Candlestick chart: |
|
<chart numPDivLines="5" caption="XYZ - 3 Months" numberPrefix="$" bearBorderColor="E33C3C" bearFillColor="E33C3C" bullBorderColor="1F3165" PYAxisName="Price" VYAxisName="Volume (In Millions)" volumeHeightPercent="20"> <categories> <category label="2006" x="1" showLine="1" /> </categories> <dataset> <set open="24.6" high="25.24" low="24.58" close="25.19" x="1" volume="17856350" /> <set open="24.36" high="24.58" low="24.18" close="24.41" x="2" volume="3599252" /> <set open="24.63" high="24.66" low="24.11" close="24.95" x="3" volume="74685351" /> <set open="24.53" high="24.84" low="24.01" close="24.95" x="4" volume="49236987" /> <set open="24.84" high="24.94" low="24.56" close="24.93" x="5" volume="18247006" /> <set open="24.96" high="25.03" low="24.58" close="24.89" x="6" volume="67419690" /> <set open="25.25" high="25.46" low="25.11" close="25.13" x="7" volume="95517555" /> <set open="25.27" high="25.37" low="25.0999" close="25.18" x="8" volume="83656552" /> <set open="25.33" high="25.43" low="25.06" close="25.16" x="9" volume="42177624" /> <set open="25.38" high="25.51" low="25.23" close="25.38" x="10" volume="40668662" /> <set open="25.2" high="25.78" low="25.07" close="25.09" x="11" volume="78602232" /> <set open="25.66" high="25.8" low="25.35" close="25.37" x="12" volume="10338104" /> <set open="25.77" high="25.97" low="25.54" close="25.72" x="13" volume="38067037" /> <set open="26.31" high="26.35" low="25.81" close="25.83" x="14" volume="52104215" /> <set open="26.23" high="26.6" low="26.2" close="26.35" x="15" volume="46274157" /> </dataset> <trendset name="Simple Moving Average" color="0099FF" thickness="0" alpha="100" includeInLegend="1"> <set x="1" value="24.6" /> <set x="2" value="24.69" /> <set x="3" value="24.89" /> <set x="4" value="24.92" /> <set x="5" value="25.2" /> <set x="6" value="25.1" /> <set x="7" value="25.17" /> <set x="8" value="25.2" /> <set x="9" value="25.2" /> <set x="10" value="25.31" /> <set x="11" value="25.28" /> <set x="12" value="25.52" /> <set x="13" value="25.7" /> <set x="14" value="25.9" /> <set x="15" value="26" /> </trendset> <trendLines> <line startValue="24.2" color="0372AB" displayvalue="S1" thickness="0" dashed="1" dashLen="2" dashGap="2" /> <line startValue="23.35" color="0372AB" displayvalue="S2" thickness="0" dashed="1" dashLen="2" dashGap="2" /> <line startValue="28.2" color="0372AB" displayvalue="R2" thickness="0" dashed="1" dashLen="2" dashGap="2" /> <line startValue="27.65" color="0372AB" displayvalue="R1" thickness="0" dashed="1" dashLen="2" dashGap="2" /> </trendLines> <vtrendLines> <line startValue="10" endValue="13" color="FF5904" displayvalue="Results Impact" isTrendZone="1" alpha="10" /> </vtrendLines> </chart> |
|
| Chart Objects |
| Object Name | Description | Features Supported | Animation Parameters Supported |
| ANCHORS | If you've plotted your price chart as line, ANCHORS (or marker points) are polygons which can appear at the joint of two consecutive line points. These are indicators to show the position of data points. The anchors handle tool tips and links for the data points. |
|
|
| BACKGROUND | BACKGROUND refers to the entire background of the chart. |
|
|
| CANVAS | CANVAS refers to the area in which the actual chart is plotted. It is represented by a bounded rectangle. |
|
|
| CAPTION | CAPTION refers to the heading of the chart. |
|
|
| DATALABELS | DATALABELS refer to the x-axis labels of the data. |
|
|
| DATAVALUES | DATAVALUES refer to the value text of candles (if any specified). |
|
|
| DIVLINES | DIVLINES are horizontal lines running through the canvas. |
|
|
| HGRID | HGRID refers to alternate color bands between two successive horizontal divisional lines. |
|
|
| LEGEND | LEGEND is the object in which the name of all trend-sets show up. |
|
|
| PRICEPLOT | The price charts is referred to as PRICEPLOT. |
|
|
| PYAXISNAME | Y-axis name for the price chart. |
|
|
| 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/vertical lines spanning the chart canvas which aid in interpretation of data with respect to some pre-determined value. |
|
|
| TRENDSETS | Additional trend lines drawn over the candles / lines / bars. |
|
|
| TRENDVALUES | TRENDVALUES refer to the display values of trend-lines (if any). |
|
|
| VLINES | VLINES are vertical lines are plotted for each x-axis label. |
|
|
| VOLUMEPLOT | VOLUMEPLOT refers to the volume 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. |
|
|
| VYAXISNAME | VYAXISNAME refers to the y-axis name of volume chart. |
|
|
| YAXISVALUES | YAXISVALUES refers to the limit values or divisional line values, which are displayed along the y-axis of the chart. |
|
|
|
|
|||
| <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/hide data labels, data values, y-axis values. You can also set chart limits and extended properties. |
|
|
| Attribute 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. |
| plotPriceAs | String | CANDLESTICK, LINE OR BAR | This attribute lets you configure how your price chart would be plotted as. You can use either of the three options - CANDLESTICK, BAR or LINE |
| plotClosingPrice | Boolean | 1/0 | If you've opted to plot the price chart as line, this attribute lets you configure whether the closing price will be used for plot or opening price. |
| palette | Number | 1-5 | FusionCharts v3 introduces the concept of Color Palettes. Each chart has 5 pre-defined color palettes which you can choose from. Each palette renders the chart in a different color theme. 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 (i.e., column, line, pie etc.). Using paletteColors attribute, you can specify your custom list of hex colors for the data items. The list of colors have to be separated by comma e.g., <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 e.g., 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. |
| showVolumeChart | Boolean | 1/0 | If you want to hide volume chart, you can use this attribute. |
| volumeHeightPercent | Number | (In Percent) | Height of the volume chart in percent (with respect to total chart). By default, it's set to 40%. Range is between 20-80%. |
| xAxisMinValue | Number | Numeric Value | The candlestick 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, FusionCharts will automatically calculate the best value for you. |
| xAxisMaxValue | Number | Numeric Value | The candlestick 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, FusionCharts will automatically calculate the best value for you. |
| PYAxisMaxValue | Number | This attribute helps you explicitly set the upper limit of the price chart. If you don't specify this value, it is automatically calculated by FusionCharts based on the data provided by you. | |
| PYAxisMinValue | Number | This attribute helps you explicitly set the lower limit of the price chart. If you don't specify this value, it is automatically calculated by FusionCharts based on the data provided by you. | |
| VYAxisMinValue | Number | Lower limit for the volume chart axis. If you do not specify this, FusionCharts wll automatically calculate for you. | |
| VYAxisMaxValue | Number | Upper limit for the volume chart axis. If you do not specify this, FusionCharts wll automatically calculate for you. | |
| showLabels | Boolean | 0/1 | It sets the configuration whether the x-axis labels will be displayed or not. |
| labelDisplay | String | WRAP, STAGGER, ROTATE or NONE | Using this attribute, you can control how your data labels (x-axis labels) would appear on the chart. There are 4 options: WRAP, STAGGER, ROTATE or NONE. WRAP wraps the label text if it's longer than the allotted area. ROTATE rotates the label in vertical or slanted position. STAGGER divides the labels into multiple lines. |
| 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've 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've a set of streaming data (like name of months or days of week), you can opt to hide every n-th label for better clarity. This attributes just lets you do so. It allows to skip every n(th) X-axis label. |
| staggerLines | Number | 2 or above | If you've opted for STAGGER mode as labelDisplay, using this attribute you can control how many lines to stagger the label to. By default, all labels are displayed in a single line. |
| showYAxisValues | Boolean | 0/1 | FusionCharts y-axis 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. |
| yAxisValuesStep | Number | 1 or above | By default, all div lines show their values. However, you can opt to skip every x(th) div line value using this attribute. |
| adjustDiv | Boolean | 0/1 | FusionCharts 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've 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. |
| 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 STYLE feature. |
| 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 or should the y-axis lower limit adapt itself to a different figure based on values provided to the chart. |
|
|
|||
| Chart Titles and Axis Names |
| Using these attributes, you can set the various headings and titles of chart like caption, sub-caption and y-axis names etc. |
|
|
| Attribute Name | Type | Description |
| caption | String | Caption of the chart. |
| subCaption | String | Sub-caption of the chart. |
| PYAxisName | String | Y-axis name for the price chart. |
| VYAxisName | String | Y-axis name for the volume chart. |
|
|
||
| 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 | Border color of the chart. | |
| borderThickness | Number | In Pixels | Border thickness of the chart. |
| borderAlpha | Number | 0-100 | Border alpha of the chart. |
| bgColor | Color | 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 the gradient specification page for more details. | |
| bgAlpha | Number | 0-100 | Sets the alpha (transparency) for the background. If you've opted for gradient background, you need to set a list of alpha(s) separated by comma. See the gradient specification page for more details. |
| bgRatio | Number | 0-100 | If you've opted for a gradient background, this attribute lets you set the ratio of each color constituent. See the gradient specification page for more details. |
| bgAngle | Number | 0-360 | Angle of the background color, in case of a gradient. See the gradient specification page for more details. |
| bgSWF | String | To place any Flash movie as background of the chart, enter the (path and) name of the background SWF. It should be in the same domain as the chart. | |
| bgSWFAlpha | Number | 0-100 | Helps you specify alpha for the loaded background SWF. |
| canvasBgColor | Color | Sets Canvas background color. For Gradient effect, enter colors separated by comma. | |
| canvasBgAlpha | Number | 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 | Helps you specify canvas background angle in case of gradient. | |
| canvasBorderColor | Color | 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 atribute. |
| 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. |
|
|
|||
| Data Plot Cosmetics |
|
These attributes let you configure how your plot (candles, lines, or bars) would appear on the chart. Using this, you can also control the border properties. Various other controls over plot cosmetics can be attained using this set of attributes. |
|
|
| Attribute Name | Type | Range | Description |
| bearBorderColor | Color | Hex Color | Border color for the bear candles/lines/bars. |
| bearFillColor | Color | Hex Color | Fill color for the bear candles/lines/bars. |
| bullBorderColor | Color | Hex Color | Border color for the bull candles/lines/bars. |
| bullFillColor | Color | Hex Color | Fill color for the bull candles/lines/bars. |
| rollOverBandColor | Color | Hex Color | When you hover your mouse over any candle on the chart, you'll see a colored band moving with your mouse. This attribute lets you set the color of that band |
| rollOverBandAlpha | Number | 0-100 | Lets you set the alpha of the color band. |
| showShadow | Boolean | 0/1 | Whether to show shadow for the candles and the volume bars? |
| showVPlotBorder | Boolean | 1/0 | Whther to show plot border for the volume chart? |
| vPlotBorderColor | Color | Hex Color | Border color for the volume chart bars. |
| vPlotBorderThickness | Number | In Pixels | Thickness of border of the volume chart bars. |
| vPlotBorderAlpha | Number | 0-100 | Alpha of border of the volume chart bars. |
| plotLineThickness | Number | In Pixels | Thickness of the lines on the chart, if you're plotting the price chart as lines. |
| plotLineAlpha | Number | 0-100 | Alpha of the lines on the chart. |
| plotLineDashLen | Number | In Pixels | If the lines are to be shown as dashes, this attribute defines the length of dash. |
| plotLineDashGap | Number | In Pixels | If the lines are to be shown as dashes, this attribute defines the length of dash gap. |
|
|
|||
| Anchors |
|
If the price is plotted as line chart, anchors (or marker points) are polygons which appear at the joint of two consecutive line 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 alpha to 0 and still enable tool tips and links. You can customize all the facets of anchors using the properties below. |
|
|
| Attribute Name | Type | Range | Description |
| drawAnchors | Boolean | 0/1 | Whether to draw anchors on the chart (in case of line plot only). |
| 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. Greater the radius, bigger would be the anchor size. |
| 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 & Grids |
|
Using this set of attributes, you can control the properties of divisional lines and alternate color bands. Divisional Lines are horizontal lines running through the canvas. Each divisional line signifes a smaller unit of the entire axis thus aiding the users in interpreting the chart. Alternate color bands are colored blocks between two successive divisional lines. |
|
|
| Attribute Name | Type | Range | Description |
| numPDivLines | Number | Number of divisional lines to be plotted on the price chart. | |
| numVDivLines | Number | Number of divisional lines to be plotted on the volume chart. | |
| alternateHGridAlpha | Number | Alpha (transparency) of the alternate horizontal grid bands. | |
| divLineColor | Color | 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. |
| showAlternateHGridColor | Boolean | 0/1 | Whether to show alternate colored horizontal grid bands? |
| alternateHGridColor | Color | Color of the alternate horizontal grid bands. | |
|
|
|||
| Legend Properties |
|
The name of each trend-set defined shows up in the legend of the chart. If you do not need the legend, you can opt to hide the same. Using the attributes below, you can configure the functional and cosmetic properties of the legend. |
|
|
| Attribute Name | Type | Range | Description |
| showLegend | Boolean | 0/1 | Whether to show legend for the chart (only if there are trend-sets on 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. | |
| legendMarkerCircle | Boolean | 0/1 | Whether to use square legend keys or circular ones? |
| legendBgColor | Color | Hex Code | Background color for the legend. |
| legendBgAlpha | Number | 0-100 | Background alpha for the legend. |
| legendBorderColor | Color | Hex Code | Border Color for the legend. |
| legendBorderThickness | Number | In Pixels | Border thickness for the legend. |
| legendBorderAlpha | Number | 0-100 | Border alpha for the legend. |
| legendShadow | Boolean | 0/1 | Whether to show a shadow for legend? |
| legendAllowDrag | Boolean | 0/1 | The legend can be made drag-able by setting this attribute to 1. End viewers of the chart can drag the legend around on the chart. |
| legendScrollBgColor | Color | Hex Code | If you've too many items on the legend, a scroll bar shows up on the same. This attribute lets you configure the background color of the scroll bar. |
| legendScrollBarColor | Color | Hex Code | If you've too many items on the legend, a scroll bar shows up on the same. This attribute lets you configure the bar color of the scroll bar. |
| legendScrollBtnColor | Color | Hex Code | If you've too many items on the legend, a scroll bar shows up on the same. This attribute lets you configure the color of buttons of the scroll bar. |
| reverseLegend | Boolean | 0/1 | You can reverse the ordering of datasets in the legend by setting this attribute to 1. |
|
|
|||
| Number Formatting |
|
FusionCharts v3 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 price chart will be formatted using commas, e.g., 40,000 if formatNumber='1' and 40000 if formatNumber='0 ' |
| formatNumberScale | Boolean | 0/1 | Configuration whether to add K (thousands) and M (millions) to a number after truncating and rounding it - e.g., if formatNumberScale is set to 1, 1043 would become 1.04K (with decimals set to 2 places). Same with numbers in millions - a M will added at the end. For more details, please see Advanced Number Formatting section. |
| defaultNumberScale | String | The default unit of the numbers that you're providing to the price chart. For more details, please see Advanced Number Formatting section. | |
| numberScaleUnit | String | Unit of each block of the scale. For more details, please see Advanced Number Formatting section. | |
| numberScaleValue | String | Range of the various blocks that constitute the scale. For more details, please see Advanced Number Formatting section. | |
| numberPrefix | String | Character | Using this attribute, you could add prefix to all the numbers visible on the price chart. 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 Number Formatting section. |
| numberSuffix | String | Character | Using this attribute, you could add suffix to all the numbers visible on the price chart. 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 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 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 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 a error while converting to number. So, FusionCharts accepts the input decimal and thousand separator from user, so that it can covert it accordingly into the required format. This attribute lets you input the decimal separator. For more details, please see Advanced 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 a error while converting to number. So, FusionCharts accepts the input decimal and thousand separator from user, so that it can covert it accordingly into the required format. This attribute lets you input the thousand separator. For more details, please see Advanced Number Formatting section. |
| decimals | Number | 0-10 | Number of decimal places to which all numbers on the price 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, FusionCharts will convert the number to 23.40 (note the extra 0 at the end) |
| yAxisValueDecimals | Number | 0-10 | If you've opted to not adjust div lines, you can specify the div line values decimal precision using this attribute. |
| vFormatNumber | Boolean | 0/1 | This configuration determines whether the numbers belonging to volume chart will be formatted using commas, e.g., 40,000 if vFormatNumber='1' and 40000 if vFormatNumber='0 ' |
| vFormatNumberScale | Boolean | 0/1 | Configuration whether to add K (thousands) and M (millions) to a number belonging to volume chart after truncating and rounding it - e.g., if vFormatNumberScale is set to 1, 10434 would become 1.04K (with vDecimals set to 2 places). Same with numbers in millions - a M will added at the end. For more details, please see Advanced Number Formatting section. |
| vDefaultNumberScale | String | The default unit of the numbers belonging to volume chart. For more details, please see Advanced Number Formatting section. | |
| vNumberScaleUnit | String | Unit of each block of the scale of volume chart. For more details, please see Advanced Number Formatting section. | |
| vNumberScaleValue | String | Range of the various blocks that constitute the scale for volume chart. For more details, please see Advanced Number Formatting section. | |
| vNumberPrefix | String | Character | Using this attribute, you could add prefix to all the numbers belonging to volume chart. For more details, please see Advanced Number Formatting section. |
| vNumberSuffix | String | Character | Using this attribute, you could add prefix to all the numbers belonging to volume chart. For more details, please see Advanced Number Formatting section. |
| vDecimals | Number | 0-10 | Number of decimal places to which all numbers belonging to volume chart would be rounded to. |
|
|
|||
| 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 FusionCharts v3. 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 i.e., all the values and the names in the chart which lie on the canvas will be displayed using the font size provided here. |
| baseFontColor | Color | This attribute sets the base font color of the chart i.e., all the values and the names in the chart which lie on the canvas will be displayed using the font color provided here. | |
| outCnvBaseFont | String | Font Name | This attribute sets the base font family of the chart font which lies outside the canvas i.e., all the values and the names in the chart which lie outside the canvas will be displayed using the font name provided here. |
| outCnvBaseFontSize | Number | 0-72 | This attribute sets the base font size of the chart i.e., all the values and the names in the chart which lie outside the canvas will be displayed using the font size provided here. |
| outCnvBaseFontColor | Color | This attribute sets the base font color of the chart i.e., all the values and the names in the chart which lie outside the canvas will be displayed using the font color provided here. | |
|
|
|||
| Tool-tip |
| 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 | Background Color for tool tip. | |
| toolTipBorderColor | Color | 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. | |
| showToolTipShadow | Boolean | 0/1 | Whether to show shadow for tool-tips on the chart. |
|
|
|||
| Chart Padding & Margins |
|
The following attributes help you control chart margins and paddings. FusionCharts v3 allows you manually customize the padding of various elements on the chart to allow advanced manipulation and control over chart visualization. Padding in FusionCharts is always defined in pixels, unless the attribute itself suggests some other scale (like plotSpacePercent). You can also define the chart margins. Chart Margins refer to the empty space left on the top, bottom, left and right of the chart. That means, FusionCharts wouldn't plot anything in that space. It's not necessary for you to specify any padding/margin values. FusionCharts automatically assumes the best values for the same, if you do not specify the same. |
|
|
| Attribute 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. |
| 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 on the bottom of your chart. Nothing is rendered in this space. |
| valuePadding | Number | In Pixels | It sets the vertical space between the end of candlesticks and start of value textboxes. This basically helps you control the space you want between your candlesticks and the value textboxes. |
| legendPadding | Number | In Pixels | Padding of legend from right/bottom side of canvas |
| canvasPadding | Number | (In Pixels) | Padding between the canvas left margin and 1st candlestick. Also refers to padding between the canvas right edge and the last candlestick. |
| plotSpacePercent | Number | (In Percent) | Helps you set the total space on the canvas in percentage. The higher you set this, the thinner would be your candles on the chart. |
| canvasLeftMargin | Number | In Pixels | This attribute lets you control the space between the start of chart canvas and the start (x) of chart. In case of 2D charts, the canvas is the visible rectangular box. In case of 3D charts, the canvas box is the imaginary box around the 3D canvas. Using this attribute, you can control the amount of empty space between the chart left side and canvas left side. By default, FusionCharts automatically calculates this space depending on the elements to be placed on the chart. However, if you want to over-ride this value with a higher value, you can use this attribute to specify the same. Please note that you cannot specify a margin lower than what has been calculated by the chart. This attribute is particularly useful, when you've multiple charts placed in a page and want all their canvas start position to align with each other - so in such a case, you can set same margin value (a value large enough that it doesn't get rejected by chart owing to it being lower than the calculated value) for all such charts in the page. |
| canvasRightMargin | Number | In Pixels | Like canvasLeftMargin, this attribute lets you set the space between end of canvas and end of chart. |
| canvasTopMargin | Number | In Pixels | Like canvasLeftMargin, this attribute lets you set the space between top of canvas and top of chart. |
| canvasBottomMargin | Number | In Pixels | Like canvasLeftMargin, this attribute lets you set the space between bottom of canvas and bottom of chart. |
|
|
|||
| <categories> element |
|
The <categories> element lets you bunch together x-axis labels of the chart. The following properties of <categories> element help you control the font properties of data labels. It can also be used to define the cosmetics of vertical chart lines. |
|
|
| Attribute 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 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. |
|
|
|||
| <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 candle stick 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. |
| 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/hide labels of individual data items using this attribute. |
| toolText | String | The label of each category shows up on the x-axis. However, there might be cases where you want to display short label (or abbreviated label) on the axis and show the full label as tool tip. This attribute lets you specify the tool tip text for the label. | |
|
|
|||
| <set> element |
|
Each <set> element (child of <dataset> element) represents a set of data which is to be plotted on the chart and determines a set of data which would appear on the chart. e.g., <set open='33.35' close='33.90' high='34.10' low='33.10' volume='3435670' /> |
|
|
| Attribute Name | Type | Range | Description |
| open | Number | Opening price for the set. | |
| close | Number | Closing price for the set. | |
| high | Number | Highest price point reached for the set. | |
| low | Number | Lowest price point reached for the set. | |
| volume | Number | Volume of transaction. If you do not specify volume for any of the sets, FusionCharts wouldn't plot the volume chart at the bottom. | |
| x | Number | Numeric Value | X-axis value for the plot. The candlestick point will be placed horizontally on the x-axis based on this value. |
| valuetext | String | If you want to show a text label above a candlestick, you can assignt the text to this attribute. | |
| color | Color | If you need to highlight a particular candlestick, you can assisgn a color to that particular set using this attribute. | |
| bordercolor | Color | If you need to highlight a particular candlestick, you can assisgn a border color to that particular set using this attribute. | |
| alpha | Number | Alpha of the particular set. | |
| dashed | Boolean | Whether to show this set as dashed? | |
| link | String | You can define links for individual data items. That enables the end user to click on candlesticks 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, FusionCharts 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. | |
|
|
|||
| Trend-sets |
| Using the <trendset> element in candlestick chart, you can plot overlay lines on the existing candles/lines/bars. These lines can be effectively used to show technical indicators. Example of trend-set XML: Please note that FusionCharts, by itself, doesn't calculate the value of any technical indicators. It just accepts ready to show values and displays it on the chart using trend-sets. |
| Attribute Name | Type | Range | Description |
| trendSetColor | Color | Hex Code | Lets you set the color for all the trend-sets on the chart. |
| trendSetAlpha | Number | 0-100 | Lets you set the alpha for all the trend-sets on the chart. |
| trendSetThickness | Number | Helps you set the thickness for all the trend-set lines on the chart. | |
| trendSetDashed | Boolean | 0/1 | Whether the trend-sets would appear as dashed? |
| trendSetDashLen | Number | Pixels | If the trend-sets are to be appear as dashed lines, this attribute lets you set the length of each dash. |
| trendSetDashGap | Number | Pixels | If the trend-sets are to be appear as dashed lines, this attribute lets you set the length of each dash gap. |
| |
|||
| <trendset> element |
Each <trendset> element defines a new trend-set line on the chart. You can have any number of trend-sets on the chart, each displaying a different indicator. You can set the following properties for the <trendset> element: |
| Attribute Name | Type | Range | Description |
| name | String | Name of the trend-set e.g., "Simple Moving Average", "50 Day Average" etc. This name will be displayed in the legend of the chart. | |
| color | Color | Hex Code | Color for this trend set. |
| alpha | Number | Alpha of this trend set. | |
| thickness | Number | Pixels | Thickness of this trend set. |
| includeinlegend | Boolean | 0/1 | Whether to include the name of this trend set in legend? |
| dashed | Boolean | 0/1 | Whether to show this trend set as dashed? |
| dashlen | Number | In Pixels | If you've opted to show as dash, this attribute lets you control the dash length. |
| dashlen | Number | In Pixels | If you've opted to show as dash, this attribute lets you control the dash gap length. |
| |
|||
| <set> element under <trendset> element |
Each <set> element under <trendset> can just have two attributes: x and value. x represents the x-axis index where this value should be plotted. |
| Trend-lines |
|
Using the <trendLines> element (and children <line> elements), you can define trend lines on the chart. Trend lines are horizontal/vertical lines spanning the chart canvas which aid in interpretation of data with respect to some pre-determined value. 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 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 would display a line, or a zone (filled colored rectangle). |
| showOnTop | Boolean | 0/1 | Whether the trend line/zone would be displayed over data plots or under them? |
| thickness | Number | In Pixels | If you've opted to show the trend as a line, this attribute lets you define the thickness of trend line. |
| alpha | Number | 0-100 | Alpha of the trend line. |
| dashed | Boolean | 0/1 | If you've opted to show the trend as a line, this attribute lets you define whether the trend line would appear as dashed? |
| dashLen | Number | In Pixels | If you've opted to show trend line as dash, this attribute lets you control the length of each dash. |
| dashGap | Number | In Pixels | If you've opted to show trend line as dash, this attribute lets you control the length of each dash gap. |
|
|
|||
| Vertical Trend-lines |
|
Vertical trend lines help you create vertical trend lines/zones. These are vertical lines spanning the chart canvas which aid in interpretation of data with respect to some pre-determined value. 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 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 would display a line, or a zone (filled colored rectangle). |
| thickness | Number | In Pixels | If you've opted to show the trend as a line, this attribute lets you define the thickness of trend line. |
| alpha | Number | 0-100 | Alpha of the trend line. |
| dashed | Boolean | 0/1 | If you've opted to show the trend as a line, this attribute lets you define whether the trend line would appear as dashed? |
| dashLen | Number | In Pixels | If you've opted to show trend line as dash, this attribute lets you control the length of each dash. |
| dashGap | Number | In Pixels | If you've opted to show trend line as dash, this attribute lets you control the length of each dash gap. |
|
|
|||
