Candlestick Chart

ALIAS: candlestick

Example of Candlestick Chart:

FusionCharts should load here..

JavaScript embedding code:

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

Data for this chart:

...

Chart Attributes

Functional Attributes

These attributes let you control a variety of functional elements on the chart. For example, you can opt to show/hide data labels, data values, y-axis values. You can also set chart limits and extended properties.

Name Type Range Description
animation Boolean 0/1 This attribute lets you set the configuration whether the chart should appear in an animated fashion. If you do not want to animate any part of the chart, set this as 0.
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 0/1 If you have 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 Each chart has 5 pre-defined color palettes which you can choose from. Each palette renders the chart in a different color theme.
paletteColors String List of hex color codes separated by comma While the `palette` attribute allows to select a palette theme that applies to chart background, canvas, font and tool-tips, it does not change the colors of data items (i.e., column, line, pie etc.). Using `paletteColors` attribute, you can specify your custom list of hex colors for the data items. The list of colors have to be separated by comma e.g., `"paletteColors": "#FF0000, #0372AB, #FF5904..."`. The chart will cycle through the list of specified colors and then render the data plot accordingly. To use the same set of colors throughout all your charts in a web application, you can store the list of palette colors in your application globally and then provide the same in each chart data.
showVolumeChart Boolean 0/1 If you want to hide volume chart, you can use this attribute.
volumeHeightPercent Number 20%-80% Height of the volume chart in percent (with respect to total chart). By default, it's set to 40%. Range is between 20%-80%.
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.
showZeroPlaneValue Boolean 0/1 Allows you to show or hide the value 0f the zero plane.
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'`.
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.
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, the chart 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, the chart 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 the chart 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 the chart based on the data provided by you.
vYAxisMinValue Number Lower limit for the volume chart axis. If you do not specify this, the chart will automatically calculate for you.
vYAxisMaxValue Number Upper limit for the volume chart axis. If you do not specify this, the chart will automatically calculate for you.
showLabels Boolean 0/1 It sets the configuration whether the x-axis labels will be displayed or not.
labelDisplay String 'AUTO', 'WRAP':, 'STAGGER', 'ROTATE', 'NONE' Using this attribute, you can customize the alignment of data labels (x-axis labels). There are 5 options: AUTO, WRAP, STAGGER, ROTATE or NONE. By default, this attribute is set to AUTO mode which means that the alignment of the data labels is determined automatically depending on the size of the chart. WRAP wraps the label text if it is too long to fit in one line. ROTATE rotates the labels vertically. STAGGER divides the labels into multiple lines.
useEllipsesWhenOverflow
Since 3.2
Boolean 0/1 When enabled in auto mode, long data labels are truncated by adding ellipses to prevent them from overflowing the chart background. The default value is 1.
rotateLabels Boolean 0/1 This attribute lets you set whether the data labels would show up as rotated labels on the chart.
slantLabels Boolean 0/1 If you have opted to show rotated labels on chart, this attribute lets you set the configuration whether the labels would show as slanted labels or fully vertical ones.
labelStep Number 1 or above By default, all the labels are displayed on the chart. However, if you have a set of streaming data (like name of months or days of week), you can opt to show every n-th label for better clarity. This attribute just lets you do so. It allows to display every n(th) y-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.
yAxisValuesStep Number 1 or above By default, all div lines show their values. However, you can opt to display every x(th) div line value using this attribute.
adjustDiv Boolean 0/1 The chart automatically tries to adjust divisional lines and limit values based on the data provided. However, if you want to set your explicit lower and upper limit values and number of divisional lines, first set this attribute to false. That would disable automatic adjustment of divisional lines.
rotateYAxisName Boolean 0/1 If you do not wish to rotate y-axis name, set this as 0. It specifically comes to use when you have special characters (UTF8) in your y-axis name that do not show up in rotated mode.
yAxisNameWidth Number (In Pixels) If you opt to not rotate y-axis name, you can choose a maximum width that will be applied to y-axis name.
clickURL String The entire chart can now act as a hotspot. Use this URL to define the hotspot link for the chart. The link can be specified in FusionCharts Link Format.
setAdaptiveYMin Boolean 0/1 This attribute lets you set whether the y-axis lower limit would be 0 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

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

Name Type Description
caption String Caption of the chart.
subCaption String Sub-caption of the chart.
pYAxisName String The y-axis name for the price chart.
vYAxisName String The y-axis name for the volume chart.

Chart Caption Cosmetics

These attributes let you configure the cosmetics of chart caption and sub-caption.

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

Y-Axis name cosmetics

These attributes let you control the Y-Axis name cosmetics.

Name Type Range Description
pYAxisNameFont String Font Name Sets the primary y-axis font family for the text, in case of a dual-y axis chart
pYAxisNameFontColor Color Hex Code Sets the primary y-axis font color
pYAxisNameFontSize Number 0 - 72 Specifies the primary y-axis font size
pYAxisNameFontBold Boolean 0/1 Whether primary y-axis font should be bold
pYAxisNameFontItalic Boolean 0/1 Whether primary y-axis font should be italicized
pYAxisNameBgColor Color Hex Code Sets the background color for primary y-axis text
pYAxisNameBorderColor Color Hex Code Sets the border around the primary y-axis text
pYAxisNameAlpha Number 0-100 Sets the primary y-axis alpha including font and background
pYAxisNameFontAlpha Number 0-100 Sets the primary y-axis font alpha
pYAxisNameBgAlpha Number 0-100 Sets the primary y-axis background alpha
pYAxisNameBorderAlpha Number 0-100 Sets the primary y-axis border alpha
pYAxisNameBorderPadding Number In Pixels Sets the primary y-axis border padding
pYAxisNameBorderRadius Number In Pixels Sets the primary y-axis border radius
pYAxisNameBorderThickness Number In Pixels Sets the primary y-axis border thickness
pYAxisNameBorderDashed Number In Pixels Whether the border around the primary y-axis should be rendered using dashed lines
pYAxisNameBorderDashLen Number In Pixels Sets the length of each dash
pYAxisNameBorderDashGap Number In Pixels Sets the gap between two consecutive dashes.

Chart Cosmetics

The following attributes let you configure chart cosmetics like background color, background alpha, canvas color & alpha etc.

Name Type Range Description
showBorder Boolean 0/1 Whether to show a border around the chart or not.
borderColor Color Hex Code Border color of the chart.
borderThickness Number In Pixels Border thickness of the chart.
borderAlpha Number 0-100 Border alpha of the chart.
bgColor Color Hex Code This attribute sets the background color for the chart. You can set any hex color code as the value of this attribute. To specify a gradient as background color, separate the hex color codes of each color in the gradient using comma. Example: `#FF5904, #FFFFFF`.
bgAlpha Number 0-100 Sets the alpha (transparency) for the background. If you have opted for gradient background, you need to set a list of alpha(s) separated by comma.
bgRatio Number 0-100 If you have opted for a gradient background, this attribute lets you set the ratio of each color constituent.
bgAngle Number 0-360 Angle of the background color, in case of a gradient.
bgImage
Since 3.2.
String To place any image (JPG/PNG/GIF) as background of the chart, enter the (path and) name of the background image. It should be in the same domain as the chart.
bgImageAlpha
Since 3.2.
Number 0-100 This attribute specifies the opacity for the loaded background image.
bgImageDisplayMode
Since 3.2.1
String stretch, tile, fit, fill, center, none Helps you specify the mode in which the background image is to be displayed. Stretch - expands the image to fit the entire chart area, without maintaining original image constraints. Tile - the image is repeated as a pattern on the entire chart area. Fit - fits the image proportionately on the chart area. Fill -proportionately fills the entire chart area with the image. Center - the image is positioned at the center of the chart area. None - Default mode.
bgImageValign
Since 3.2.1
String left, center, right Helps you to vertically align the background image.
bgImageHalign
Since 3.2.1
String left, center, right Helps you to horizontally align the background image.
bgImageScale
Since 3.2.1
Number 0-300 Helps you magnify the background image.This attribute will only work when the attribute `bgImageDisplayMode` is set to none, center, or tile.
canvasBgColor Color Hex Code Sets canvas background color. For Gradient effect, enter colors separated by comma.
canvasBgAlpha Number 0-100 Sets alpha for canvas background. For gradient, enter alpha list separated by commas.
canvasBgRatio Number 0-100 Helps you specify canvas background ratio for gradients.
canvasBgAngle Number 0-360 Helps you specify canvas background angle in case of gradient.
canvasBorderColor Color Hex Code Lets you specify canvas border color.
canvasBorderThickness Number 0-5 Lets you specify canvas border thickness.
canvasBorderAlpha Number 0-100 Lets you control transparency of canvas border.
logoURL String URL You can load an external logo (JPEG/PNG) to your chart, this attribute lets you specify the URL. Due to cross domain security restrictions it is advised to use a logo from the same domain name as your charts.
logoPosition String TL, TR, BL, BR, CC Where to position the logo on the chart: TL - Top-left TR - Top-right BR - Bottom right BL - Bottom left CC - Center of screen
logoAlpha Number 0-100 Once the logo has loaded on the chart, you can configure its opacity using this attribute.
logoScale Number 0-300 You can also change the scale of an externally loaded logo at run-time by specifying a value for this parameter.
logoLink String URL If you want to link the logo to an external URL, specify the link in this attribute. The link can be in FusionCharts Link Format, allowing you to link to new windows, pop-ups, frames etc.

Data Plot Cosmetics

Various other controls over plot cosmetics can be attained using this set of attributes.If the plots can show borders, you can control the border properties using the attributes listed below. Or, if they support gradient fills, you can again configure various properties of the gradient using these attributes.

These attributes let you configure how your plot (columns, lines, area, pie or any data that you're plotting) will appear on the chart.

Name Type Range Description
bearBorderColor Color Hex Code Border color for the bear candles/lines/bars.
bearFillColor Color Hex Code Fill color for the bear candles/lines/bars.
bullBorderColor Color Hex Code Border color for the bull candles/lines/bars.
bullFillColor Color Hex Code Fill color for the bull candles/lines/bars.
rollOverBandColor Color Hex Code 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 apply the shadow effect for the candles and the volume bars.
showVPlotBorder Boolean 0/1 Whether to show plot border for the volume chart.
vPlotBorderColor Color Hex Code 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 Sets the gap between two consecutive dashes.

Data Value Cosmetics

These attributes let you configure font, background and border cosmetics, of value text-field that appear for each data plot.

Name Type Range Description
valueFont String Font Name Sets the font of the values in the chart
valueFontColor Color Hex Code Specifies the value font color
valueFontSize Number 0 - 72 Specifies the value font size
valueFontBold Boolean 0/1 Whether value font should be bold
valueFontItalic Boolean 0/1 Whether value font should be italicized
valueBgColor Color Hex Code Sets the background color for value text
valueBorderColor Color Hex Code Sets the border color around the value text
valueAlpha Number 0-100 Sets the value alpha including font and background
valueFontAlpha Number 0-100 Sets the value font alpha
valueBgAlpha Number 0-100 Sets the value background alpha
valueBorderAlpha Number 0-100 Sets the value border alpha
valueBorderThickness Number In Pixels Sets the value border thickness
valueBorderRadius Number In Pixels Sets the value border radius
valueBorderDashed Boolean 0/1 Whether the border around the value should be rendered as a dashed border
valueBorderDashGap Number In Pixels Sets the gap between two consecutive dashes.
valueBorderDashLen Number In Pixels Sets the length of each dash
valueHoverAlpha Number 0-100 Sets the value alpha on hover
valueFontHoverAlpha Number 0-100 Sets the value font alpha on hover
valueBgHoverAlpha Number 0-100 Sets the value background alpha on hover
valueBorderHoverAlpha Number 0-100 Sets the value border alpha on hover
showValuesOnHover Boolean 0/1 Displays the value while dataplot on hover

Anchors

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.

These attributes let you represent data point in a line/spline/area chart.

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.
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

You can control various properties of divisional lines, zero plane and alternate color bands.

Divisional Lines are horizontal or vertical lines running through the canvas. Each divisional line signifies a smaller unit of the entire axis thus aiding the users in interpreting the chart.

The zero plane is a 2D/3D plane that signifies the 0 position on the chart. If there are no negative numbers on the chart, you won't see a visible zero plane.

Alternate color bands are colored blocks between two successive divisional lines.

These attributes let you configure the divisional lines & grids.

Name Type Range Description
numPDivLines Number Number of divisional lines to be plotted on the price chart.
numDivLines Number Numeric value > 0 Number of divisional lines to be plotted on the volume chart.
alternateHGridAlpha Number 0-100 Alpha (transparency) of the alternate horizontal grid bands.
divLineColor Color Hex Code Color for divisional lines
divLineThickness Number 1-5 Thickness of divisional lines
divLineAlpha Number 0-100 Alpha of divisional lines.
divLineDashed Boolean 0/1 Whether the divisional lines should be displayed as dashed lines instead of whole lines.
divLineDashLen Number In Pixels If the divisional lines are to be displayed as dashed lines, this attribute lets you control the length of each dash.
divLineDashGap Number In Pixels Sets the gap between two consecutive dashes.
showAlternateHGridColor Boolean 0/1 Whether to show alternate colored horizontal grid bands.
alternateHGridColor Color Hex Code Color of the alternate horizontal grid bands.
showAlternateVGridColor Boolean 0/1 Whether to show alternate vertical colored grid bands.
alternateVGridColor Color Hex Code Color of alternate vertical colored grid bands.
alternateVGridAlpha Number 0-100 Alpha of alternate vertical colored grid bands.

Legend Properties

In candlestick chart, the series name of each data-set shows up in the legend of the chart. If you do not need the legend, you can opt to hide the same.

Also, the legend can be placed at the bottom of the chart or to the right of the chart.

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

Name Type Range Description
showLegend Boolean 0/1 Whether to show legend for the chart (only if there are trend-sets on the chart).
legendItemFontBold Boolean 0/1 Whether legend keys should be displayed in bold
legendItemFont String Font Name Sets legend item font
legendItemFontSize Number 0 - 72 Sets legend item font size
legendItemFontColor Color Hex Code Sets legend item font color
legendPosition String BOTTOM or RIGHT The legend can be plotted at two positions on the chart - below (BOTTOM) the chart and to the right (RIGHT) of the chart.
legendCaptionAlignment String "left", "center", "right" Sets the legend caption horizontal alignment .
legendCaptionBold Boolean 0/1 Whether legend caption should be displayed in bold
legendCaptionFont String Font Name Sets legend caption font
legendCaptionFontSize Number 0 - 72 Sets legend caption font size
legendCaptionFontColor Color Hex Code Sets legend caption font color
legendItemHiddenColor Color Hex Code Sets the color that applies on both text font and icon when they are in a disabled / hidden state
legendIconScale
Since 3.2
Number 1-5 Scaling of legend icon is possible starting PowerCharts XT. This attribute lets you control the size of legend icon.
legendBgColor Color Hex Code Background color for the legend.
legendBgAlpha Number 0-100 Background alpha for the legend.
legendBorderColor Color Hex Code Border Color for the legend.
legendBorderThickness Number In Pixels Border thickness for the legend.
legendBorderAlpha Number 0-100 Border alpha for the legend.
legendShadow Boolean 0/1 Whether to show a shadow for legend.
legendAllowDrag Boolean 0/1 The legend can be made drag-able by setting this attribute to 1. End viewers of the chart can drag the legend around on the chart.
legendScrollBgColor Color Hex Code If you have too many items on the legend, a scroll bar shows up on the same. This attribute lets you configure the background color of the scroll bar.
reverseLegend Boolean 0/1 You can reverse the order of datasets in the legend by setting this attribute to 1.
legendNumColumns
Since 3.2
Number Positive Integer If your chart contains multiple series, the legend is displayed as a grid comprising of multiple legend keys. With the help of this attribute you can specify the number of columns that are to be displayed in the legend.
minimiseWrappingInLegend
Since 3.2
Boolean 0/1 Whether to minimize legend item text wrapping.

Number Formatting Properties

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

Using the attributes below, you can control a myriad of options like:

  • Formatting of commas and decimals
  • Number prefixes and suffixes
  • Decimal places to which the numbers will round to
  • Scaling of numbers based on a user defined scale
  • Custom number input formats

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

Name Type Range Description
formatNumber Boolean 0/1 This configuration determines whether the numbers displayed on the 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 - an M will be added at the end.
defaultNumberScale String The default unit of the numbers that you're providing to the price chart.
numberScaleUnit String Unit of each block of the scale.
numberScaleValue String Range of the various blocks that constitute the scale.
scaleRecursively
Since 3.2.1
Boolean 0/1 Whether recursive scaling should be applied.
maxScaleRecursion
Since 3.2.1
Number How many recursions to complete during recursive scaling? -1 completes the entire set of recursion.
scaleSeparator
Since 3.2.1
String What character to use to separate the scales that are generated after recursion?
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.
numberSuffix String Character Using this attribute, you could add suffix to all the numbers visible on the price chart. For example, to represent all figures quantified as per annum on the chart, you could specify this attribute to ' /a' to show like 40000/a, 50000/a.
decimalSeparator String Character This attribute helps you specify the character to be used as the decimal separator in a number.
thousandSeparator String Character This attribute helps you specify the character to be used as the thousands separator in a number.
thousandSeparatorPosition
Since 3.2.1
Number   This option helps you specify the position of the thousand separator.
inDecimalSeparator String Character In some countries, commas are used as decimal separators and dots as thousand separators. In XML, if you specify such values, it will give an error while converting to number. So, the chart accepts the input decimal and thousand separator from user, so that it can convert it accordingly into the required format. This attribute lets you input the decimal separator.
inThousandSeparator String Character In some countries, commas are used as decimal separators and dots as thousand separators. In XML, if you specify such values, it will give an error while converting to number. So, the chart accepts the input decimal and thousand separator from user, so that it can convert it accordingly into the required format. This attribute lets you input the thousand separator.
decimals Number 0-10 Number of decimal places to which all numbers on the 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, the number will automatically be converted to 23.40 (note the extra 0 at the end).
forceVDecimals
Since 3.2.1
Boolean 0/1 Whether to add 0 padding at the end of decimal numbers of the volume chart. 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).
forceYAxisValueDecimals
Since 3.2
Boolean 0/1 Whether to forcefully attach decimal places to all y-axis values. For example, If you limit the maximum number of decimal digits to 2, a number like 55.345 will be rounded to 55.34. This does not mean that all y-axis numbers will be displayed with a fixed number of decimal places. For instance 55 will not be displayed as 55.00 and 55.1 will not become 55.10. In order to have fixed number of decimal places attached to all y-axis numbers, set this attribute to 1.
forceVYAxisValueDecimals
Since 3.2.1
Boolean 0/1 Whether to forcefully attach decimal places to all y-axis values of the volume chart. For example, If you limit the maximum number of decimal digits to 2, a number like 55.345 will be rounded to 55.34. This does not mean that all y-axis numbers will be displayed with a fixed number of decimal places. For instance 55 will not be displayed as 55.00 and 55.1 will not become 55.10. In order to have fixed number of decimal places attached to all y-axis numbers, set this attribute to 1.
yAxisValueDecimals Number 0-10 If you have opted to not adjust div lines, you can specify the div line values decimal precision using this attribute.
vYAxisValueDecimals
Since 3.2.1
Number 0-10 If you have opted to not adjust div lines of the volume chart, 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 - an M will be added at the end.
vDefaultNumberScale String The default unit of the numbers belonging to volume chart.
vNumberScaleUnit String Unit of each block of the scale of volume chart.
vNumberScaleValue String Range of the various blocks that constitute the scale for volume chart.
vScaleRecursively
Since 3.2.1
Boolean 0/1
vMaxScaleRecursion
Since 3.2.1
Number How many recursions to complete during recursive scaling of the numbers of volume chart? -1 completes the entire set of recursion.
vScaleSeparator
Since 3.2.1
String
vNumberPrefix String Character Using this attribute, you could add prefix to all the numbers belonging to volume chart.
vNumberSuffix String Character Using this attribute, you could add prefix to all the numbers belonging to volume chart.
vDecimals Number 0-10 Number of decimal places to which all numbers belonging to volume chart would be rounded to.

Font Properties

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

Name Type Range Description
baseFont String Font Name This attribute lets you set the font face (family) of all the text (data labels, values etc.) on chart. If you specify the `outCnvBaseFont` attribute also, then this attribute controls only the font face of text within the chart canvas bounds.
baseFontSize Number 0-72 This attribute sets the base font size of the chart i.e., all the values and the names in the chart which lie on the canvas will be displayed using the font size provided here.
baseFontColor Color Hex Code This attribute sets the base font color of the chart i.e., all the values and the names in the chart which lie on the canvas will be displayed using the font color provided here.
outCnvBaseFont String Font Name This attribute sets the base font family of the chart text which lies outside the canvas i.e., all the values and the names in the chart which lie outside the canvas will be displayed using the font name provided here.
outCnvBaseFontSize Number 0-72 This attribute sets the base font size of the chart i.e., all the values and the names in the chart which lie outside the canvas will be displayed using the font size provided here.
outCnvBaseFontColor Color Hex Code This attribute sets the base font color of the chart i.e., all the values and the names in the chart which lie outside the canvas will be displayed using the font color provided here.

Tool-tip Properties

These attributes let you configure tool-tip properties.

Name Type Range Description
showToolTip Boolean 0/1 Whether to show tool tip on chart.
toolTipBgColor Color Hex Code Background color for tool tip.
toolTipColor Color Code Hex Code Font color for the tool-tip.
toolTipBorderColor Color Hex Code Border color for tool tip.
toolTipSepChar String The character specified as the value of this attribute separates the name and value displayed in tool tip.
showToolTipShadow Boolean 0/1 Whether to show shadow for tool-tips on the chart.

Data Plot Hover Effects

You can show an effect on the data plot (column, line anchor, pie etc.) when the user hovers his mouse over the data plot using hover effects of data plots.

These attributes let you configure the cosmetics of the hover for all data plots in the chart.

Name Type Range Description
showHoverEffect Boolean 0/1 Whether to enable hover effect on charts for all elements
plotHoverEffect Boolean 0/1 Whether to enable hover effect on charts for data plots (e.g., column, pie) only
plotFillHoverColor Color Hex Code Specifies the hover color for the data plots
plotFillHoverAlpha Number 1 - 100 Specifies the hover alpha for data plots

Chart Padding & Margins

PowerCharts XT allows you to manually customize the padding of various elements on the chart to allow advanced manipulation and control over chart visualization. Padding in PowerCharts XT is always defined in pixels, unless the attribute itself suggests some other scale (like plotSpacePercent).

You can also define the chart margins. Chart margins refer to the empty space left on the top, bottom, left, and right of the chart. That means, PowerCharts XT will not plot anything in that space.

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

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

Name Type Range Description
captionPadding Number In Pixels This attribute lets you control the space (in pixels) between the sub-caption and top of the chart canvas. If the sub-caption is not defined, it controls the space between caption and top of chart canvas. If neither caption, nor sub-caption is defined, this padding does not come into play.
yAxisNamePadding Number In Pixels Using this, you can set the distance between the right end of y-axis title and the start of y-axis values (or canvas, if the y-axis values are not to be shown).
yAxisValuesPadding Number In Pixels This attribute helps you set the horizontal space between the canvas left edge and the y-axis values or trend line values (on left/right side). This is particularly useful, when you want more space between your canvas and y-axis values.
labelPadding Number In Pixels This attribute sets the vertical space between the labels and canvas bottom edge. If you want more space between the canvas and the x-axis labels, you can use this attribute to control it.
chartLeftMargin Number In Pixels Amount of empty space that you want to put on the left side of your chart. Nothing is rendered in this space.
chartRightMargin Number In Pixels Amount of empty space that you want to put on the right side of your chart. Nothing is rendered in this space.
chartTopMargin Number In Pixels Amount of empty space that you want to put on the top of your chart. Nothing is rendered in this space.
chartBottomMargin Number In Pixels Amount of empty space that you want to put at the bottom of your chart. Nothing is rendered in this space.
valuePadding Number In Pixels It sets the vertical space between the end of 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 or 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.

The <categories> element

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

These attributes of the <categories> element let you control the font properties of data labels.

Name Type Range Description
font String Valid font face Lets you specify font face for the x-axis data labels.
fontSize Number Lets you specify font size for the x-axis data labels.
fontColor Color Hex Code Lets you specify font color for the x-axis data labels.
verticalLineColor Color Hex Code You can opt to show vertical lines for each category label. This attribute lets you set the color for all of them.
verticalLineThickness Number In Pixels Lets you set the thickness for category lines.
verticalLineAlpha Number 0-100 Lets you set the alpha for category lines.
verticalLineDashed Boolean 0/1 Whether the category lines should appear as dashed.
verticalLineDashLen Number In Pixels If the category lines are to appear as dashed, this attribute defines the length of dash.
verticalLineDashGap Number In Pixels Sets the gap between two consecutive dashes.

The <category> element

Each <category> element represents an x-axis data label.

In a multi-series chart, it's necessary to provide an equal number of <category> elements and data items ( <set> element within each <dataset>). PowerCharts XT plots only those data items for which it could find a respective <category> element.

These attributes let you configure the <category> element.

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 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 dataplots. However, this will not appear when the cursor is moved over the data labels (except for a situation when long labels are automatically truncated with ellipses. In this situation, if the mouse cursor is hovered over a truncated label, the tooltip will appear with the full label). In case you want to set a short label and show the full label in tooltip, define the full label using this attribute within the `<category>` element. The tooltip with the full label will appear only when the mouse is hovered on the dataplot.

The <set> element

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

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

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

These attributes let you configure <set> element.

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, PowerCharts XT wouldn't plot the volume chart at the bottom.
x Number Numeric Value The 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 assign the text to this attribute.
color Color Hex Code If you need to highlight a particular candlestick, you can assign a color to that particular set using this attribute
bordercolor Color Hex Code If you need to highlight a particular candlestick, you can assign a border color to that particular set using this attribute.
alpha Number 0-100 Alpha of the particular set.
dashed Boolean 0/1 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, PowerCharts XT shows the series name, category name, and value as tool tip text for that data item. But, if you want to display more information for the data item as tool tip, you can use this attribute to specify the same.

Trend-set

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.

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

    <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>

Please note that PowerCharts XT, by itself, does not calculate the value of any technical indicators. It just accepts ready to show values and displays it on the chart using trend-sets.

These attributes let you configure the cosmetic and functional properties of all trend-sets on the chart.

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 Sets the gap between two consecutive dashes.

The <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.

These attributes let you configure the <trendset> element.

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 have opted to show as dash, this attribute lets you control the dash length.
dashgap Number In Pixels If you have 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 lines spanning the chart canvas which aid in interpretation of data with respect to some pre-determined value. For example, if you are plotting sales data of current year, you might want to add previous year's average monthly sales as trend indicator for ease of comparison.

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

    "trendlines": [{
     "line": [{
                "startvalue": "177500",
                 "color": "#9b59b6",
                 "displayvalue": "Target"
             }]
                    }]

These attributes let you configure the trendline cosmetic and functional properties.

Name Type Range Description
startValue Number Numeric Value The starting value for the trendline. Say, if you want to plot a slanted trendline from value 102 to 109, the `startValue` would be 102.
endValue Number Numeric Value The ending y-axis value for the trendline. Say, if you want to plot a slanted trendline from value 102 to 109, the `endValue` would be 109. If you do not specify a value for `endValue`, it would automatically assume the same value as `startValue`.
displayValue String If you want to display a string caption for the trend line by its side, you can use this attribute. Example:` displayValue='Last Month High'`. When you don't supply this attribute, it automatically takes the value of `startValue`.
color String Hex Code Color of the trend line and its associated text
isTrendZone Boolean 0/1 Whether the trend will be displayed as a line or a zone (fill-colored rectangle).
showOnTop Boolean 0/1 Whether the trend line/zone would be displayed over data plots or behind them.
thickness Number In Pixels If you have opted to show the trend as a line, this attribute lets you define the thickness of trend line.
alpha Number 0-100 Alpha of the trend line.
dashed Boolean 0/1 If you have opted to show the trend as a line, this attribute lets you define whether the trend line would appear as dashed.
dashLen Number In Pixels If you have opted to show trend line as dash, this attribute lets you control the length of each dash.
dashGap Number In Pixels If you have opted to show trend line as dash, this attribute lets you control the length of each dash gap.

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.

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

    "vtrendlines": [{
     "line": [{
                   "startvalue":"20",
                  "endvalue":"65",
                  "alpha":"5",
                  "color":"00FF00"
             }]
                    }]

These attributes let you configure the vertical trend-lines in a chart.

Name Type Range Description
startValue Number Numeric Value The starting value for the trendline. Say, if you want to plot a slanted trendline from value 102 to 109, the `startValue` would be 102.
endValue Number Numeric Value The ending y-axis value for the trendline. Say, if you want to plot a slanted trendline from value 102 to 109, the `endValue` would be 109. If you do not specify a value for `endValue`, it would automatically assume the same value as `startValue`.
displayValue String If you want to display a string caption for the trend line by its side, you can use this attribute. Example:` displayValue='Last Month High'`. When you don't supply this attribute, it automatically takes the value of `startValue`.
color String Hex Code Color of the trend line and its associated text
isTrendZone Boolean 0/1 Whether the trend will be displayed as a line or a zone (fill-colored rectangle).
showOnTop Boolean 0/1 Whether the trend line/zone would be displayed over data plots or behind them.
thickness Number In Pixels If you have opted to show the trend as a line, this attribute lets you define the thickness of trend line.
alpha Number 0-100 Alpha of the trend line.
dashed Boolean 0/1 If you have opted to show the trend as a line, this attribute lets you define whether the trend line would appear as dashed.
dashLen Number In Pixels If you have opted to show trend line as dash, this attribute lets you control the length of each dash.
dashGap Number In Pixels If you have opted to show trend line as dash, this attribute lets you control the length of each dash gap.