Chart Attributes
- a
- b
- c
- d
- e
- f
- g
- h
- i
- j
- k
- l
- m
- n
- o
- p
- q
- r
- s
- t
- u
- v
- w
- x
- y
- z
- Area 2D
- Bar 2D
- Bar 3D
- Box and Whisker 2D
- Bubble Chart
- Candlestick Chart
- Column 2D
- Column 3D
- Doughnut 2D
- Doughnut 3D
- Drag Node Chart
- Drag-able Area 2D Chart
- Drag-able Column 2D Chart
- Drag-able Line 2D Chart
- Error Bar Chart
- Error Line 2D Chart
- Error Scatter Chart
- Funnel Chart
- Gantt Chart
- Heat Map Chart
- Horizontal Bullet Graph
- Horizontal LED
- Inverse Y-axis Area Chart
- Inverse Y-axis Column 2D Chart
- Inverse Y-axis Line 2D Chart
- Kagi Chart
- Line 2D
- Logarithmic Column 2D Chart
- Logarithmic Line 2D Chart
- Marimekko
- Multi-axis Line Chart
- Multi-level Pie Chart
- Multi-series 2D Dual Y Combination Chart (Column + Line + Area + Spline)
- Multi-series 2D Single Y Combination Chart (Column + Line + Area + Spline)
- Multi-series 3D Single Y Combination Chart (Column + Line + Area + Spline)
- Multi-series Area 2D
- Multi-series Bar 2D
- Multi-series Bar 3D
- Multi-series Column 2D
- Multi-series Column 3D
- Multi-series Column 3D + Line Dual Y Axis
- Multi-series Column 3D + Line Single Y-axis
- Multi-series Line 2D
- Multi-series Spline
- Multi-series Spline Area
- Multi-series Stacked Column 2D
- Multi-series Stacked Column 2D + Line Dual Y Axis
- Overlapped Column 2D
- Overlapped Bar 2D
- Pareto 2D
- Pareto 3D
- Pie 2D
- Pie 3D
- Pyramid Chart
- Radar Chart
- Real-time Angular
- Real-time Area
- Real-time Bulb
- Real-time Column
- Real-time Cylinder
- Real-time Horizontal Linear
- Real-time Line
- Real-time Line (Dual Y)
- Real-time Stacked Area
- Real-time Stacked Column
- Real-time Thermometer
- Scatter Chart
- Scroll Area 2D
- Scroll Column 2D
- Scroll Combination 2D (Dual Y)
- Scroll Combination 2D (Single Y)
- Scroll Line 2D
- Scroll Stacked Column 2D
- Select-scatter Chart
- Single-series Spline 2D
- Single-series Spline Area 2D
- Spark Column
- Spark Line
- Spark Win/Loss
- Stacked 2D Column + Line Single Y-axis
- Stacked 3D Column + Line Single Y-axis
- Stacked Area 2D
- Stacked Bar 2D
- Stacked Bar 3D
- Stacked Column 2D
- Stacked Column 3D
- Stacked Column 3D + Line Dual Y Axis
- Step Line Charts
- Tree Map Chart
- Vertical Bullet Graph
- Vertical LED
- Waterfall / Cascade Chart
- Zoom Line
- Zoom Line Dual Y-axis
- Zoom Scatter
- json
- xml
{
"chart": {
"caption": "Total Profit Calculation",
"subcaption": "Last month",
"yAxisname": "Amount (In USD)",
"numberprefix": "$",
"connectordashed": "1",
"sumlabel": "Total {br} Profit",
"positiveColor": "#6baa01",
"negativeColor": "#e44a00",
"theme": "fusion"
},
"data": [
{
"label": "Online sales",
"value": "420000"
},
{
"label": "Store Sales",
"value": "710000"
},
{
"label": "Total Sales",
"issum": "1"
},
{
"label": "Fixed Costs",
"value": "-250000"
},
{
"label": "Variable Costs",
"value": "-156000"
},
{
"label": "COGS",
"value": "-310000"
},
{
"label": "Promotion Costs",
"value": "-86000"
},
{
"label": "Total Costs",
"issum": "1",
"cumulative": "0"
}
]
}
<chart caption="Total Profit Calculation" subcaption="Last month" yaxisname="Amount (In USD)" numberprefix="$" connectordashed="1" sumlabel="Total {br} Profit" positivecolor="#6baa01" negativecolor="#e44a00" theme="fusion">
<set label="Online sales" value="420000" />
<set label="Store Sales" value="710000" />
<set label="Total Sales" issum="1" />
<set label="Fixed Costs" value="-250000" />
<set label="Variable Costs" value="-156000" />
<set label="COGS" value="-310000" />
<set label="Promotion Costs" value="-86000" />
<set label="Total Costs" issum="1" cumulative="0" />
</chart>
Chart Atributes
Functional Attributes
These attributes let you control a variety of functional elements on the chart. For example, you can opt to show or hide data labels, data values. You can also set chart limits and extended properties.
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.
Range: 0/1
This attribute sets the animation duration of the chart. animationDuration
attribute is applicable only if animation of the chart is enabled.
Default value: 1 sec
Range: In seconds
Each chart has 5 pre-defined color palettes which you can choose from. Each palette renders the chart in a different color theme.
Range: 1-5
While the palette
attribute allows to select a palette theme that applies to chart background, canvas, font and tool-tips, it does not change the colors of data items (that is, column, line, pie etc.). Using paletteColors
attribute, you can specify your custom list of hex colors for the data items. The list of colors have to be separated by comma. For example, "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.
Range: List of hex color codes separated by comma
It sets the configuration whether the x-axis labels will be displayed or not.
Range: 0/1
This attribute can be used to set the maximum height for the x-axis labels (data labels) excluding the x-axis title. If any label goes beyond this height, the label will be truncated. In stagger mode, the number of stagger lines will be reduced if they exceed this value.
Range: In Pixels
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.
Range: 'AUTO', 'WRAP', 'STAGGER', 'ROTATE', 'NONE'
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.
Range: 0/1
This attribute lets you set whether the data labels would show up as rotated labels on the chart.
Range: 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.
Range: 0/1
By default, all the labels are displayed on the chart. However, if you have a set of streaming data (like name of months or days of week), you can opt to show every n-th label for better clarity. This attribute just lets you do so. It allows to display every n(th) x-axis label.
Range: 1 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.
Range: 2 or above
Sets the configuration whether data values would be displayed along with the data plot on chart.
Range: 0/1
If you have opted to show data values, you can rotate them using this attribute.
Range: 0/1
If you have opted to show data values, you can show them inside the columns using this attribute. By default, the data values show outside the column.
Range: 0/1
Whether to show chart limit values. If not specified showYAxisValues
overrides this attribute.
Range: 0/1
Whether to show div line values. If not specified showYAxisValues
overrides this attribute.
Range: 0/1
Whether to show column shadows.
Range: 0/1
PowerCharts XT 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.
Range: 0/1
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.
Sets whether the clickURL
attribute (that sets a link to which the user is directed when the chart is clicked) overrides the link
attribute (that sets a link to which the user is directed when a data plot is clicked).
Default value: 0 (clickURL
does not override link
)
Range: 0/1
Maximum allowed column width
Range: In Pixels
Allows you to show or hide the value of the zero plane.
Range: 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.
Range: 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'
.
Range: 0/1
This attribute lets you set whether the y-axis lower limit would be 0 (in case of all positive values on chart) or should the y-axis lower limit adapt itself to a different figure based on values provided to the chart.
Range: 0/1
Whether to add a summation column as the last column in chart.
Range: 0/1
If you have opted to add a summation column as the last column of chart, this attribute lets you set the label for the same.
Range:
This attribute allows you to skip a null value and draw a line connecting the icons of multiple set of data. This is applicable for the mean icon and all the other deviation icons.
Range: 0/1
This attribute, when set to 1, indicates to the chart that the text (rendered on the chart) may contain RTL characters and the textual display has to be managed accordingly.
This attribute changes the theme of the chart. There are 4 types of themes which have been made according to the different color combinations.
Range: ‘carbon’, ‘fusion’, ‘ocean’, ‘zune’
Chart Message-related Attributes
These attributes let you set and configure custom chart messages, using text as well as images. These attributes are supported in FusionCharts constructor (FusionCharts({ })
).
This attribute allows to set a custom font for all chart messages.
This attribute allows to set a custom font size for all chart messages.
Range: In pixels
This attribute allows to set a custom font color for all chart messages.
Range: Hex Color Code
This attribute allows to set a custom horizontal alignment for all images displayed as chart messages.
Default value: middle
Range: left, middle, right
This attribute allows to set a custom vertical alignment for all images displayed as chart messages.
Default value: middle
Range: top, middle, bottom
This attribute allows to set a transparency for all images displayed as chart messages.
Default value: 100
Range: 0 - 100
This attribute allows to set a scale for magnifying all images displayed as chart messages.
Default value: 100
Range: 0-300
This attribute allows to set the message to be displayed when a chart begins to load. To display an image as the chart message, prefix I- to the image URL.
This attribute allows to set the font for the message displayed when a chart begins to load.
Range: Font Name
This attribute allows to set the font size for the message displayed when a chart begins to load.
Range: In pixels
This attribute allows to set the font color for the message displayed when a chart begins to load.
Range: Hex Color Code
If an image is displayed as the chart loadMessage
, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the baseChartMessageImageHAlign
attribute
Range: left, middle, right
If an image is displayed as the chart loadMessage
, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the baseChartMessageImageVAlign
attribute
Range: top, middle, bottom
If an image is displayed as the chart loadMessage
, this attribute allows to set the transparency of the image.
Default value: 100
Range: 0 - 100
If an image is displayed as the chart loadMessage
, this attribute allows to set the scale for magnifying the image.
Default value: 100
Range: 0-300
This attribute allows to set the message to be displayed when the specified chart type is not supported. To display an image as the chart message, prefix I- to the image URL.
This attribute allows to set the font for the message displayed when the specified chart type is not supported.
Range: Font Name
This attribute allows to set the font size for the message displayed when the specified chart type is not supported.
Range: In pixels
This attribute allows to set the font color for the message displayed when the specified chart type is not supported.
Range: Hex Color Code
If an image is displayed as the chart typeNotSupportedMessage
, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the baseChartMessageImageHAlign
attribute
Range: left, middle, right
If an image is displayed as the chart typeNotSupportedMessage
, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the baseChartMessageImageVAlign
attribute
Range: top, middle, bottom
If an image is displayed as the chart typeNotSupportedMessage
, this attribute allows to set the transparency of the image.
Default value: 100
Range: 0 - 100
If an image is displayed as the chart typeNotSupportedMessage
, this attribute allows to set the scale for magnifying the image.
Default value: 100
Range: 0-300
This attribute allows to set the message to be displayed if an error is encountered while rendering the chart. To display an image as the chart message, prefix I- to the image URL.
This attribute allows to set a font for the message displayed if an error is encountered while rendering the chart.
Range: Font Name
This attribute allows to set the font size for the message displayed if an error is encountered while rendering the chart.
Range: In pixels
This attribute allows to set the font color for the message displayed if an error is encountered while rendering the chart.
Range: Hex Color Code
If an image is displayed as the chart renderErrorMessage
, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the baseChartMessageImageHAlign
attribute
Range: left, middle, right
If an image is displayed as the chart renderErrorMessage
, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the baseChartMessageImageVAlign
attribute
Range: top, middle, bottom
If an image is displayed as the chart renderErrorMessage
, this attribute allows to set the transparency of the image.
Default value: 100
Range: 0 - 100
If an image is displayed as the chart renderErrorMessage
, this attribute allows to set the scale for magnifying the image.
Default value: 100
Range: 0-300
This attribute allows to set the message to be displayed when chart data begins loading. To display an image as the chart message, prefix I- to the image URL.
This attribute allows to set a font for the message displayed when chart data begins loading.
Range: Font Name
This attribute allows to set the font size for the message displayed when chart data begins loading.
Range: In pixels
This attribute allows to set the font color for the message displayed when chart data begins loading.
Range: Hex Color Code
If an image is displayed as the chart dataLoadStartMessage
, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the baseChartMessageImageHAlign
attribute
Range: left, middle, right
If an image is displayed as the chart dataLoadStartMessage
, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the baseChartMessageImageVAlign
attribute
Range: top, middle, bottom
If an image is displayed as the chart dataLoadStartMessage
, this attribute allows to set the transparency of the image.
Default value: 100
Range: 0 - 100
If an image is displayed as the chart dataLoadStartMessage
, this attribute allows to set the scale for magnifying the image.
Default value: 100
Range: 0-300
This attribute allows to set the message to be displayed if the data loaded for a chart is empty. To display an image as the chart message, prefix I- to the image URL.
This attribute allows to set the font for the message displayed if the data loaded for a chart is empty
Range: Font Name
This attribute allows to set the font size for the message displayed if the data loaded for a chart is empty.
Range: In pixels
This attribute allows to set the font color for the message displayed if the data loaded for a chart is empty.
Range: Hex Color Code
If an image is displayed as the chart dataEmptyMessage
, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the baseChartMessageImageHAlign
attribute
Range: left, middle, right
If an image is displayed as the chart dataEmptyMessage
, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the baseChartMessageImageVAlign
attribute
Range: top, middle, bottom
If an image is displayed as the chart dataEmptyMessage
, this attribute allows to set the transparency of the image.
Default value: 100
Range: 0 - 100
If an image is displayed as the chart dataEmptyMessage
, this attribute allows to set the scale for magnifying the image.
Default value: 100
Range: 0-300
This attribute allows to set the message to be displayed if an error is encountered while loading chart data. To display an image as the chart message, prefix I- to the image URL.
This attribute allows to set a font for the message displayed if an error is encountered while loading chart data.
Range: Font Name
This attribute allows to set the font size for the message displayed if an error is encountered while loading chart data.
Range: In pixels
This attribute allows to set the font color for the message displayed if an error is encountered while loading chart data.
Range: Hex Color Code
If an image is displayed as the chart dataLoadErrorMessage
, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the baseChartMessageImageHAlign
attribute
Range: left, middle, right
If an image is displayed as the chart dataLoadErrorMessage
, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the baseChartMessageImageVAlign
attribute
Range: top, middle, bottom
If an image is displayed as the chart dataLoadErrorMessage
, this attribute allows to set the transparency of the image.
Default value: 100
Range: 0 - 100
If an image is displayed as the chart dataLoadErrorMessage
, this attribute allows to set the scale for magnifying the image.
Default value: 100
Range: 0-300
This attribute allows to set the message to be displayed if the data to be loaded for the chart is invalid. To display an image as the chart message, prefix I- to the image URL.
This attribute allows to set the font for the message displayed if the specified chart data is invalid.
Range: Font Name
This attribute allows to set the font size for the message displayed if the specified chart data is invalid.
Range: In pixels
This attribute allows to set the font color for the message displayed if the specified chart data is invalid.
Range: Hex Color Code
If an image is displayed as the chart dataInvalidMessage
, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the baseChartMessageImageHAlign
attribute
Range: left, middle, right
If an image is displayed as the chart dataInvalidMessage
, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the baseChartMessageImageVAlign
attribute
Range: top, middle, bottom
If an image is displayed as the chart dataInvalidMessage
, this attribute allows to set the transparency of the image.
Default value: 100
Range: 0 - 100
If an image is displayed as the chart dataInvalidMessage
, this attribute allows to set the scale for magnifying the image.
Default value: 100
Range: 0-300
Chart Titles and Axis Names
Using these attributes, you can set the various headings and titles of chart like caption, sub-caption, x-axis and y-axis names etc.
Y-axis title of the chart.
Sub-caption of the chart.
X-axis title of the chart.
Caption of the chart.
Chart Caption Cosmetics
These attributes let you configure the cosmetics of chart caption and sub-caption.
Sets horizontal alignment of caption
Range: "left", "center", "right"
Whether caption should be on top of the data plot area
Range: 0/1
Sets the caption font size in pixels
Range: 6 - 72
Sets the sub-caption font size (in pixels)
Range: 6 - 72
Sets the caption font family
Range: Font Name
Sets the sub-caption font family
Range: Font Name
Sets the caption font color
Range: Hex Color Code
Sets the sub-caption font color
Range: Hex Color Code
Whether the caption font should be displayed in bold
Range: 0/1
Whether the sub caption font should be displayed in bold
Range: 0/1
Whether the caption is aligned with the canvas. Else, it will be aligned with the entire chart area
Range: 0/1
If caption is not centre aligned, lets you configure the padding (in pixels) from either edge. Will be ignored if caption is centre aligned.
Range: In Pixels
Chart Axis Configuration Attributes
Using these attributes, you can set and configure x-axis labels, y-axis values and set chart cosmetics for the axis like color, alpha, etc.
This attribute if set to _0_, hides the x-axis of the chart.
Default value: 1
Range: 0/1
Sets color of the x-axis of the chart.
Range: Hex Color Code
Sets the thickness of the x-axis line of the chart.
Range: In Pixels
The y-axis of the charts is divided into vertical sections using div (divisional) lines. Each div line assumes a value based on its position. Using this attribute you can set whether to show those div line (y-axis) values or not. The values of showLimits
and showDivLineValues
, if specified explicitly, overrides the value of this attribute.
Range: 0/1
By default, all div lines show their values. However, you can opt to display every x(th) div line value using this attribute.
Range: 1 or above
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.
Range: 0/1
If you opt to not rotate y-axis name, you can choose a maximum width that will be applied to y-axis name.
Range: (In Pixels)
This attribute helps you explicitly set the lower limit of the chart. If you don't specify this value, it is automatically calculated by the chart based on the data provided by you.
Range: Numeric Value
This attribute helps you explicitly set the upper limit of the chart. If you don't specify this value, it is automatically calculated by the chart based on the data provided by you.
Range: Numeric Value
If you have opted to not adjust div lines, you can specify the div line values decimal precision using this attribute.
Range: 0-10
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.
Range: 0/1
x-Axis Name Cosmetics
To configure the font cosmetics of x-axis name (title), you can use the following attributes.
Sets the x-axis font family for the text
Range: Font Name
Sets the x-axis font color
Range: Hex Color Code
Specifies the x-axis font size
Range: 6 - 72
Whether x-axis font should be bold
Range: 0/1
Whether x-axis font should be italicized
Range: 0/1
Sets the background color for x-axis text
Range: Hex Color Code
Sets the border around the x-axis text
Range: Hex Color Code
Sets the x-axis alpha including font and background
Range: 0 - 100
Sets the x-axis font alpha
Range: 0 - 100
Sets the x-axis background alpha
Range: 0 - 100
Sets the x-axis border alpha
Range: 0 - 100
Sets the x-axis border padding
Range: In Pixels
Sets the x-axis border radius
Range: In Pixels
Sets the x-axis border thickness
Range: In Pixels
Whether the border around the x-axis name should be rendered using dashed lines.
Default value: 0 (border rendered using straight lines)
Range: 0/1
Sets the length of each dash when the border around the x-axis name is rendered using dashed lines.
Range: In pixels
Sets the gap between consecutive dashes when the border around the x-axis name is rendered using dashed lines.
Range: In pixels
y-Axis Name Cosmetics
To configure the font cosmetics of y-axis name (title), you can use the following attributes.
Sets the y-axis (primary / secondary) font family for the text
Range: Font Name
Sets the y-axis (primary / secondary) font color
Range: Hex Color Code
Specifies the y-axis (primary / secondary) font size
Range: 6 - 72
Whether y-axis (primary / secondary) font should be bold
Range: 0/1
Whether y-axis (primary / secondary) font should be italicized
Range: 0/1
Sets the background color for y-axis (primary / secondary) text
Range: Hex Color Code
Sets the border around the y-axis (primary / secondary) text
Range: Hex Color Code
Sets the y-axis (primary / secondary) alpha including font and background
Range: 0 - 100
Sets the y-axis (primary / secondary) font alpha
Range: 0 - 100
Sets the y-axis (primary / secondary) background alpha
Range: 0 - 100
Sets the y-axis (primary / secondary) border alpha
Range: 0 - 100
Sets the y-axis (primary / secondary) border padding
Range: In Pixels
Sets the y-axis (primary / secondary) border radius
Range: In Pixels
Sets the y-axis (primary / secondary) border thickness
Range: In Pixels
Whether the border around the y-axis name should be rendered using dashed lines.
Default value: 0 (border rendered using straight lines)
Range: 0/1
Sets the length of each dash when the border around the y-axis name is rendered using dashed lines.
Range: In pixels
Sets the gap between two consecutive dashes when the border around the y-axis name is rendered using dashed lines.
Range: In pixels
Chart Cosmetics
The following attributes let you configure chart cosmetics like background color, background alpha, canvas color & alpha etc.
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
.
Range: Hex Color Code
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.
Range: 0 - 100
If you have opted for a gradient background, this attribute lets you set the ratio of each color constituent.
Range: 0 - 100
Angle of the background color, in case of a gradient.
Range: 0-360
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.
This attribute specifies the opacity for the loaded background image.
Range: 0 - 100
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.
Range: stretch, tile, fit, fill, center, none
Helps you to vertically align the background image.
Range: left, center, right
Helps you to horizontally align the background image.
Range: left, center, right
Helps you magnify the background image.This attribute will only work when the attribute bgImageDisplayMode
is set to none, center, or tile.
Range: 0-300
This attribute sets the background color for the chart canvas. You can set any hex color code as the value of this attribute. To specify a gradient as canvas background color, separate the hex color codes of each color in the gradient using comma. Example: #FF5904, #FFFFFF.
Range: Hex Color Code
This attribute sets the background transparency for the chart canvas. For gradient, separate the alpha value using comma. Example: 15, 50.
Range: 0 - 100
When a gradient is used to set the color of the canvas background, this attribute sets the ratio of the colors. Example : If the value of the canvasBgColor
attribute is set as #FF5904, #FFFFFF
, canvasBgRatio
can be used to specify their ratio in the background.
Range: 0 - 100
Helps you specify canvas background angle in case of gradient.
Range: 0-360
Lets you specify canvas border color.
Range: Hex Color Code
Lets you specify canvas border thickness.
Range: 0-5
Lets you control transparency of canvas border.
Range: 0 - 100
Whether to show a border around the chart or not.
Range: 0/1
Border color of the chart.
Range: Hex Color Code
Border thickness of the chart.
Range: In Pixels
Border alpha of the chart.
Range: 0 - 100
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.
Range: 0/1
This attribute lets you set whether the vline labels will show up as rotated labels on the chart.
Default value: 0
Range: 0/1
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.
Range: URL
This attribute helps you set the amount of empty space that you want to put on the left side of your logo image. Nothing is rendered in this space.
Range: In Pixels
This attribute helps you set the amount of empty space that you want to put on top of your logo image. Nothing is rendered in this space.
Range: In Pixels
Where to position the logo on the chart: TL - Top-left TR - Top-right BR - Bottom right BL - Bottom left CC - Center of screen
Range: TL, TR, BL, BR, CC
Once the logo has loaded on the chart, you can configure its opacity using this attribute.
Range: 0 - 100
You can also change the scale of an externally loaded logo at run-time by specifying a value for this parameter.
Range: 0-300
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.
Range: URL
Data Plot Cosmetics
These attributes let you configure how your plot (columns, lines, area, pie or any data that you are plotting) would appear on the chart. If the plots can show borders, you can control the border properties using the attributes listed below. Or, if they support gradient fills, you can again configure various properties of the gradient using these attributes. Various other controls over plot cosmetics can be attained using this set of attributes.
If you want all the positive columns (including in-data sum columns) on the chart to show in a single color, specify the same here.
Range: Hex Color Code
If you want all the negative columns (including in-data sum columns) on the chart to show in a single color, specify the same here.
Range: Hex Color Code
Whether the column, area, pie etc. border would show up.
Range: 0/1
Color for column, area, pie border.
Range: Hex Color Code
Thickness for column, area, pie border.
Range: 0-5
Alpha for column, area, pie border.
Range: 0 - 100
Whether the border around the data plots should be rendered using dashed lines.
Default value: 0 (border rendered using straight lines)
Range: 0/1
Sets the length of each dash when the border around the data plots are rendered using dashed lines.
Range: In pixels
Sets the gap between two consecutive dashes when the border around the data plots are rendered using dashed lines.
Range: In pixels
If you have opted to fill the plot (column, area etc.) as gradient, this attribute lets you set the fill angle for gradient.
Range: 0-360
If you have opted to fill the plot (column, area etc.) as gradient, this attribute lets you set the ratio for gradient.
Range: 0 - 100
If you have opted to fill the plot (column, area etc.) as gradient, this attribute lets you set the fill alpha for gradient.
Range: 0 - 100
You can globally add a gradient color to the entire plot of chart by specifying the second color as this attribute. For example, if you have specified individual colors for your columns and now you want a gradient that ends in white. So, specify FFFFFF (white) as this color and the chart will now draw plots as gradient.
Range: Hex Color Code
Whether to show the connector lines which connect two subsequent columns.
Range: 0/1
Color of the connector line.
Range: Hex Color Code
Alpha of the connector line.
Range: 0 - 100
Thickness of the connector line.
Range: In pixels
Whether the connector line should be rendered as dashed lines.
Default value: 0 (connector line rendered using straight lines)
Range: 0/1
Sets the length of each dash when connector line is rendered as dashed lines.
Range: In pixels
Sets the gap between consecutive dashes when connector line is rendered as dashed lines.
Range: In pixels
Gradient color is a color added globally to the entire plot of chart by specifying the second color in an attribute. This attribute sets the gradient color to true.
Default value: 1
Range: 0/1
Data Value Cosmetics
These attributes let you configure font, background and border cosmetics, of value text-field that appear for each data plot.
Sets the font of the values in the chart
Range: Font Name
Specifies the value font color
Range: Hex Color Code
Specifies the value font size
Range: 6 - 72
Whether value font should be bold
Range: 0/1
Whether value font should be italicized
Range: 0/1
Sets the background color for value text
Range: Hex Color Code
Sets the border color around the value text
Range: Hex Color Code
Sets the value alpha including font and background
Range: 0 - 100
Sets the value font alpha
Range: 0 - 100
Sets the value background alpha
Range: 0 - 100
Sets the value border alpha
Range: 0 - 100
Sets the value border thickness
Range: In Pixels
Sets the padding between the value and its surrounding border
Range: In Pixels
Sets the value border radius
Range: In Pixels
Whether the border around the data values should be rendered using dashed lines.
Default value: 0 (border rendered using straight lines)
Range: 0/1
Sets the length of each dash when the border around the data values is rendered using dashed lines.
Range: In pixels
Sets the gap between two consecutive dashes when the border around the data values is rendered using dashed lines.
Range: In pixels
Divisional Lines & Grids
Using this set of attributes, you can control the 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 plane that signifies the 0 position on the chart. If there are no negative numbers on the chart, you will not see a visible zero plane. Alternate color bands are colored blocks between two successive divisional lines.
Number of horizontal axis division lines that you want on the chart.
Range: Numeric value > 0
Color for divisional lines.
Range: Hex Color Code
Thickness of divisional lines.
Range: 1-5
Alpha of divisional lines.
Range: 0 - 100
Whether the divisional lines should be rendered as dashed lines.
Default value: 0 (divisional lines rendered using straight lines)
Range: 0/1
Sets the length of each dash when divisional lines are rendered as dashed lines.
Range: In pixels
Sets the gap between two consecutive dashes when divisional lines are rendered as dashed lines.
Range: In pixels
Color for the zero plane. Zero Plane is the line or plane that appears at position 0 on the y-axis, when negative data is being shown on the chart.
Range: Hex Color Code
Thickness of zero plane.
Range: In Pixels
Alpha of zero plane.
Range: 0 - 100
Whether to show alternate colored horizontal grid bands.
Range: 0/1
Color of the alternate horizontal grid bands.
Range: Hex Color Code
Alpha (transparency) of the alternate horizontal grid bands.
Range: 0 - 100
Number Formatting
PowerCharts XT offers you a lot of options to format your numbers on the chart. Using the attributes below, you can control a myriad of options like: Formatting of commas and decimals Number prefixes and suffixes Decimal places to which the numbers would round to Scaling of numbers based on a user defined scale Custom number input formats
This configuration determines whether the numbers displayed on the chart will be formatted using commas, for example, 40,000 if 'formatNumber': '1'; and 40000 if 'formatNumber': '0';.
Range: 0/1
Configuration whether to add K (thousands) and M (millions) to a number after truncating and rounding it - for example, if formatNumberScale
is set to 1, 10434 would become 1.04K (with decimalPrecision
set to 2 places). Same with numbers in millions - an M will be added at the end.
Range: 0/1
The default unit of the numbers that you are providing to the chart.
Unit of each block of the scale.
Range of the various blocks that constitute the scale.
Forces the specified lower numberScaleUnit
value to be applied to data values less than the specified numberScaleValue
. This attribute works only when “formatNumberScale”: “1”
and the defaultNumberScale
attribute is not defined.
For example, if “numberScaleUnit”: “K, M”
, “numberScaleValue”: “1000, 1000”
, and “forceNumberScale”: “1”
, a data value of 400 will be rendered as 0.40K.
Range: 0/1
Whether recursive scaling should be applied.
Range: 0/1
How many recursions to complete during recursive scaling? -1 completes the entire set of recursion.
What character to use to separate the scales that are generated after recursion?
Using this attribute, you could add prefix to all the numbers visible on the graph. For example, to represent all dollars figure on the chart, you could specify this attribute to $ to show like $40000, $50000.
Range: Character
Using this attribute, you could add prefix to all the numbers visible on the graph. For example, to represent all figures quantified as per annum on the chart, you could specify this attribute to '/a' to show like 40000/a, 50000/a.
Range: Character
This attribute helps you specify the character to be used as the decimal separator in a number.
Range: Character
This attribute helps you specify the character to be used as the thousands separator in a number.
Range: Character
This option helps you specify the position of the thousand separator.
Range:
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, FusionCharts 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.
Range: 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, FusionCharts 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.
Range: Character
Number of decimal places to which all numbers on the chart would be rounded to.
Range: 0-10
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).
Range: 0/1
Font Properties
Using the attributes below, you can define the generic font properties for all the text on the chart. These attributes allow you a high level control over font properties. If you intend to specify font properties for individual chart elements (like Caption, sub-caption etc.), you'll need to use the Styles feature of PowerCharts XT. Using Styles, you can also specify advanced font properties like Bold, Italics, HTML Mode etc.
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.
Range: Font Name
This attribute sets the base font color of the chart, that is, all the values and the names in the chart which lie outside the canvas will be displayed using the font color provided here.
Range: Hex Color Code
This attribute sets the base font size of the chart, that is, all the values and the names in the chart which lie on the canvas will be displayed using the font size provided here.
Range: 6 - 72
This attribute sets the base font color of the chart, that is, all the values and the names in the chart which lie on the canvas will be displayed using the font color provided here.
Range: Hex Color Code
This attribute sets the base font family of the chart text which lies outside the canvas, that is, all the values and the names in the chart which lie outside the canvas will be displayed using the font name provided here.
Range: Font Name
This attribute sets the base font size of the chart, that is, all the values and the names in the chart which lie outside the canvas will be displayed using the font size provided here.
Range: 6 - 72
Tooltip Attributes
These attributes let you control the tool tip. You can set the background color, border color, separator character and few other details.
Whether to show tool tip on chart.
Range: 0/1
Background color for tool tip.
Range: Hex Color Code
Font color for the tool-tip.
Range: Hex Color Code
Border color for tool tip.
Range: Hex Color Code
Sets the border transparency for tool tip.
Range: 0 - 100
The character specified as the value of this attribute separates the name and value displayed in tool tip.
Whether to show shadow for tool tips on the chart.
Range: 0/1
Specify custom text for the tooltip
You can either specify a constant string as the tooltip text or you can use variable values from the data level by prefixing a $ to the attribute name, for example, $name, $value.
Toolbar Attributes
Using this set of attributes, you can customize the toolbar on the chart. The advantage of having a toolbar is that it manages all the UI action elements (context menus, checkboxes, buttons) centrally. This provides a clean, uniform look and a better, more meaningful and logical grouping.
Where to position the toolbar on the chart: TL - Top-left TR - Top-right BR - Bottom right BL - Bottom left CC - Center of screen
Range: TL, TR, BL, BR, CC
Sets the toolbox position on the chart with respect to x-axis.
Sets the toolbox position on the chart with respect to y-axis.
Sets the horizontal alignment of the toolbar on the chart.
Range: Left, Right
Sets the vertical alignment of the toolbar on the chart
Range: Top, Bottom
Sets the color of the toolbar buttons.
Range: Any (color code without the # prefix)
Enables/disables display of tooltips for toolbar buttons.
Range: 0/1
You can change the scale of the toolbar by specifying a value for this attribute.
Attributes for Exporting Charts
These attributes allow you to control the saving of chart as image, SVG or XLS.
Whether the chart will allow exporting to images, PDFs, SVG or XLS.
Default value: 0
Range: 0/1
In case of server-side exporting, the action specifies whether the exported image will be sent back to client as download, or whether it'll be saved on the server.
Default value: download
Range: 'save' or 'download'
In case of server side exporting, this refers to the path of the server-side export handler (the ready-to-use scripts that we provide).
Lets you configure what output formats to allow for export of chart, in the export context menu, and also customize the label for each menu item. The attribute value should be a pipe (|) delimited separated key-value pair. Example: exportFormats: 'PNG=Export as High Quality Image|JPG|PDF=Export as PDF File'
This attributes sets the modes of export. To enable client-side exporting, set this attribute to client.
Default value: auto.
Note: Starting v3.12.1, the exportMode
attribute replaces the exportAtClientSide
attribute. However, you don’t need to make any changes to the existing setup because, the FusionCharts library comes with the proper mapping already provided.
Whether the menu items related to export (e.g., Save as JPEG etc.) will appear in the context menu of chart.
Range: 0/1
In case of server-side exporting and when using download as action, this lefts you configure whether the return image, PDF, SVG or XLS will open in same window (as an attachment for download), or whether it will open in a new window.
Default value: _self
Range: '_self' or '_blank'
Using this attribute you can specify the name (excluding the extension) of the output (export) file.
Data Plot Hover Effects
If you wish to show an effect on the data plot (column, line anchor, pie etc.) when the user hovers his mouse over the data plot, these attributes let you configure the cosmetics of the hover for all data plots in the chart.
Whether to enable hover effect on charts for all elements
Range: 0/1
Whether to enable hover effect on charts for data plots (e.g., column, pie) only
Range: 0/1
Specifies the hover color for the data plots
Range: Hex Color Code
Specifies the hover alpha for data plots
Range: 1 - 100
Sets color for the positive value plots when hovered.
Range: Hex color code
Sets color for the negative value plots when hovered.
Range: Hex color code
Specifies the gradient color for the data plots when hovered. For example, if you've specified individual colors and now you want hover color that ends in white, You need to specify it.
Range: Hex Color Code
Helps you specify the ratio of gradient colors when hovered.
This attribute specifies the angle of the gradient color when hovered.
Sets the color of the border of plot when hovered.
Range: Hex Color Code
Sets the thickness of the border of plot when hovered.
Range: In Pixels
When a data plot is hovered, this attribute is used to specify whether the data plot border will be rendered as a dashed line.
Default value: 0 (border rendered using straight lines)
Range: 0/1
When a data plot is hovered, this attribute is used to set the length of each dash if the border around the data plots are rendered using dashed lines.
Range: In pixels
When a data plot is hovered, this attribute is used to set the gap between consecutive dashes if the border around the data plots are rendered using dashed lines.
Range: In pixels
Data Label Cosmetics
These attributes let you configure the cosmetics of all data labels of the chart.
Sets the x-axis label font family for the text.
Range: Font Name
Sets the x-axis label font color.
Range: Hex Color Code
Specifies the x-axis label font size.
Range: 6 - 72
Flag indicating whether x-axis label font should be bold or not.
Range: 0/1
Flag indicating whether x-axis label font should be italicized or not.
Range: 0/1
Sets the background color for x-axis label text.
Range: Hex Color Code
Sets the color of the border around the x-axis label text.
Range: Hex Color Code
Sets the x-axis label alpha for both font and background.
Range: 0 - 100
Sets the x-axis label background alpha.
Range: 0 - 100
Sets the x-axis label border alpha.
Range: 0 - 100
Sets the x-axis label border padding.
Range: In Pixels
Sets the x-axis label border radius.
Range: In Pixels
Sets the x-axis label border thickness.
Range: In Pixels
Whether the border around x-axis labels should be rendered using dashed lines.
Default value: 0 (border rendered using straight lines)
Range: 0/1
Sets the length of each dash when the border around the x-axis labels are rendered using dashed lines.
Range: In pixels
Sets the gap between two consecutive dashes when the border around x-axis labels are rendered using dashed lines.
Range: In pixels
Sets a link for all x-axis labels.
Chart Padding & Margins
The following attributes help you control chart margins and paddings. FusionCharts Suite XT allows you manually customize the padding of various elements on the chart to allow advanced manipulation and control over chart visualization. Padding in FusionCharts Suite XT is always defined in pixels, until the attribute itself suggests some other scale (like plotSpacePercent
, which configures the spacing using percentage values). 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 Suite XT would not plot anything in that space. It is not necessary for you to specify any padding or margin values. FusionCharts Suite XT automatically assumes the best values for the same, if you do not specify the same.
Amount of empty space that you want to put at the bottom of your chart. Nothing is rendered in this space.
Range: In Pixels
Amount of empty space that you want to put on the right side of your chart. Nothing is rendered in this space.
Range: In Pixels
Amount of empty space that you want to put on the top of your chart. Nothing is rendered in this space.
Range: 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.
Range: In Pixels
Using this, you can set the distance between the top end of x-axis title and the bottom end of data labels (or canvas, if data labels are not to be shown).
Range: 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).
Range: In Pixels
This attribute helps you set the horizontal space between the canvas left edge and the y-axis values or trend line values (on left or right side). This is particularly useful, when you want more space between your canvas and y-axis values.
Range: 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.
Range: In Pixels
It sets the vertical space between the end of columns and start of value textboxes. This basically helps you control the space you want between your columns or anchors and the value textboxes.
Range: In Pixels
On a column chart, there is spacing defined between two columns. By default, the spacing is set to 20% of canvas width. If you intend to increase or decrease the spacing between columns, you can do so using this attribute. For example, if you wanted all columns to stick to each other without any space in between, you can set plotSpacePercent
to 0. Similarly, if you want very thin columns, you can set plotSpacePercent
to its max value of 80.
Range: 0-80 (In Percent)
Amount of empty space that you want to put on the left side of your chart. Nothing is rendered in this space.
Range: In Pixels
This attribute lets you control the space between the start of chart canvas and the start (x) of chart. In case of 2D charts, the canvas is the visible rectangular box. Using this attribute, you can control the amount of empty space between the chart left side and canvas left side. By default, PowerCharts XT automatically calculates this space depending on the elements to be placed on the chart. However, if you want to over-ride this value with a higher value, you can use this attribute to specify the same. Please note that you cannot specify a margin lower than what has been calculated by the chart. This attribute is particularly useful, when you have multiple charts placed in a page and want all their canvas start position to align with each other - so in such a case, you can set same margin value (a value large enough that it does not get rejected by chart owing to it being lower than the calculated value) for all such charts in the page.
Range: In Pixels
Like canvasLeftMargin
, this attribute lets you set the space between end of canvas and end of chart.
Range: In Pixels
Like canvasLeftMargin
, this attribute lets you set the space between top of canvas and top of chart.
Range: In Pixels
Like canvasLeftMargin
, this attribute lets you set the space between bottom of canvas and bottom of chart.
Range: In Pixels
The data Object
In single-series charts, each instance of the data
object represents a data value to be plotted on the chart. For a single-series chart, one instance of the data
object looks as shown in the example below:
"data"[{
"label": "Jan",
"value": "10000"
}]
Attributes of the data
object are used to set and configure the data values for the chart.
Whether the set value should represent the sum of previous set values in the water fall chart. You can put a sum column at any position in the chart (barring the first position, as you need at least one data point to calculate sum).
Range: 0/1
Whether the sum represents the cumulative sum (of all the columns to the left of this sum column) or non-cumulative sum (of all the columns to the left of this column, but after the last sum column).
Range: 0/1
This attribute determines the label for the data item. The label appears on the x-axis of chart.
Note: The label
attribute replaces the name
attribute. Previously, either one of the attributes could be used to set the label. Support for the name
attribute has been discontinued since v3.10.0.
Numerical value for the data item. This value would be plotted on the chart.
If instead of the numerical value of this data, you wish to display a custom string value, you can specify the same here. Examples are annotation for a data item etc.
Range:
If you want to define your own colors for the data items on chart, use this attribute to specify color for the data item.
Range: Hex Color Code
If you have opted to show individual columns as gradients, this attribute lets you control the ratio of each color. Please see Advanced Charting > Using Gradients to get more information.
Range: Comma separated list of ratios
You can define links for individual data items. That enables the end user to click on data items (columns, lines, bars etc.) and drill down to other pages. To define the link for data items, use the link attribute. You can define links that open in same window, new window, pop-up window or frames. Please see "Drill-Down > Using JavaScript Functions as Links" for more information. Also, you'll need to Url Encode all the special characters (like ? and &) present in the link.
By default, PowerCharts XT shows the data item 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.
You can individually opt to show or hide labels of individual data items using this attribute.
Range: 0/1
You can individually opt to show or hide values of individual data items using this attribute.
Range: 0/1
Whether the border of this data item should appear as dashed. This is particularly useful when you want to highlight a data (such as forecast or trend etc.).
Range: 0/1
This attribute determines the transparency of a data item. The range for this attribute is 0 to 100. 0 means complete transparency (the data item will not be shown on the graph) and 100 means opaque.
Range: 0 - 100
Sets the x-axis label font family for the text.
Range: Font Name
Sets the x-axis label font color.
Range: Hex Color Code
Specifies the x-axis label font size.
Range: 6 - 72
Flag indicating whether x-axis label font should be bold or not.
Range: 0/1
Flag indicating whether x-axis label font should be italicized or not.
Range: 0/1
Sets the background color for x-axis label text.
Range: Hex Color Code
Sets the color of the border around the x-axis label text.
Range: Hex Color Code
Sets the x-axis label alpha for both font and background.
Range: 0 - 100
Sets the x-axis label background alpha.
Range: 0 - 100
Sets the x-axis label border alpha.
Range: 0 - 100
Sets the x-axis label border padding.
Range: In Pixels
Sets the x-axis label border radius.
Range: In Pixels
Sets the x-axis label border thickness.
Range: In Pixels
Whether the border around x-axis labels should be rendered using dashed lines.
Default value: 0 (border rendered using straight lines)
Range: 0/1
Sets the length of each dash when the border around the x-axis label is rendered using dashed lines.
Range: In pixels
Sets the gap between two consecutive dashes when the border around x-axis label is rendered using dashed lines.
Range: In pixels
Sets the link for each individual x-axis label.
This attribute can set the hover color for a particular data plot.
Range: Hex Color Code
This attribute sets the transparency for a particular data plot when hovered.
Range: 0 - 100
This attribute sets the gradient color of the data plot on hover.
Range: Hex Color Code
This attribute sets the ratio of gradient colors when hovered.
Range: 0 - 100
This attribute specifies the angle of the gradient color when hovered.
Range: 0 - 360
This attribute sets the border color of the data plot on hover.
Range: Hex Color Code
This attribute sets the border's transparency for the data plot on hover.
Range: 0 - 100
This attribute sets the thickness for the data plot's border on hover.
Range: In pixels
When a data plot is hovered, this attribute is used to specify whether a data plot border will be rendered as a dashed line.
Default value: 0 (border rendered using straight lines)
Range: 0/1
When a data plot is hovered, this attribute is used to set the length of each dash if the border around a data plot is rendered using dashed lines.
Range: In pixels
When a data plot is hovered, this attribute is used to set the gap between consecutive dashes if the border around a data plot is rendered using dashed lines.
Range: In pixels
This attribute sets the positive value plot color on hover.
Range: Hex Color Code
This attribute sets the negative value plot color on hover.
Range: Hex Color Code
Vertical Data Separator Lines
Vertical data separator lines help you separate data blocks. These lines run through the height of the chart, thereby segregating the data into two different blocks. Vertical lines are defined as shown in the example below:
"data": [{
"label": "Grade 1",
},
{
"vLine": "true",
"label": "Appraisal"
}]
}]
You can configure the cosmetics of vertical separator lines using the following attributes:
Set this attribute to true to render a vertical data separator line.
This attribute defines the color of vertical separator line
Range: Hex Color Code
Thickness in pixels of the vertical separator line.
Range: In Pixels
Alpha of the vertical separator line.
Range: 0 - 100
Whether the vertical separator line should be rendered as dashed lines.
Default value: 0 (vertical separator line rendered using straight lines)
Range: 0/1
Sets the width of each dash when vertical separator line is rendered as dashed lines.
Range: In pixels
Sets the gap between consecutive dashes when vertical separator line is rendered as dashed lines.
Range: In pixels
Label for the vertical separator line, if to be shown.
Note: The label
attribute replaces the name
attribute. Previously, either one of the attributes could be used to set the label. Support for the name
attribute has been discontinued since v3.10.0.
Range:
Whether to show a border around the vLine label.
Range: 0/1
Helps configure the position of vertical line, that is, if a vLine is to be plotted between 2 points Jan and Feb, user can set any position between 0 and 1 to indicate the relative position of vLine between these two points (0 means Jan and 1 means Feb). By default, it is 0.5 to show in between the points.
Range: 0-1
Helps configure the position of the vLine label by setting a relative position between 0 and 1. In vertical charts, 0 means top of canvas and 1 means bottom. In horizontal charts, 0 means left of canvas and 1 means right.
Range: 0-1
Horizontal anchor point for the alignment of vLine label.
Range: left, center, right
Vertical anchor point for the alignment of vLine label.
Range: top, middle, bottom
Trend-lines
Trend-lines are horizontal lines that aid in interpretation of data with respect to some pre-determined value. For example, if you are plotting the sales data for the current year, you might want to show the previous year's average monthly sales as a trend indicator for ease of comparison. The lines
object, child of the trendlines
object is used to add trend-lines to a chart.
Although the line
object has to be defined within the trendlines
object, the latter cannot be used to collectively customize trend-lines, because it does not have any attributes of its own.
The attributes of the lines
object, child of the trendlines
object, are used to create and customize trend-lines for charts.
The starting value for the trendline. Say, if you want to plot a slanted trend line from value 102 to 109, the startValue
would be 102.
Range: Numeric Value
The ending y-axis value for the trend line. 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
.
Range: Numeric Value
If you want to display a string caption for the trend line by its side, you can use this attribute. Example: displayValue='Last Month High'
When you do not supply this attribute, it automatically takes the value of startValue
.
Color of the trend line and its associated text
Range: Hex Color Code
Whether the trend will be displayed as a line or a zone (fill-colored rectangle).
Range: 0/1
Whether the trend line or zone would be displayed over data plots or behind them.
Range: 0/1
If you have opted to show the trend as a line, this attribute lets you define the thickness of trend line.
Range: In Pixels
Alpha of the trend line.
Range: 0 - 100
Whether the trendline should be rendered as dashed lines.
Default value: 0 (trendline rendered using straight lines)
Range: 0/1
Sets the length of each dash when trendline is rendered as dashed lines.
Range: In pixels
Sets the gap between consecutive dashes when trendline is rendered as dashed lines.
Range: In pixels
Whether to show the trend line value on left side or right side of chart. This is particularly useful when the trend line display values on the chart are colliding with divisional lines values on the chart.
Range: 0/1
Custom tool-text for this trend line or zone.
Range:
Trend-lines (Chart level attributes)
Trend-lines are horizontal lines that aid in interpretation of data with respect to some pre-determined value. For example, if you are plotting the sales data for the current year, you might want to show the previous year's average monthly sales as a trend indicator for ease of comparison. Cosmetics for all the trend-lines rendered can be attained using this set of attributes.
Although there are set of attributes of the line object
, used to create and customize trend-lines, these set of attributes effect all the trend-lines rendered in your chart.
Sets color of all the trend lines and its associated text in the chart.
Range: Hex Color Code
If you've opted to show the trend as a line, this attribute lets you define the thickness of all the trend lines in your chart.
Range: In Pixels
Sets transparency for all the trend lines in your charts.
Range: 0 - 100
Sets the tooltip text of the trend-line. It accepts macros, plain text, and HTML tags, as string.
Whether all the trend line/zone will be displayed over data plots or under them.
Range: 0/1
Trend-lines Display Value Cosmetics
These attributes let you customize the text displayed with a trend-line.
Note: These attributes belong to the chart
object and not to the line
object (child of the trendline
object). They are, therefore, applied to all trend-lines on your chart.
Sets the font family for the trend-line display value.
Range: Font Name
Sets the font size for the trend-line display value.
Range:
Sets whether the trend-line display value will be bold formatted.
Default value: 0 (not bold formatted)
Range: 0/1
Sets whether the trend-line display value will be italicized.
Default value: 0 (not italicized)
Range: 0/1
Sets the background color for the trend-line display value.
Range: Hex Color Code
Sets the border color for the trend-line display value.
Range: Hex Color Code
Sets the transparency for the trend-line display value.
Default value: 100
Range: 0 - 100
Sets the transparency for the background of the trend-line display value.
Default value: 100
Range: 0 - 100
Sets the transparency for the border around the trend-line display value.
Default value: 100
Range: 0 - 100
Sets padding for the border around the trend-line display value.
Range: In pixels
Sets the radius for the border around the trend-line display value.
Range: In pixels
Sets the thickness for the border around the trend-line display value.
Range: In pixels
Whether the border around the trend-line display value should be rendered as dashed lines.
Default value: 0 (border rendered using straight lines)
Range: 0/1
Sets the length of each dash when the border around the trend-line display value is rendered as dashed lines.
Range: In pixels
Sets the gap between two consecutive dashes when the border around the trend-line display value is rendered as dashed lines.
Range: In pixels