- Back to Docs
- Get Started
- Integrations
- Configuring your Charts
- List of Charts
- Chart Attributes
- API
- Options & Properties
- Methods
- Events
- Other References
- Concepts
- Browser and Technology Support
- Change Log
- License Activation
Bubble 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. You can also set chart limits and extended properties.
animation
This attribute gives you the option to control animation in your charts. If you do not want to animate any part of the chart, set this as 0.
Type: Boolean
Range: 0/1
animationDuration
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
Type: Number
Range: In seconds
palette
Froala Charts offers the concept of Color Palettes. Each chart has 5 pre-defined color palettes which you can choose from. Each palette renders the chart in a different color theme.
Type: Number
Range: 1-5
paletteColors
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 JSON.
Type: String
Range: List of hex color codes separated by comma
negativeColor
You can opt to color all bubbles with a negative Z value on the chart with a single color, which can be specified for this attribute.
Type: Color
Range: Hex Color Code
showLabels
It sets the configuration whether the x-axis labels will be displayed or not.
Type: Boolean
Range: 0/1
maxLabelHeight
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.
Type: Number
Range: In Pixels
labelDisplay
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.
Type: String
Range: 'AUTO', 'WRAP', 'STAGGER', 'ROTATE', 'NONE'
useEllipsesWhenOverflow
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.
Type: Boolean
Range: 0/1
rotateLabels
This attribute lets you set whether the data labels will show up as rotated labels on the chart.
Type: Boolean
Range: 0/1
slantLabels
If you've opted to show rotated labels on chart, this attribute lets you set the configuration whether the labels will show as slanted labels or fully vertical ones.
Type: Boolean
Range: 0/1
labelStep
By default, all the labels are displayed on the chart. However, if you've a set of streaming data (like name
of months or days of week), you can opt to show every n-th label for better clarity. This attribute just
lets you do so. When a value greater than 1 (n) is set to this attribute, the first label from left and
every label at the n-th position from left will be displayed. e.g., a chart showing data for 12 months and
set with labelStep: 3
will show labels for January, April, July, and October. The rest of the
labels will be skipped.
Type: Number
Range: 1 or above
staggerLines
If you've opted for STAGGER mode as labelDisplay
, using this attribute you can control how many
lines to stagger the label to. By default, all labels are displayed in a single line.
Type: Number
Range: 2 or above
showValues
Sets the configuration whether data values will be displayed along with the data plot on chart.
Type: Boolean
Range: 0/1
showLimits
Whether to show chart limit values. If not specified showYAxisValues
attribute overrides this
value.
Type: Boolean
Range: 0/1
showVLimits
Whether to show chart limit values of the x-axis. If not specified showXAxisValues
attribute
overrides this value.
Type: Boolean
Range: 0/1
showDivLineValues
Whether to show div line values. If not specified showYAxisValues
attribute over-rides this
value.
Type: Boolean
Range: 0/1
showVDivLineValues
Whether to show vertical div line values. If not specified showXAxisValues
attribute over-rides
this value.
Type: Boolean
Range: 0/1
use3DLighting
Whether to use 3D Bubbles or 2D Bubbles.
Type: Boolean
Range: 0/1
bubbleScale
If you want to proportionately increase/decrease size of all the bubbles on the chart, you can use this attribute. A value of less than 1 (but greater than 0) will decrease all the bubble sizes and vice versa.
Type: Number
Range: 0-2
adjustDiv
Froala Charts 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 will disable automatic adjustment of divisional lines.
Type: Boolean
Range: 0/1
adjustVDiv
Froala Charts automatically tries to adjust divisional lines and limit values of the x-axis based on the data provided. However, if you want to set your explicit lower and upper limit values and number of divisional lines for the x-axis, first set this attribute to false. That will disable automatic adjustment of divisional lines.
Type: Boolean
Range: 0/1
clickURL
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 Froala Charts Link format.
Type: String
Range:
clickURLOverridesPlotLinks
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
)
Type: Boolean
Range: 0/1
setAdaptiveYMin
This attribute lets you set whether the y-axis lower limit will 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.
Type: Boolean
Range: 0/1
setAdaptiveXMin
This attribute lets you set whether the x-axis lower limit will be 0 (in case of all positive values on chart) or should the x-axis lower limit adapt itself to a different figure based on values provided to the chart.
Type: Boolean
Range: 0/1
showRegressionLine
This attribute when set to '1' draws regression lines for all the datasets in the chart.
Type: Boolean
Range: 0/1
showYOnX
When it is set to '1' the regression lines are drawn using Y On X mode and when the attribute is set to '0' the regression lines are drawn using X On Y mode. By default, this attribute is set to '1'.
Type: Boolean
Range: 0/1
regressionLineColor
This attribute allows you to set the color of all the regression lines in a chart.
Type: Color
Range: Hex Color Code
regressionLineThickness
This attribute allows you to set the thickness of all the regression lines in a chart.
Type: Number
Range:
regressionLineAlpha
This attribute allows you to set the transparency of all the regression lines in a chart.
Type: Number
Range: 0 - 100
minBubbleRadius
This attribute lets you define a default minimum radius for the bubbles. This is needed to ensure that all bubbles are visible.
Type: Number
hasRTLText
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.
Type: Number
Range:
plotHighlightEffect
This attribute lets you enable/disable the highlight effect, in the form of a fadeout
, for the
data plots corresponding to a legend item. When this attribute is enabled and the mouse pointer is hovered
over a legend item label, plots belonging to the other data series fadeout, by reducing their opacity.
The fadeout effect can be customized by specifying the fadeout color and opacity using the
color
and alpha
attributes. Eg. fadeout|color=#ff0000, alpha=60
Type: String
Range:
showPrintMenuItem
Whether to show "Print Chart" item in the context menu of the chart? Even if you opt to hide the item in
context menu, you can still opt to invoke print()
JavaScript method of the chart to print the
same.
Type: Boolean
Range: 0/1
theme
This attribute changes the theme of the chart. There are 7 types of themes which have been made according to the different color combinations.
Type: String
Range: 'froala', 'candy'
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 Froala Charts constructor (FroalaCharts({ })
).
baseChartMessageFont
This attribute allows to set a custom font for all chart messages.
Type: String
Range:
baseChartMessageFontSize
This attribute allows to set a custom font size for all chart messages.
Type: Number
Range: In pixels
baseChartMessageColor
This attribute allows to set a custom font color for all chart messages.
Type: Color
Range: Hex Color Code
baseChartMessageImageHAlign
This attribute allows to set a custom horizontal alignment for all images displayed as chart messages.
Default value: middle
Type: String
Range: left, middle, right
baseChartMessageImageVAlign
This attribute allows to set a custom vertical alignment for all images displayed as chart messages.
Default value: middle
Type: String
Range: top, middle, bottom
baseChartMessageImageAlpha
This attribute allows to set a transparency for all images displayed as chart messages.
Default value: 100
Type: Number
Range: 0 - 100
baseChartMessageImageScale
This attribute allows to set a scale for magnifying all images displayed as chart messages.
Default value: 100
Type: Number
Range: 0-300
loadMessage
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.
Type: String
Range:
loadMessageFont
This attribute allows to set the font for the message displayed when a chart begins to load.
Type: String
Range: Font Name
loadMessageFontSize
This attribute allows to set the font size for the message displayed when a chart begins to load.
Type: Number
Range: In pixels
loadMessageColor
This attribute allows to set the font color for the message displayed when a chart begins to load.
Type: Color
Range: Hex Color Code
loadMessageImageHAlign
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
Type: String
Range: left, middle, right
loadMessageImageVAlign
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
Type: String
Range: top, middle, bottom
loadMessageImageAlpha
If an image is displayed as the chart loadMessage
, this attribute allows to set the transparency
of the image.
Default value: 100
Type: Number
Range: 0 - 100
loadMessageImageScale
If an image is displayed as the chart loadMessage
, this attribute allows to set the scale for
magnifying the image.
Default value: 100
Type: Number
Range: 0-300
typeNotSupportedMessage
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.
Type: String
Range:
typeNotSupportedMessageFont
This attribute allows to set the font for the message displayed when the specified chart type is not supported.
Type: String
Range: Font Name
typeNotSupportedMessageFontSize
This attribute allows to set the font size for the message displayed when the specified chart type is not supported.
Type: Number
Range: In pixels
typeNotSupportedMessageColor
This attribute allows to set the font color for the message displayed when the specified chart type is not supported.
Type: Color
Range: Hex Color Code
typeNotSupportedMessageImageHAlign
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
Type: String
Range: left, middle, right
typeNotSupportedMessageImageVAlign
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
Type: String
Range: top, middle, bottom
typeNotSupportedMessageImageAlpha
If an image is displayed as the chart typeNotSupportedMessage
, this attribute allows to set the
transparency of the image.
Default value: 100
Type: Number
Range: 0 - 100
typeNotSupportedMessageImageScale
If an image is displayed as the chart typeNotSupportedMessage
, this attribute allows to set the
scale for magnifying the image.
Default value: 100
Type: Number
Range: 0-300
renderErrorMessage
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.
Type: String
Range:
renderErrorMessageFont
This attribute allows to set a font for the message displayed if an error is encountered while rendering the chart.
Type: String
Range: Font Name
renderErrorMessageFontSize
This attribute allows to set the font size for the message displayed if an error is encountered while rendering the chart.
Type: Number
Range: In pixels
renderErrorMessageColor
This attribute allows to set the font color for the message displayed if an error is encountered while rendering the chart.
Type: Color
Range: Hex Color Code
renderErrorMessageImageHAlign
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
Type: String
Range: left, middle, right
renderErrorMessageImageVAlign
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
Type: String
Range: top, middle, bottom
renderErrorMessageImageAlpha
If an image is displayed as the chart renderErrorMessage
, this attribute allows to set the
transparency of the image.
Default value: 100
Type: Number
Range: 0 - 100
renderErrorMessageImageScale
If an image is displayed as the chart renderErrorMessage
, this attribute allows to set the scale
for magnifying the image.
Default value: 100
Type: Number
Range: 0-300
dataLoadStartMessage
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.
Type: String
Range:
dataLoadStartMessageFont
This attribute allows to set a font for the message displayed when chart data begins loading.
Type: String
Range: Font Name
dataLoadStartMessageFontSize
This attribute allows to set the font size for the message displayed when chart data begins loading.
Type: String
Range: In pixels
dataLoadStartMessageColor
This attribute allows to set the font color for the message displayed when chart data begins loading.
Type: Color
Range: Hex Color Code
dataLoadStartMessageImageHAlign
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
Type: String
Range: left, middle, right
dataLoadStartMessageImageVAlign
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
Type: String
Range: top, middle, bottom
dataLoadStartMessageImageAlpha
If an image is displayed as the chart dataLoadStartMessage
, this attribute allows to set the
transparency of the image.
Default value: 100
Type: Number
Range: 0 - 100
dataLoadStartMessageImageScale
If an image is displayed as the chart dataLoadStartMessage
, this attribute allows to set the
scale for magnifying the image.
Default value: 100
Type: Number
Range: 0-300
dataEmptyMessage
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.
Type: String
Range:
dataEmptyMessageFont
This attribute allows to set the font for the message displayed if the data loaded for a chart is empty
Type: String
Range: Font Name
dataEmptyMessageFontSize
This attribute allows to set the font size for the message displayed if the data loaded for a chart is empty.
Type: Number
Range: In pixels
dataEmptyMessageColor
This attribute allows to set the font color for the message displayed if the data loaded for a chart is empty.
Type: Color
Range: Hex Color Code
dataEmptyMessageImageHAlign
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
Type: String
Range: left, middle, right
dataEmptyMessageImageVAlign
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
Type: String
Range: top, middle, bottom
dataEmptyMessageImageAlpha
If an image is displayed as the chart dataEmptyMessage
, this attribute allows to set the
transparency of the image.
Default value: 100
Type: Number
Range: 0 - 100
dataEmptyMessageImageScale
If an image is displayed as the chart dataEmptyMessage
, this attribute allows to set the scale
for magnifying the image.
Default value: 100
Type: Number
Range: 0-300
dataLoadErrorMessage
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.
Type: String
Range:
dataLoadErrorMessageFont
This attribute allows to set a font for the message displayed if an error is encountered while loading chart data.
Type: String
Range: Font Name
dataLoadErrorMessageFontSize
This attribute allows to set the font size for the message displayed if an error is encountered while loading chart data.
Type: Number
Range: In pixels
dataLoadErrorMessageColor
This attribute allows to set the font color for the message displayed if an error is encountered while loading chart data.
Type: Color
Range: Hex Color Code
dataLoadErrorMessageImageHAlign
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
Type: String
Range: left, middle, right
dataLoadErrorMessageImageVAlign
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
Type: String
Range: top, middle, bottom
dataLoadErrorMessageImageAlpha
If an image is displayed as the chart dataLoadErrorMessage
, this attribute allows to set the
transparency of the image.
Default value: 100
Type: Number
Range: 0 - 100
dataLoadErrorMessageImageScale
If an image is displayed as the chart dataLoadErrorMessage
, this attribute allows to set the
scale for magnifying the image.
Default value: 100
Type: Number
Range: 0-300
dataInvalidMessage
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.
Type: String
Range:
dataInvalidMessageFont
This attribute allows to set the font for the message displayed if the specified chart data is invalid.
Type: String
Range: Font Name
dataInvalidMessageFontSize
This attribute allows to set the font size for the message displayed if the specified chart data is invalid.
Type: Number
Range: In pixels
dataInvalidMessageColor
This attribute allows to set the font color for the message displayed if the specified chart data is invalid.
Type: Color
Range: Hex Color Code
dataInvalidMessageImageHAlign
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
Type: String
Range: left, middle, right
dataInvalidMessageImageVAlign
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
Type: String
Range: top, middle, bottom
dataInvalidMessageImageAlpha
If an image is displayed as the chart dataInvalidMessage
, this attribute allows to set the
transparency of the image.
Default value: 100
Type: Number
Range: 0 - 100
dataInvalidMessageImageScale
If an image is displayed as the chart dataInvalidMessage
, this attribute allows to set the scale
for magnifying the image.
Default value: 100
Type: Number
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.
subCaption
Sub-caption of the chart.
Type: String
xAxisName
X-axis title of the chart.
Type: String
yAxisName
Y-axis title of the chart.
Type: String
Chart Caption Cosmetics
These attributes let you configure the cosmetics of chart caption and sub-caption.
subCaptionFontSize
Sets the sub-caption font size (in pixels)
Type: Number
Range: 6 - 72
subCaptionFont
Sets the sub-caption font family
Type: String
Range: Font Name
subCaptionFontColor
Sets the sub-caption font color
Type: Color
Range: Hex Color Code
subCaptionFontBold
Whether the sub caption font should be displayed in bold
Type: Boolean
Range: 0/1
alignCaptionWithCanvas
Whether the caption is aligned with the canvas. Else, it will be aligned with the entire chart area
Type: Boolean
Range: 0/1
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.
showxaxisline
This attribute if set to _0_, hides the x-axis of the chart.
Default value: 1
Type: Boolean
Range: 0/1
showXAxisValues
Froala Charts x-axis is divided into horizontal sections using div (divisional) lines. Each div line assumes
a value based on its position. Using this attribute you can set whether to show those div line (x-axis)
values or not. This attribute shows or hides the x-axis divisional lines and limits. When specified the
values of showVLimits
and showVDivLineValues
overrides the value of this
attribute.
Type: Boolean
Range: 0/1
xAxisPosition
This attribute sets the position of the x-axis in the chart.
Default value: Bottom
Type: String
Range: Top, Bottom
yAxisPosition
This attribute sets the position of the y-axis in the chart.
Default value: Left
Type: String
Range: Left, Right
xAxisLineColor
Sets color of the x-axis of the chart.
Type: Color
Range: Hex Color Code
xaxislinethickness
Sets the thickness of the x-axis line of the chart.
Type: Number
Range: In Pixels
xAxisLabelMode
This attribute is used to render the x-axis labels in three different modes. The modes are as following: AUTO
- Allows the x-axis labels to inherit the properties of y-axis (numeric calculations), ignoring the
properties of the categories
object if present in the data. CATEGORIES - This mode is the
default mode of xAxisLabelMode
. It allows the chart to show the properties of the
categories
object on the x-axis labels. MIXED - Allows the chart to show both the properties of
y-axis (numeric calculations) and the categories
object on the x-axis simultaneously.
Type: String
Range: AUTO CATEGORIES MIXED
xAxisValuesStep
By default, all div lines show their values. However, you can opt to display every x(th) div line value using this attribute.
Type: Number
Range: 1 or above
xAxisMinValue
The bubble/scatter chart have 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, Froala Charts will automatically calculate the best value for you.
Type: Number
Range: Numeric Value
xAxisMaxValue
The bubble/scatter chart have 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, Froala Charts will automatically calculate the best value for you.
Type: Number
Range: Numeric Value
showyaxisline
This attribute if set to _0_, hides the y-axis of the chart.
Default value: 1
Type: Boolean
Range: 0/1
showYAxisValues
Froala Charts y-axis is divided into vertical sections using div (divisional) lines. Each div line assumes a
value based on its position. Using this attribute you can set whether to show those div line (y-axis) values
or not. This attribute shows or hides the y-axis divisional lines and limits. The values of
showLimits
and showDivLineValues
, if specified explicitly, overrides the value of
this attribute.
Type: Boolean
Range: 0/1
yAxisLineColor
Sets color of the y-axis of the chart.
Type: Color
Range: Hex Color Code
yAxisLineThickness
Sets the thickness of the y-axis line of the chart.
Type: Number
Range: In Pixels
rotateYAxisName
If you do not wish to rotate y-axis name, set this as 0. It specifically comes to use when you've the special characters (UTF-8) in your y-axis name that do not show up in rotated mode.
Type: Boolean
Range: 0/1
yAxisValuesStep
By default, all div lines show their values. However, you can opt to display every x(th) div line value using this attribute.
Type: Number
Range: 1 or above
yAxisNameWidth
If you opt to not rotate y-axis name, you can choose a maximum width that will be applied to y-axis name.
Type: Number
Range: (In Pixels)
yAxisMinValue
This attribute helps you explicitly set the lower limit of the chart. If you don't specify this value, it is automatically calculated by Froala Charts based on the data provided by you.
Type: Number
Range: Numeric Value
yAxisMaxValue
This attribute helps you explicitly set the upper limit of the chart. If you don't specify this value, it is automatically calculated by Froala Charts based on the data provided by you.
Type: Number
Range: Numeric Value
forceXAxisValueDecimals
Whether to forcefully attach decimal places to all x-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 x-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 x-axis numbers, set this attribute to 1.
Type: Boolean
Range: 0/1
forceYAxisValueDecimals
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.
Type: Boolean
Range: 0/1
xAxisValueDecimals
If you've opted not to adjust vertical div lines, you can specify the decimal precision of the div line values using this attribute.
Type: Number
Range: 0-10
yAxisValueDecimals
Specifies the decimal precision of yAxis values when adjustDiv is set to 0.
Type: Number
Range: 0-10
reverseXaxis
You can reverse the x-axis by setting this attribute to 1
. The x-axis values will appear in
decreasing order from left to right.
Default value: 0
Type: Boolean
Range: 0/1
x-Axis Name Cosmetics
To configure the font cosmetics of x-axis name (title), you can use the following attributes.
xAxisNameFont
Sets the x-axis font family for the text
Type: String
Range: Font Name
xAxisNameFontColor
Sets the x-axis font color
Type: Color
Range: Hex Color Code
xAxisNameFontSize
Specifies the x-axis font size
Type: Number
Range: 6 - 72
xAxisNameFontBold
Whether x-axis font should be bold
Type: Boolean
Range: 0/1
xAxisNameFontItalic
Whether x-axis font should be italicized
Type: Boolean
Range: 0/1
xAxisNameBgColor
Sets the background color for x-axis text
Type: Color
Range: Hex Color Code
xAxisNameBorderColor
Sets the border around the x-axis text
Type: Color
Range: Hex Color Code
xAxisNameAlpha
Sets the x-axis alpha including font and background
Type: Number
Range: 0 - 100
xAxisNameFontAlpha
Sets the x-axis font alpha
Type: Number
Range: 0 - 100
xAxisNameBgAlpha
Sets the x-axis background alpha
Type: Number
Range: 0 - 100
xAxisNameBorderAlpha
Sets the x-axis border alpha
Type: Number
Range: 0 - 100
xAxisNameBorderPadding
Sets the x-axis border padding
Type: Number
Range: In Pixels
xAxisNameBorderRadius
Sets the x-axis border radius
Type: Number
Range: In Pixels
xAxisNameBorderThickness
Sets the x-axis border thickness
Type: Number
Range: In Pixels
xAxisNameBorderDashed
Whether the border around the x-axis name should be rendered using dashed lines.
Default value: 0 (border rendered using straight lines)
Type: Boolean
Range: 0/1
xAxisNameBorderDashLen
Sets the length of each dash when the border around the x-axis name is rendered using dashed lines.
Type: Number
Range: In pixels
xAxisNameBorderDashGap
Sets the gap between consecutive dashes when the border around the x-axis name is rendered using dashed lines.
Type: Number
Range: In pixels
y-Axis Name Cosmetics
To configure the font cosmetics of y-axis name (title), you can use the following attributes.
yAxisNameFont
Sets the y-axis (primary / secondary) font family for the text
Type: String
Range: Font Name
yAxisNameFontColor
Sets the y-axis (primary / secondary) font color
Type: Color
Range: Hex Color Code
yAxisNameFontSize
Specifies the y-axis (primary / secondary) font size
Type: Number
Range: 6 - 72
yAxisNameFontBold
Whether y-axis (primary / secondary) font should be bold
Type: Boolean
Range: 0/1
yAxisNameFontItalic
Whether y-axis (primary / secondary) font should be italicized
Type: Boolean
Range: 0/1
yAxisNameBgColor
Sets the background color for y-axis (primary / secondary) text
Type: Color
Range: Hex Color Code
yAxisNameBorderColor
Sets the border around the y-axis (primary / secondary) text
Type: Color
Range: Hex Color Code
yAxisNameAlpha
Sets the y-axis (primary / secondary) alpha including font and background
Type: Number
Range: 0 - 100
yAxisNameFontAlpha
Sets the y-axis (primary / secondary) font alpha
Type: Number
Range: 0 - 100
yAxisNameBgAlpha
Sets the y-axis (primary / secondary) background alpha
Type: Number
Range: 0 - 100
yAxisNameBorderAlpha
Sets the y-axis (primary / secondary) border alpha
Type: Number
Range: 0 - 100
yAxisNameBorderPadding
Sets the y-axis (primary / secondary) border padding
Type: Number
Range: In Pixels
yAxisNameBorderRadius
Sets the y-axis (primary / secondary) border radius
Type: Number
Range: In Pixels
yAxisNameBorderThickness
Sets the y-axis (primary / secondary) border thickness
Type: Number
Range: In Pixels
yAxisNameBorderDashed
Whether the border around the y-axis name should be rendered using dashed lines.
Default value: 0 (border rendered using straight lines)
Type: Boolean
Range: 0/1
yAxisNameBorderDashLen
Sets the length of each dash when the border around the y-axis name is rendered using dashed lines.
Type: Number
Range: In pixels
yAxisNameBorderDashGap
Sets the gap between two consecutive dashes when the border around the y-axis name is rendered using dashed lines.
Type: Number
Range: In pixels
Chart Cosmetics
The following attributes let you configure chart cosmetics like background color, background alpha, canvas color & alpha etc.
showBorder
Whether to show a border around the chart or not.
Type: Boolean
Range: 0/1
borderColor
Border color of the chart.
Type: Color
Range: Hex Color Code
borderThickness
Border thickness of the chart.
Type: Number
Range: In Pixels
borderAlpha
Border alpha of the chart.
Type: Number
Range: 0 - 100
bgColor
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
.
Type: Color
Range: Hex Color Code
bgAlpha
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.
Type: Number
Range: 0 - 100
bgRatio
If you've opted for a gradient background, this attribute lets you set the ratio of each color constituent.
Type: Number
Range: 0 - 100
bgAngle
Sets the angle of the background color, in case of a gradient.
Type: Number
Range: 0-360
bgImage
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.
Type: String
Range:
bgImageAlpha
This attribute specifies the opacity for the loaded background image.
Type: Number
Range: 0 - 100
bgImageDisplayMode
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.
Type: String
Range: stretch, tile, fit, fill, center, none
bgImageVAlign
Helps you to vertically align the background image.
Type: String
Range: top, middle, bottom
bgImageHAlign
Helps you to horizontally align the background image.
Type: String
Range: left, middle, right
bgImageScale
Helps you magnify the background image.This attribute will only work when the attribute
bgImageDisplayMode
is set to none, center, or tile.
Type: Number
Range: 0-300
canvasBgColor
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.
Type: Color
Range: Hex Color Code
canvasBgAlpha
This attribute sets the background transparency for the chart canvas. For gradient, separate the alpha value using comma. Example: 15, 50.
Type: Number
Range: 0 - 100
canvasBgRatio
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.
Type: Numbers separated by comma
Range: 0 - 100
canvasBgAngle
Helps you specify canvas background angle in case of gradient.
Type: Number
Range: 0-360
canvasBorderColor
Lets you specify canvas border color.
Type: Color
Range: Hex Color Code
canvasBorderThickness
Lets you specify canvas border thickness.
Type: Number
Range: 0-5
canvasBorderAlpha
Lets you control transparency of canvas border.
Type: Number
Range: 0 - 100
logoURL
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.
Type: String
Range: URL
logoLeftMargin
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.
Type: Number
Range: In Pixels
logoTopMargin
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.
Type: Number
Range: In Pixels
logoPosition
Where to position the logo on the chart: TL - Top-left TR - Top-right BR - Bottom right BL - Bottom left CC - Center of screen
Type: String
Range: TL, TR, BL, BR, CC
logoAlpha
Once the logo has loaded on the chart, you can configure its opacity using this attribute.
Type: Number
Range: 0 - 100
logoScale
You can also change the scale of an externally loaded logo at run-time by specifying a value for this parameter.
Type: Number
Range: 0-300
logoLink
If you want to link the logo to an external URL, specify the link in this attribute. The link can be in Froala Charts Link format, allowing you to link to new windows, pop-ups, frames etc.
Type: String
Range: URL
Quadrants
The following attributes let you configure different facets of quadrants like quadrant lines, quadrant labels and their various functionalities.
drawQuadrant
Whether to draw quadrants on the chart.
Type: Boolean
Range: 0/1
quadrantXVal
This attribute lets you set the position of the vertical quadrant line.
Type: Number
Range: Numeric Value
quadrantYVal
This attribute lets you set the position of the horizontal quadrant line.
Type: Number
Range: Numeric Value
quadrantLineColor
Lets you set the color of the quadrant lines.
Type: Color
Range: Hex Color Code
quadrantLineThickness
Lets you set the thickness of the quadrant lines.
Type: Number
Range: In Pixels
quadrantLineAlpha
Lets you control the transparency of the quadrant lines.
Type: Number
Range: 0 - 100
quadrantLineDashed
Whether the quadrant line should be rendered as dashed lines.
Default value: 0 (quadrant line rendered using straight lines)
Type: Boolean
Range: 0/1
quadrantLineDashLen
Sets the length of each dash when quadrant line is rendered as dashed lines.
Type: Number
Range: In pixels
quadrantLineDashGap
Sets the gap between consecutive dashes when quadrant line is rendered as dashed lines.
Type: Number
Range: In pixels
quadrantLabelTL
This attribute lets you specify the label text of the top-left quadrant.
Type: String
Range:
quadrantLabelTR
This attribute lets you specify the label text of the top-right quadrant.
Type: String
Range:
quadrantLabelBL
This attribute lets you specify the label text of the bottom-left quadrant.
Type: String
Range:
quadrantLabelBR
This attribute lets you specify the label text of the bottom-right quadrant.
Type: String
Range:
quadrantLabelFont
This attribute lets you set the font for all quadrant labels.
Default value: Base font
Type: String
Range: Font Name
quadrantLabelTLFont
This attribute lets you set the font for the top-left quadrant label.
Default value: Base font
Type: String
Range: Font Name
quadrantLabelTRFont
This attribute lets you set the font for the top-right quadrant label.
Default value: Base font
Type: String
Range: Font Name
quadrantLabelBLFont
This attribute lets you set the font for the bottom-left quadrant label.
Default value: Base font
Type: String
Range: Font Name
quadrantLabelBRFont
This attribute lets you set the font for the bottom-right quadrant label.
Default value: Base font
Type: String
Range: Font Name
quadrantLabelFontColor
This attribute lets you set the font color for all quadrant labels.
Default value: Base font color
Type: Hex Color Code
Range:
quadrantLabelTLFontColor
This attribute lets you set the font color for the top-left quadrant label.
Default value: Base font color
Type: Hex Color Code
Range:
quadrantLabelTRFontColor
This attribute lets you set the font color for the top-right quadrant label.
Default value: Base font color
Type: Hex Color Code
Range:
quadrantLabelBLFontColor
This attribute lets you set the font color for the bottom-left quadrant label.
Default value: Base font color
Type: Hex Color Code
Range:
quadrantLabelBRFontColor
This attribute lets you set the font color for the bottom-right quadrant label.
Default value: Base font color
Type: Hex Color Code
Range:
quadrantLabelFontAlpha
This attribute lets you set the font transparency of all quadrant labels.
Default value: 100
Type: Number
Range: 0 - 100
quadrantLabelTLFontAlpha
This attribute lets you set the font transparency of the top-left quadrant label.
Default value: 100
Type: Number
Range: 0 - 100
quadrantLabelTRFontAlpha
This attribute lets you set the font transparency of the top-right quadrant label.
Default value: 100
Type: Number
Range: 0 - 100
quadrantLabelBLFontAlpha
This attribute lets you set the font transparency of the bottom-left quadrant label.
Default value: 100
Type: Number
Range: 0 - 100
quadrantLabelBRFontAlpha
This attribute lets you set the font transparency of the bottom-right quadrant label.
Default value: 100
Type: Number
Range: 0 - 100
quadrantLabelFontSize
This attribute lets you set the font size for all quadrant labels.
Default value: Base font size
Type: Number
Range:
quadrantLabelTLFontSize
This attribute lets you set the font size for the top-left quadrant label.
Default value: Base font size
Type: Number
Range:
quadrantLabelTRFontSize
This attribute lets you set the font size for the top-right quadrant label.
Default value: Base font size
Type: Number
Range:
quadrantLabelBLFontSize
This attribute lets you set the font size for the bottom-left quadrant label.
Default value: Base font size
Type: Number
Range:
quadrantLabelBRFontSize
This attribute lets you set the font size for the bottom-right quadrant label.
Default value: Base font size
Type: Number
Range:
quadrantLabelFontBold
This attribute lets you specify whether the label text for all quadrants will be bold formatted.
Default value: 0 (not formatted in bold)
Type: Boolean
Range: 0/1
quadrantLabelTLFontBold
This attribute lets you specify whether the top-left quadrant label text will be bold formatted.
Default value: 0 (not formatted in bold)
Type: Boolean
Range: 0/1
quadrantLabelTRFontBold
This attribute lets you specify whether the top-right quadrant label text will be bold formatted.
Default value: 0 (not formatted in bold)
Type: Boolean
Range: 0/1
quadrantLabelBLFontBold
This attribute lets you specify whether the bottom-left quadrant label text will be bold formatted.
Default value: 0 (not formatted in bold)
Type: Boolean
Range: 0/1
quadrantLabelBRFontBold
This attribute lets you specify whether the bottom-right quadrant label text will be bold formatted.
Default value: 0 (not formatted in bold)
Type: Boolean
Range: 0/1
quadrantLabelFontItalic
This attribute lets you specify whether the label text for all quadrants will be italicized.
Default value: 0 (not italicized)
Type: Boolean
Range: 0/1
quadrantLabelTLFontItalic
This attribute lets you specify whether the top-left quadrant label text will be italicized.
Default value: 0 (not italicized)
Type: Boolean
Range: 0/1
quadrantLabelTRFontItalic
This attribute lets you specify whether the top-right quadrant label text will be italicized.
Default value: 0 (not italicized)
Type: Boolean
Range: 0/1
quadrantLabelBLFontItalic
This attribute lets you specify whether the bottom-left quadrant label text will be italicized.
Default value: 0 (not italicized)
Type: Boolean
Range: 0/1
quadrantLabelBRFontItalic
This attribute lets you specify whether the bottom-right quadrant label text will be italicized.
Default value: 0 (not italicized)
Type: Boolean
Range: 0/1
quadrantLabelBorderColor
This attribute lets you set the border color for all quadrant labels.
Default value: none
Type: Hex Color Code
Range:
quadrantLabelTLBorderColor
This attribute lets you set the color of the top-left quadrant label border.
Default value: none
Type: Hex Color Code
Range:
quadrantLabelTRBorderColor
This attribute lets you set the color of the top-right quadrant label border.
Default value: none
Type: Hex Color Code
Range:
quadrantLabelBLBorderColor
This attribute lets you set the color of the bottom-left quadrant label border.
Default value: none
Type: Hex Color Code
Range:
quadrantLabelBRBorderColor
This attribute lets you set the color of the bottom-right quadrant label border.
Default value: none
Type: Hex Color Code
Range:
quadrantLabelBorderAlpha
This attribute lets you set the border transpareny for all quadrant labels.
Default value: 100
Type: Number
Range: 0 - 100
quadrantLabelTLBorderAlpha
This attribute lets you set the transpareny of the top-left quadrant label border.
Default value: 100
Type: Number
Range: 0 - 100
quadrantLabelTRBorderAlpha
This attribute lets you set the transpareny of the top-right quadrant label border.
Default value: 100
Type: Number
Range: 0 - 100
quadrantLabelBLBorderAlpha
This attribute lets you set the transpareny of the bottom-left quadrant label border.
Default value: 100
Type: Number
Range: 0 - 100
quadrantLabelBRBorderAlpha
This attribute lets you set the transpareny of the bottom-right quadrant label border.
Default value: 100
Type: Number
Range: 0 - 100
quadrantLabelBorderThickness
This attribute lets you set the border thickness for all quadrant labels.
Default value: 1
Type: Number
Range: 1-5
quadrantLabelTLBorderThickness
This attribute lets you set the thickness of the top-left quadrant label border.
Default value: 1
Type: Number
Range: 1-5
quadrantLabelTRBorderThickness
This attribute lets you set the thickness of the top-right quadrant label border.
Default value: 1
Type: Number
Range: 1-5
quadrantLabelBLBorderThickness
This attribute lets you set the thickness of the bottom-left quadrant label border.
Default value: 1
Type: Number
Range: 1-5
quadrantLabelBRBorderThickness
This attribute lets you set the thickness of the bottom-right quadrant label border.
Default value: 1
Type: Number
Range: 1-5
quadrantLabelBorderPadding
This attribute lets you set the border padding for all quadrant labels.
Default value: 2
Type: Number
Range:
quadrantLabelTLBorderPadding
This attribute lets you set the padding for the top-left quadrant label border.
Default value: 2
Type: Number
Range:
quadrantLabelTRBorderPadding
This attribute lets you set the padding for the top-right quadrant label border.
Default value: 2
Type: Number
Range:
quadrantLabelBLBorderPadding
This attribute lets you set the padding for the bottom-left quadrant label border.
Default value: 2
Type: Number
Range:
quadrantLabelBRBorderPadding
This attribute lets you set the padding for the bottom-right quadrant label border.
Default value: 2
Type: Number
Range:
quadrantLabelBorderRadius
This attribute lets you set the border radius for all quadrant labels.
Default value: 0
Type: Number
Range:
quadrantLabelTLBorderRadius
This attribute lets you set the radius of the top-left quadrant label border.
Default value: 0
Type: Number
Range:
quadrantLabelTRBorderRadius
This attribute lets you set the radius of the top-right quadrant label border.
Default value: 0
Type: Number
Range:
quadrantLabelBLBorderRadius
This attribute lets you set the radius of the bottom-left quadrant label border.
Default value: 0
Type: Number
Range:
quadrantLabelBRBorderRadius
This attribute lets you set the radius of the bottom-right quadrant label border.
Default value: 0
Type: Number
Range:
quadrantLabelBorderDashed
This attribute lets you specify whether all quadrant label borders will be drawn as dashed lines.
Default value: 0 (drawn as a straight line)
Type: Boolean
Range: 0/1
quadrantLabelTLBorderDashed
This attribute lets you specify whether the top-left quadrant label border will be drawn as a dashed-line.
Default value: 0 (drawn as a straight line)
Type: Boolean
Range: 0/1
quadrantLabelTRBorderDashed
This attribute lets you specify whether the top-right quadrant label border will be drawn as a dashed-line.
Default value: 0 (drawn as a straight line)
Type: Boolean
Range: 0/1
quadrantLabelBLBorderDashed
This attribute lets you specify whether the bottom-left quadrant label border will be drawn as a dashed-line.
Default value: 0 (drawn as a straight line)
Type: Boolean
Range: 0/1
quadrantLabelBRBorderDashed
This attribute lets you specify whether the bottom-right quadrant label border will be drawn as a dashed-line.
Default value: 0 (drawn as a straight line)
Type: Boolean
Range: 0/1
quadrantLabelBorderDashlen
This attribute lets you set the length of each dash for all quadrant label borders, if the borders are drawn as a dashed line.
Default value: 4
Type: Number
Range: In pixels
quadrantLabelTLBorderDashlen
This attribute lets you set the length of each dash, if the top-left quadrant label border is drawn as a dashed line.
Default value: 4
Type: Number
Range: In pixels
quadrantLabelTRBorderDashlen
This attribute lets you set the length of each dash, if the top-right quadrant label border is drawn as a dashed line.
Default value: 4
Type: Number
Range: In pixels
quadrantLabelBLBorderDashlen
This attribute lets you set the length of each dash, if the bottom-left quadrant label border is drawn as a dashed line.
Default value: 4
Type: Number
Range: In pixels
quadrantLabelBRBorderDashlen
This attribute lets you set the length of each dash, if the bottom-right quadrant label border is drawn as a dashed line.
Default value: 4
Type: Number
Range: In pixels
quadrantLabelBorderDashgap
This attribute lets you set the distance between each dash for all quadrant label borders, if the borders are drawn as a dashed line.
Default value: 2
Type: Number
Range: In pixels
quadrantLabelTLBorderDashgap
This attribute lets you set the distance between each dash, if the top-left quadrant label border is drawn as a dashed line.
Default value: 2
Type: Number
Range: In pixels
quadrantLabelTRBorderDashgap
This attribute lets you set the distance between each dash, if the top-right quadrant label border is drawn as a dashed line.
Default value: 2
Type: Number
Range: In pixels
quadrantLabelBLBorderDashgap
This attribute lets you set the distance between each dash, if the bottom-left quadrant label border is drawn as a dashed line.
Default value: 2
Type: Number
Range: In pixels
quadrantLabelBRBorderDashgap
This attribute lets you set the distance between each dash, if the bottom-right quadrant label border is drawn as a dashed line.
Default value: 2
Type: Number
Range: In pixels
quadrantLabelBgColor
This attribute lets you set the background color for all quadrant labels.
Default value: None
Type: Color
Range: Hex Color Code
quadrantLabelTLBgColor
This attribute lets you set the background color for the top-left quadrant label.
Default value: None
Type: Hex Color Code
Range:
quadrantLabelTRBgColor
This attribute lets you set the background color for the top-right quadrant label.
Default value: None
Type: Hex Color Code
Range:
quadrantLabelBLBgColor
This attribute lets you set the background color for the bottom-left quadrant label.
Default value: None
Type: Hex Color Code
Range:
quadrantLabelBRBgColor
This attribute lets you set the background color for the bottom-right quadrant label.
Default value: None
Type: Hex Color Code
Range:
quadrantLabelBgAlpha
This attribute lets you set the background transparency for all quadrant labels.
Default value: 100
Type: Number
Range: 0 - 100
quadrantLabelTLBgAlpha
This attribute lets you set the background transparency for the top-left quadrant label.
Default value: 100
Type: Number
Range: 0 - 100
quadrantLabelTRBgAlpha
This attribute lets you set the background transparency for the top-right quadrant label.
Default value: 100
Type: Number
Range: 0 - 100
quadrantLabelBLBgAlpha
This attribute lets you set the background transparency for the bottom-left quadrant label.
Default value: 100
Type: Number
Range: 0 - 100
quadrantLabelBRBgAlpha
This attribute lets you set the background transparency for the bottom-right quadrant label.
Default value: 100
Type: Number
Range: 0 - 100
quadrantLabelPadding
This attribute lets you control the space between quadrant labels and the associated quadrant lines.
Type: Number
Range: In Pixels
Data Plot Cosmetics
These attributes let you configure how your plot (columns, lines, area, pie or any data that you're plotting) will 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.
showPlotBorder
Whether the column, area, pie etc. border will show up.
Type: Boolean
Range: 0/1
plotBorderColor
Color for column, area, pie border
Type: Color
Range: Hex Color Code
plotBorderThickness
Thickness for column, area, pie border
Type: Number
Range: 0-5
plotBorderAlpha
Alpha for column, area, pie border
Type: Number
Range: 0 - 100
plotFillAlpha
If you've opted to fill the plot (column, area etc.) as gradient, this attribute lets you set the fill alpha for gradient.
Type: Number
Range: 0 - 100
Data Value Cosmetics
These attributes let you configure font, background and border cosmetics, of value text-field that appear for each data plot.
valueFont
Sets the font of the values in the chart
Type: String
Range: Font Name
valueFontColor
Specifies the value font color
Type: Color
Range: Hex Color Code
valueFontSize
Specifies the value font size
Type: Number
Range: 6 - 72
valueFontBold
Whether value font should be bold
Type: Boolean
Range: 0/1
valueFontItalic
Whether value font should be italicized
Type: Boolean
Range: 0/1
valueBgColor
Sets the background color for value text
Type: Color
Range: Hex Color Code
valueBorderColor
Sets the border color around the value text
Type: Color
Range: Hex Color Code
valueAlpha
Sets the value alpha including font and background
Type: Number
Range: 0 - 100
valueFontAlpha
Sets the value font alpha
Type: Number
Range: 0 - 100
valueBgAlpha
Sets the value background alpha
Type: Number
Range: 0 - 100
valueBorderAlpha
Sets the value border alpha
Type: Number
Range: 0 - 100
valueBorderThickness
Sets the value border thickness
Type: Number
Range: In Pixels
valueBorderPadding
Sets the padding between the value and its surrounding border
Type: Number
Range: In Pixels
valueBorderRadius
Sets the value border radius
Type: Number
Range: In Pixels
valueBorderDashed
Whether the border around the data values should be rendered using dashed lines.
Default value: 0 (border rendered using straight lines)
Type: Boolean
Range: 0/1
valueBorderDashLen
Sets the length of each dash when the border around the data values is rendered using dashed lines.
Type: Number
Range: In pixels
valueBorderDashGap
Sets the gap between two consecutive dashes when the border around the data values is rendered using dashed lines.
Type: Number
Range: In pixels
textOutline
Set this attribute to 1
to draw a border on the data value text.
Default value: 0
Type: Boolean
Range: 0/1
minRadiusForValue
Set the minimum radius of a bubble, above which the data values will be visible.
Type: Number
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/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.
numDivLines
Number of horizontal axis division lines that you want on the chart.
Type: Number
Range: Numeric value > 0
divLineColor
Color for divisional lines.
Type: Color
Range: Hex Color Code
divLineThickness
Thickness of divisional lines.
Type: Number
Range: 1-5
divLineAlpha
Alpha of divisional lines.
Type: Number
Range: 0 - 100
divLineDashed
Whether the divisional lines should be rendered as dashed lines.
Default value: 0 (divisional lines rendered using straight lines)
Type: Boolean
Range: 0/1
divLineDashLen
Sets the length of each dash when divisional lines are rendered as dashed lines.
Type: Number
Range: In pixels
divLineDashGap
Sets the gap between two consecutive dashes when divisional lines are rendered as dashed lines.
Type: Number
Range: In pixels
showAlternateHGridColor
Whether to show alternate colored horizontal grid bands.
Type: Boolean
Range: 0/1
alternateHGridColor
Color of the alternate horizontal grid bands.
Type: Color
Range: Hex Color Code
alternateHGridAlpha
Alpha (transparency) of the alternate horizontal grid bands.
Type: Number
Range: 0 - 100
numVDivLines
Number of vertical axis division lines that you want to display on the chart.
Type: Number
Range: Numeric value > 0
vDivLineColor
Color for vertical divisional lines.
Type: Color
Range: Hex Color Code
vDivLineThickness
Thickness of vertical divisional lines.
Type: Number
Range: 1-5
vDivlineAlpha
Transparency of the vertical divisional lines.
Type: Number
Range: 0 - 100
vDivLineDashed
Whether the vertical divisional lines should be rendered as dashed lines.
Default value: 0 (vertical divisional lines using straight lines)
Type: Boolean
Range: 0/1
vDivLineDashLen
Sets the width of each dash when vertical divisional lines are rendered as dashed lines.
Type: Number
Range: In pixels
vDivLineDashGap
Sets the gap between two consecutive dashes when vertical divisional lines are rendered as dashed lines.
Type: Number
Range: In pixels
showAlternateVGridColor
Whether to show alternate colored vertical grid bands.
Type: Boolean
Range: 0/1
alternateVGridColor
Color of the alternate vertical grid bands.
Type: Color
Range: Hex Color Code
alternateVGridAlpha
Transparency of the alternate vertical grid bands.
Type: Number
Range: 0 - 100
showZeroPlane
Whether to show zero plane. Zero Plane is the line/plane that appears at 0 y-position on canvas, when negative data is being shown on the chart.
Type: Boolean
Range: 0/1
showZeroPlaneValue
Allows you to show or hide the value on which the zero plane exists on the y-axis. By default, the value is displayed.
Type: Boolean
Range: 0/1
zeroPlaneColor
Color for the Zero Plane.
Type: Color
Range: Hex Color Code
zeroPlaneThickness
Thickness of zero plane.
Type: Number
Range: In Pixels
zeroPlaneAlpha
Alpha of zero plane.
Type: Number
Range: 0 - 100
showVZeroPlane
Whether to show vertical zero plane. Zero Plane is the line/plane that appears at 0 x-position on canvas, when negative data is being shown on the chart.
Type: Boolean
Range: 0/1
vZeroPlaneColor
Color of the vertical zero plane.
Type: Color
Range: Hex Color Code
vZeroPlaneThickness
Thickness of the vertical zero plane.
Type: Number
Range: In Pixels
vZeroPlaneAlpha
Transparency of the vertical zero plane.
Type: Number
Range: 0 - 100
Legend Properties
In bubble charts, the series name of each dataset shows up in the legend of the chart. If you do not need the legend, you can opt to hide the same. Also, the legend can be placed at the bottom of the chart or to the right of the chart. Using the attributes below, you can configure the functional and cosmetic properties of the legend.
showLegend
Whether to show legend on the chart.
Type: Boolean
Range: 0/1
legendItemFontBold
Whether legend keys should be displayed in bold
Type: Boolean
Range: 0/1
legendItemFont
Sets legend item font
Type: String
Range: Font Name
legendItemFontSize
Sets legend item font size
Type: Number
Range: 6 - 72
legendItemFontColor
Sets legend item font color
Type: Color
Range: Hex Color Code
legendItemHoverFontColor
Sets legend item font color on hover
Type: Color
Range: Hex Color Code
legendPosition
The legend can be plotted at different positions with respect to the chart. Note that if the value of
legendPosition
is set to absolute
, you also need to set the coordinates of the
legend. You can do that using the attributes legendXPosition
and legendYPosition
,
both of which accept absolute or percentage values.
Type: String
Range: bottom, right, top, top-left, top-right, bottom-left, bottom-right, left, left-top, left-bottom, right, right-top, right-bottom, and absolute
legendXPosition
When the value of legendPosition
is set to absolute
, use this attribute to set the
X-coordinate of the legend. It accepts absolute or percentage values. By default, its value is set to
0
.
Type: Number
Range: 0 to chart width (in pixels)
legendYPosition
When the value of legendPosition
is set to absolute
, use this attribute to set the
Y-coordinate of the legend. It accepts absolute or percentage values. By default, its value is set to
0
.
Type: Number
Range: 0 to chart height (in pixels)
legendNumRows
Sets the number of rows the legend should display.
Type: Number
Range:
legendNumColumns
Sets the number of columns the legend should display.
Type: Number
Range:
legendCaptionAlignment
Sets the legend caption horizontal alignment .
Type: String
Range: "left", "center", "right"
legendCaptionFontBold
Whether legend caption should be displayed in bold
Type: Boolean
Range: 0/1
legendCaptionFont
Sets legend caption font
Type: String
Range: Font Name
legendCaptionFontSize
Sets legend caption font size
Type: Number
Range: 6 - 72
legendCaptionFontColor
Sets legend caption font color
Type: Color
Range: Hex Color Code
legendCaption
You can add a caption for the entire legend by setting the same here.
Type: String
Range:
legendItemHiddenColor
Sets the color that applies on both text font and icon when they are in a disabled / hidden state
Type: Color
Range: Hex Color Code
legendIconScale
Scaling of legend icon is possible in Froala Charts. This attribute lets you control the size of legend icon.
Type: Number
Range: 1-5
legendBgColor
Background color for the legend.
Type: Color
Range: Hex Color Code
legendBgAlpha
Background alpha for the legend.
Type: Number
Range: 0 - 100
legendBorderColor
Border Color for the legend.
Type: Color
Range: Hex Color Code
legendBorderThickness
Border thickness for the legend.
Type: Number
Range: In Pixels
legendBorderAlpha
Border alpha for the legend.
Type: Number
Range: 0 - 100
legendShadow
Whether to show a shadow for legend.
Type: Boolean
Range: 0/1
legendAllowDrag
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.
Type: Boolean
Range: 0/1
legendScrollBgColor
If you've too many items on the legend, a scroll bar shows up on the same. This attribute lets you configure the background color of the scroll bar.
Type: Color
Range: Hex Color Code
interactiveLegend
This attribute lets you interact with the legend in your chart. When you click a legend key, the dataplots associated with that series are eliminated from the chart. Re-clicking the key causes the dataplots to reappear.
Type: Boolean
Range: 0/1
legendNumColumns
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.
Type: Number
Range: Positive Integer
minimiseWrappingInLegend
Whether to minimize legend item text wrapping.
Type: Boolean
Range: 0/1
drawCustomLegendIcon
Specifies whether drawing a custom legend icon will be enabled. All legend icon customization attributes will work only if this feature is enabled.
Default value: 0 (disabled)
Type: Boolean
Range: 0/1
legendIconBorderColor
Sets the border color for the legend icon.
Default value: Data plot border color
Type: Color
Range: Hex Color Code
legendIconBgColor
Sets the background color for the legend icon.
Default value: Data plot fill color
Type: Color
Range: Hex Color Code
legendIconAlpha
Sets the legend icon transparency.
Default value: 100
Type: Number
Range: 0 - 100
legendIconBgAlpha
Sets the legend icon background transparency.
Default value: 100
Type: Number
Range: 0 - 100
legendIconSides
Sets the number of sides for the legend icon.
Default value: 4
Type: Number
Range:
legendIconBorderThickness
Sets the thickness of the legend icon border.
Default value: 1
Type: Number
Range: 1-5
legendIconStartAngle
Sets the starting angle of for drawing the legend icon.
Default value: 45
Type: Number
Range:
alignLegendWithCanvas
This attribute if set to 0
, the legend box will be center aligned with respect to the entire
width of the chart only if the total width of the legend box is more than the canvas width. By default, the
legend box is center aligned with respect to the canvas width and it remains the same if the width of the
legend box is less than the canvas width.
Type: Boolean
Range: 0/1
Number Formatting
Froala Charts 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
formatNumber
This configuration determines whether the numbers displayed on the chart will be formatted using commas,
e.g., 40,000 if 'formatNumber': '1'; and 40000 if 'formatNumber': '0';. The value of this attribute works
only if yFormatNumber
and xFormatNumber
attributes are not specifically mentioned.
Type: Boolean
Range: 0/1
yFormatNumber
This configuration determines whether the numbers displayed on the y-axis of the chart will be formatted
using commas, e.g., 40,000 if 'formatNumber': '1'; and 40000 if 'formatNumber': '0';. If this attribute is
not specifically mentioned, the chart inherits the default value from formatNumber
attribute.
Type: Boolean
Range: 0/1
xFormatNumber
This configuration determines whether the numbers displayed on the x-axis of the chart will be formatted
using commas, e.g., 40,000 if 'formatNumber': '1'; and 40000 if 'formatNumber': '0';. If this attribute is
not specifically mentioned, the chart inherits the default value from formatNumber
attribute.
Type: Boolean
Range: 0/1
formatNumberScale
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 will become 1.04K (with decimals set to 2 places).
Same with numbers in millions - an M will be added at the end. The value of this attribute works only if
yFormatNumberScale
and xFormatNumberScale
attributes are not specifically
mentioned.
Type: Boolean
Range: 0/1
yFormatNumberScale
Configuration whether to add K (thousands) and M (millions) to a number after truncating and rounding it on
the y-axis - e.g., if yFormatNumberScale
is set to 1, 1043 will become 1.04K (with decimals set
to 2 places). Same with numbers in millions - an M will be added at the end. If this attribute is not
specifically mentioned, the chart inherits the default value from formatNumberScale
attribute.
Type: Boolean
Range: 0/1
xFormatNumberScale
Configuration whether to add K (thousands) and M (millions) to a number after truncating and rounding it on
the x-axis - e.g., if xFormatNumberScale
is set to 1, 1043 will become 1.04K (with decimals set
to 2 places). Same with numbers in millions - an M will be added at the end. If this attribute is not
specifically mentioned, the chart inherits the default value from formatNumberScale
attribute.
Type: Boolean
Range: 0/1
defaultNumberScale
The default unit of the numbers that you're providing to the chart. The value of this attribute works only if
yDefaultNumberScale
and xDefaultNumberScale
attributes are not specifically
mentioned.
Type: String
Range:
yDefaultNumberScale
The default unit of the numbers of the y-axis that you're providing to the chart. If this attribute is not
specifically mentioned, the chart inherits the default value from defaultNumberScale
attribute.
Type: String
Range:
xDefaultNumberScale
The default unit of the numbers of the x-axis that you're providing to the chart. If this attribute is not
specifically mentioned, the chart inherits the default value from defaultNumberScale
attribute.
Type: String
Range:
numberScaleUnit
Unit of each block of the scale. The value of this attribute works only if yNumberScaleUnit
and
xNumberScaleUnit
attributes are not specifically mentioned.
Type: String
Range:
yNumberScaleUnit
Unit of each block of the scale of the y-axis. If this attribute is not specifically mentioned, the chart
inherits the default value from numberScaleUnit
attribute.
Type: String
Range:
xNumberScaleUnit
Unit of each block of the scale of the x-axis. If this attribute is not specifically mentioned, the chart
inherits the default value from numberScaleUnit
attribute.
Type: String
Range:
numberScaleValue
Range of the various blocks that constitute the scale. The value of this attribute works only if
yNumberScaleValue
and xNumberScaleValue
attributes are not specifically mentioned.
Type: String
Range:
forceNumberScale
If a data value is less than the lowest given number is the number scale, this attribute forces the lower
value of the numberScaleUnit
to be applied to that data value. 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.
Type: Boolean
Range: 0/1
scaleRecursively
Whether recursive scaling should be applied.
Type: Boolean
Range: 0/1
xScaleRecursively
Whether to scale the number recursively for the x-axis? This attribute will work only if the attribute
xAxisLabelMode
is set to 'AUTO
' or 'MIXED
'.
Type: Boolean
Range: 0/1
maxScaleRecursion
How many recursions to complete during recursive scaling? -1 completes the entire set of recursion.
Type: Number
Range:
xMaxScaleRecursion
How many recursions to complete during recursive scaling for the numbers on the x-axis? -1 completes the entire set of recursion.
Type: Number
Range:
scaleSeparator
What character to use to separate the scales that are generated after recursion?
Type: String
Range:
xScaleSeparator
This attribute is used to specify the character that will be used to separate the scales that are generated after recursion for the numbers on the x-axis.
Type: String
Range:
yNumberScaleValue
Range of the various blocks that constitute the y-axis scale. If this attribute is not specifically
mentioned, the chart inherits the default value from numberScaleValue
attribute.
Type: String
Range:
xNumberScaleValue
Range of the various blocks that constitute the x-axis scale. If this attribute is not specifically
mentioned, the chart inherits the default value from numberScaleValue
attribute.
Type: String
Range:
numberPrefix
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. The
value of this attribute works only if yNumberPrefix
and xNumberPrefix
attributes
are not specifically mentioned.
Type: String
Range: Character
yNumberPrefix
Using this attribute, you could add prefix to all the numbers visible on the y-axis. For example, to
represent all dollars figure on the y-axis, you could specify this attribute to $ to show like $40000,
$50000. If this attribute is not specifically mentioned, the chart inherits the default value from
numberPrefix
attribute.
Type: String
Range: Character
xNumberPrefix
Using this attribute, you could add prefix to all the numbers visible on the x-axis. For example, to
represent all dollars figure on the x-axis, you could specify this attribute to $ to show like $40000,
$50000. If this attribute is not specifically mentioned, the chart inherits the default value from
numberPrefix
attribute.
Type: String
Range: Character
numberSuffix
Using this attribute, you could add a suffix to all the numbers visible on the graph. For example, to
represent all figures quantified as per annum on the chart, you could specify this attribute to '/a' to show
like 40000/a, 50000/a. The value of this attribute works only if yNumberSuffix
and
xNumberSuffix
attributes are not specifically mentioned.
Type: String
Range: Character
yNumberSuffix
Using this attribute, you could add a suffix to all the numbers visible on the y-axis. For example, to
represent all figure quantified as per annum on the y-axis, you could specify this attribute to '/a' to show
like 40000/a, 50000/a. If this attribute is not specifically mentioned, the chart inherits the default value
from numberSuffix
attribute.
Type: String
Range: Character
xNumberSuffix
Using this attribute, you could add a suffix to all the numbers visible on the x-axis. For example, to
represent all figure quantified as per annum on the x-axis, you could specify this attribute to '/a' to show
like 40000/a, 50000/a.If this attribute is not specifically mentioned, the chart inherits the default value
from numberSuffix
attribute.
Type: String
Range: Character
decimalSeparator
This attribute helps you specify the character to be used as the decimal separator in a number.
Type: String
Range: Character
thousandSeparator
This attribute helps you specify the character to be used as the thousands separator in a number.
Type: String
Range: Character
thousandSeparatorPosition
This option helps you specify the position of the thousand separator.
Type: Number
Range:
inDecimalSeparator
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, Froala Charts 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.
Type: String
Range: Character
inThousandSeparator
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, Froala Charts 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.
Type: String
Range: Character
decimals
Number of decimal places to which all numbers on the chart will be rounded to.
Type: Number
Range: 0-10
forceDecimals
Whether to add 0 padding at the end of decimal numbers. 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 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 the numbers, set this attribute to 1.
Type: Boolean
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 Froala Charts. Using Styles, you can also specify advanced font properties like Bold, Italics, HTML Mode etc.
baseFont
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.
Type: String
Range: Font Name
baseFontSize
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.
Type: Number
Range: 6 - 72
baseFontColor
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.
Type: Color
Range: Hex Color Code
outCnvBaseFont
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.
Type: String
Range: Font Name
outCnvBaseFontSize
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.
Type: Number
Range: 6 - 72
outCnvBaseFontColor
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.
Type: Color
Range: Hex Color Code
Tooltip Attributes
These attributes let you control the tool tip. You can set the background color, border color, separator character and few other details.
showToolTip
Whether to show tool tip on chart.
Type: Boolean
Range: 0/1
toolTipBgColor
Background color for tool tip.
Type: Color
Range: Hex Color Code
toolTipColor
Font color for the tool-tip.
Type: Color
Range: Hex Color Code
toolTipBorderColor
Border color for tool tip.
Type: Color
Range: Hex Color Code
tooltipBorderAlpha
Sets the border transparency for tool tip.
Type: Number
Range: 0 - 100
toolTipSepChar
The character specified as the value of this attribute separates the name and value displayed in tool tip.
Type: String
Range:
seriesNameInToolTip
For bubble charts, Froala Charts shows the following information in tool tip (unless tool text is explicitly defined): "Series Name, Category Name, Data Value". This attribute lets you control whether series name will show up in tool tip or not.
Type: Boolean
Range: 0/1
showToolTipShadow
Whether to show shadow for tool-tips on the chart.
Type: Boolean
Range: 0/1
plottooltext
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.
Type: String
Range:
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.
toolbarPosition
Where to position the toolbar on the chart: TL - Top-left TR - Top-right BR - Bottom right BL - Bottom left CC - Center of screen
Type: String
Range: TL, TR, BL, BR, CC
toolbarX
Sets the toolbox position on the chart with respect to x-axis.
Type: Number
Range:
toolbarY
Sets the toolbox position on the chart with respect to y-axis.
Type: Number
Range:
toolbarHAlign
Sets the horizontal alignment of the toolbar on the chart.
Type: String
Range: Left, Right
toolbarVAlign
Sets the vertical alignment of the toolbar on the chart
Type: String
Range: Top, Bottom
toolbarButtonColor
Sets the color of the toolbar buttons.
Type: Color
Range: Any (color code without the # prefix)
showToolBarButtonTooltext
Enables/disables display of tooltips for toolbar buttons.
Type: Boolean
Range: 0/1
toolbarButtonScale
You can change the scale of the toolbar by specifying a value for this attribute.
Type: Number
Range:
Attributes for Exporting Charts
These attributes allow you to control the saving of chart as image, SVG or XLSX.
exportEnabled
Whether the chart will allow exporting to images, PDFs, SVG, XLSX or CSV format.
Default value: 0
Type: Boolean
Range: 0/1
exportAction
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
Type: String
Range: 'save' or 'download'
exportHandler
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).
Type: String
Range:
exportFormats
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'
Type: String
Range:
exportMode
This attributes sets the modes of export. To enable client-side exporting, set this attribute to client.
Note:The exportMode
attribute replaces the
exportAtClientSide
attribute. However, you don’t need to make any changes to the existing setup
because, the Froala Charts library comes with the proper mapping already provided.
Default value: auto.
Type: String
exportShowMenuItem
Whether the menu items related to export (e.g., Save as JPEG etc.) will appear in the context menu of chart.
Type: Boolean
Range: 0/1
exportTargetWindow
In case of server-side exporting and when using download as action, this lefts you configure whether the return image, PDF, SVG or XLSX will open in same window (as an attachment for download), or whether it will open in a new window.
Default value: _self
Type: String
Range: '_self' or '_blank'
exportFileName
Using this attribute you can specify the name (excluding the extension) of the output (export) file.
Type: String
Range:
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.
showHoverEffect
Whether to enable hover effect on charts for all elements
Type: Boolean
Range: 0/1
plotHoverEffect
Whether to enable hover effect on charts for data plots (e.g., column, pie) only
Type: Boolean
Range: 0/1
plotFillHoverColor
Specifies the hover color for the data plots
Type: Color
Range: Hex Color Code
plotFillHoverAlpha
Specifies the hover alpha for data plots
Type: Number
Range: 1 - 100
bubbleHoverColor
This attribute specifies the hover color for the bubbles.
Type: Color
Range: Hex Color Code
bubbleHoverAlpha
This attribute specifies the transparency of the bubble when hovered.
Type: Number
Range: 0 - 100
plotBorderHoverColor
Sets the color of the border of plot when hovered.
Type: Color
Range: Hex Color Code
plotBorderHoverThickness
Sets the thickness of the border of plot when hovered.
Type: Number
Range: In Pixels
bubbleHoverScale
This attribute sets the scale of bubble when hovered.
Type: Number
Range: In pixels
is3dOnHover
Whether to show 3D bubble on hover. If not specified, the effect is guided by is3D attribute.
Type: Boolean
Range: 0/1
Chart Padding & Margins
The following attributes help you control chart margins and paddings. Froala Charts allows you to manually customize the padding of various elements on the chart to allow advanced manipulation and control over chart visualization. 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, Froala Charts will not plot anything in that space. It's not necessary for you to specify any padding/margin values. Froala Charts automatically assumes the best values for the same, if you do not specify the same.
xAxisNamePadding
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).
Type: Number
Range: In Pixels
yAxisNamePadding
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).
Type: Number
Range: In Pixels
yAxisValuesPadding
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.
Type: Number
Range: In Pixels
labelPadding
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.
Type: Number
Range: In Pixels
chartLeftMargin
Amount of empty space that you want to put on the left side of your chart. Nothing is rendered in this space.
Type: Number
Range: In Pixels
chartRightMargin
Amount of empty space that you want to put on the right side of your chart. Nothing is rendered in this space.
Type: Number
Range: In Pixels
chartTopMargin
Amount of empty space that you want to put on the top of your chart. Nothing is rendered in this space.
Type: Number
Range: In Pixels
chartBottomMargin
Amount of empty space that you want to put at the bottom of your chart. Nothing is rendered in this space.
Type: Number
Range: In Pixels
legendPadding
Padding of legend from right/bottom side of canvas
Type: Number
Range: In Pixels
canvasPadding
Lets you set the space between the canvas border and first & last data points
Type: Number
Range: In Pixels
canvasLeftPadding
This attribute lets you set the space between the left of the canvas border and the canvas of the chart. This attribute is particularly useful when your data plot gets clipped by the left border of the canvas. Using this attribute, you can control the amount of empty space between the chart left side and data plot which might get clipped.
Type: Number
Range: In Pixels
canvasRightPadding
This attribute lets you set the space between the right of the canvas border and the canvas of the chart. This attribute is particularly useful when your data plot gets clipped by the right border of the canvas. Using this attribute, you can control the amount of empty space between the chart right side and data plot which might get clipped.
Type: Number
Range: In Pixels
canvasTopPadding
This attribute lets you set the space between the top of the canvas border and the canvas of the chart. This attribute is particularly useful when your data plot gets clipped by the top border of the canvas. Using this attribute, you can control the amount of empty space between the chart's top and data plot which might get clipped.
Type: Number
Range: In Pixels
canvasBottomPadding
This attribute lets you set the space between the bottom of the canvas border and the canvas of the chart. This attribute is particularly useful when your data plot gets clipped by the bottom border of the canvas. Using this attribute, you can control the amount of empty space between the chart's bottom and data plot which might get clipped.
Type: Number
Range: In Pixels
canvasLeftMargin
This attribute lets you control the space between the start of chart canvas and the start (x) of chart. In case of 2D charts, the canvas is the visible rectangular box. In case of 3D charts, the canvas box is the imaginary box around the 3D canvas. Using this attribute, you can control the amount of empty space between the chart left side and canvas left side. By default, Froala Charts automatically calculates this space depending on the elements to be placed on the chart. However, if you want to over-ride this value with a higher value, you can use this attribute to specify the same. Please note that you cannot specify a margin lower than what has been calculated by the chart. This attribute is particularly useful, when you've multiple charts placed in a page and want all their canvas start position to align with each other - so in such a case, you can set same margin value (a value large enough that it doesn't get rejected by chart owing to it being lower than the calculated value) for all such charts in the page.
Type: Number
Range: In Pixels
canvasRightMargin
Like canvasLeftMargin
, this attribute lets you set the space between end of canvas and end of
chart.
Type: Number
Range: In Pixels
canvasTopMargin
Like canvasLeftMargin
, this attribute lets you set the space between top of canvas and top of
chart.
Type: Number
Range: In Pixels
canvasBottomMargin
Like canvasLeftMargin
, this attribute lets you set the space between bottom of canvas and bottom
of chart.
Type: Number
Range: In Pixels
The categories Object
The categories
object and the category
object (child of the categories
object) are used to specify x-axis labels for multi-series charts. The attributes of the categories
object are used to set the font properties of all x-axis labels collectively.
font
Lets you specify font face for the x-axis data labels.
Type: String
Range: Valid font face
fontColor
Lets you specify font color for the x-axis data labels.
Type: Color
Range: Hex Color Code
fontSize
Lets you specify font size for the x-axis data labels.
Type: Number
Range:
verticalLineAlpha
Lets you set the alpha for category lines.
Type: Number
Range: 0 - 100
verticalLineColor
In the bubble/scatter chart, you can opt to show vertical lines for each category label. This attribute lets you set the color for all of them.
Type: Color
Range: Hex Color Code
verticalLineDashed
Whether the vertical lines should be rendered as dashed lines.
Default value: 0 (trendline rendered using straight lines)
Type: Boolean
Range: 0/1
verticalLineDashLen
Sets the length of each dash when vertical lines are rendered as dashed lines.
Type: Number
Range: In Pixels
verticalLineDashGap
Sets the gap between consecutive dashes when vertical lines are rendered as dashed lines.
Type: Number
Range: In Pixels
verticalLineThickness
Lets you set the thickness for category lines.
Type: Number
Range: In Pixels
The category Object
The attributes of the category
object are used to define and customize individual x-axis labels for
multi-series charts.
label
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.
Type: String
Range:
lineDashed
Whether the vertical lines should be rendered as dashed lines.
Default value: 0 (vertical lines using straight lines)
Type: Boolean
Range: 0/1
showLabel
You can individually opt to show/hide labels of individual data items using this attribute.
Type: Boolean
Range: 0/1
showVerticalLine
Whether the vertical line should be shown for this category.
Type: Boolean
Range: 0/1
x
The bubble/scatter chart have both x and y axis as numeric. This attribute lets you define the x value (numerical position on the x-axis) where this category name will be placed.
Type: Number
Range: Numeric Value
font
Sets the x-axis label font family for the text.
Type: String
Range:
fontColor
Sets the x-axis label font color.
Type: Color
Range: Hex Color Code
fontSize
Specifies the x-axis label font size.
Type: Number
Range: 6 - 72
fontBold
Flag indicating whether x-axis label font should be bold or not.
Type: Boolean
Range: 0/1
fontItalic
Flag indicating whether x-axis label font should be italicized or not.
Type: Boolean
Range: 0/1
bgColor
Sets the background color for x-axis label text.
Type: Color
Range: Hex Color Code
borderColor
Sets the color of the border around the x-axis label text.
Type: Color
Range: Hex Color Code
alpha
Sets the x-axis label alpha for both font and background.
Type: Number
Range: 0 - 100
bgAlpha
Sets the x-axis label background alpha.
Type: Number
Range: 0 - 100
borderAlpha
Sets the x-axis label border alpha.
Type: Number
Range: 0 - 100
borderPadding
Sets the x-axis label border padding.
Type: Number
Range: In Pixels
borderRadius
Sets the x-axis label border radius.
Type: Number
Range: In Pixels
borderThickness
Sets the x-axis label border thickness.
Type: Number
Range: In Pixels
borderDashed
Whether the border around x-axis label should be rendered using dashed lines.
Default value: 0 (border rendered using straight lines)
Type: Boolean
Range: 0/1
borderDashLen
Sets the length of each dash when the border around the x-axis label is rendered using dashed lines.
Type: Number
Range: In pixels
borderDashGap
Sets the gap between two consecutive dashes when the border around x-axis label is rendered using dashed lines.
Type: Number
Range: In pixels
The dataset object
Each dataset
object contains a series of data. For example, for a monthly sales comparison chart for
two successive years, the first data-set would contain the data for first year and the next one for the second
year. You can provide data-set level cosmetics so that all data within that data-set will be plotted in the same
color/alpha/etc. Depending on the chart type, there are a number of attributes that you can define for each
dataset
object.
seriesName
Lets you specify the series name for a particular dataset. For example, if you're plotting a chart to
indicate monthly sales analysis for 2005 and 2006, the seriesName
for the first dataset will be
2005 and that of the second will be 2006. The seriesName
of a dataset is shown in legend.
Type: String
Range:
color
This attribute sets the color using which columns, lines, area of that dataset will be drawn. For column chart, you can specify a list of comma separated Hex Color Codes to get a gradient plot
Type: Color
Range: Hex Color Code
plotFillAlpha
This attribute sets the alpha (transparency) of the entire dataset.
Type: String
Range: 0 - 100 or Comma Separated List
showValues
Whether to show the values for this dataset.
Type: Boolean
Range: 0/1
valueFontColor
Specifies the font color of data values for a particular dataset.
Type: Color
Range: Hex Color Code
valueBgColor
Sets the background color of value text for a particular dataset.
Type: Color
Range: Hex Color Code
valueBorderColor
Sets the border color around the value text for a particular dataset.
Type: Color
Range: Hex Color Code
includeInLegend
Whether to include the seriesName of this dataset in legend.
Type: Boolean
Range: 0/1
showPlotBorder
Whether to show the border of this dataset.
Type: Boolean
Range: 0/1
plotBorderColor
Color for data plot border of this dataset
Type: Color
Range: Hex Color Code
plotBorderThickness
Thickness for data plot border of this dataset
Type: Number
Range: 0-5
plotBorderAlpha
Alpha for data plot border of this dataset
Type: Number
Range: 0 - 100
showRegressionLine
This attribute, when set to '1`, draws a regression line for the dataset, for which the attribute is defined.
Type: Boolean
Range: 0/1
showYOnX
When it is set to '1' the regression line is drawn using Y On X mode and when the attribute is set to '0' the regression line is drawn using X On Y mode. By default, this attribute is set to '1'.
Type: Boolean
Range: 0/1
regressionLineColor
This attribute allows you to set the color of the regression line.
Type: Color
Range: Hex Color Code
regressionLineThickness
This attribute allows you to set the thickness of the regression line.
Type: Number
Range:
regressionLineAlpha
This attribute allows you to set the transparency of the regression line.
Type: Number
Range: 0 - 100
showHoverEffect
Whether to enable hover effect for the dataset.
Type: Boolean
Range: 0/1
hoverColor
This attribute can set the hover color for the dataset.
Type: Color
Range: Hex Color Code
hoverAlpha
This attribute sets the transparency for the dataset when hovered.
Type: Number
Range: 0 - 100
is3dOnHover
This attribute sets whether to render the bubbles in 3D mode on hover.
Type: Boolean
Range: 0/1
hoverScale
This attribute scales the bubbles on hover.
Type: Number
Range: In pixels
The data Object
Each instance of the data
object (child of the dataset
object) represents a set of data
which is to be plotted on the chart and determines a set of data which would appear on the chart. For a bubble
chart, one instance of the data
object looks like this:
"dataset"[{
"data": [{
"x": "80",
"y": "15000",
"z": "24",
"name": "Nike"
}]
}]
x
X-axis value for the set. The bubble/scatter point will be placed horizontally on the x-axis based on this value.
Type: Number
Range: Numeric Value
y
Y-axis value for the set. The bubble/scatter point will be placed vertically on the y-axis based on this value.
Type: Number
Range: Numeric Value
z
Z-axis numerical value for the set of data. The size of bubble will depend on this value (with respect to z values of other bubbles on the chart).
Type: Number
Range: Numeric Value
displayValue
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.
Type: String
Range:
color
For multi-series and combination charts, you can define the color of datasets at dataset level. However, if you wish to highlight a particular data element, you can specify its color at "set" level using this attribute.
Type: Color
Range: Hex Color Code
link
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.
Type: String
Range:
toolText
By default, Froala Charts 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.
Type: String
Range:
showValue
You can individually opt to show/hide values of individual data items using this attribute. This value over-rides the dataset level value.
Type: Boolean
Range: 0/1
valueFontColor
Specifies the font color of a data value for an individual data plot.
Type: Color
Range: Hex Color Code
valueBgColor
Sets the background color of a value text for an individual data plot.
Type: Color
Range: Hex Color Code
valueBorderColor
Sets the border color around the value text for an individual data plot.
Type: Color
Range: Hex Color Code
alpha
For multi-series and combination charts, you can define the alpha of datasets at dataset level. However, if you wish to highlight a particular data element, you can specify its alpha at "set" level using this attribute.
Type: Number
Range: 0 - 100
showHoverEffect
Whether to enable hover effect for a particular data plot.
Type: Boolean
Range: 0/1
hoverColor
This attribute can set the hover color for a particular data plot.
Type: Color
Range: Hex Color Code
hoverAlpha
This attribute sets the transparency for a particular data plot when hovered.
Type: Number
Range: 0 - 100
is3dOnHover
This attribute sets whether to render a particular bubble in 3D mode on hover.
Type: Boolean
Range: 0/1
hoverScale
This attribute scales the bubble on hover.
Type: Number
Range: In pixels
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.
startValue
The starting value for the trendline. Say, if you want to plot a slanted trendline from value 102 to 109, the
startValue
will be 102.
Type: Number
Range: Numeric Value
endValue
The ending y-axis value for the trendline. Say, if you want to plot a slanted trendline from value 102 to
109, the endValue
will be 109. If you do not specify a value for endValue
, it will
automatically assume the same value as startValue
.
Type: Number
Range: Numeric Value
displayValue
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
.
Type: String
Range:
color
Color of the trend line and its associated text
Type: String
Range: Hex Color Code
isTrendZone
Whether the trend will be displayed as a line or a zone (fill-colored rectangle).
Type: Boolean
Range: 0/1
showOnTop
Whether the trend line/zone will be displayed over data plots or under them.
Type: Boolean
Range: 0/1
thickness
If you've opted to show the trend as a line, this attribute lets you define the thickness of trend line.
Type: Number
Range: In Pixels
alpha
Alpha of the trend line.
Type: Number
Range: 0 - 100
dashed
Whether the trendline should be rendered as dashed lines.
Default value: 0 (trendline rendered using straight lines)
Type: Boolean
Range: 0/1
dashLen
Sets the width of each dash when trendline is rendered as dashed lines.
Type: Number
Range: In pixels
dashGap
Sets the gap between consecutive dashes when trendline is rendered as dashed lines.
Type: Number
Range: In pixels
valueOnRight
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.
Type: Boolean
Range: 0/1
showtrendlinelabels
It sets the configuration whether the trend line labels will be displayed or not.
Type: Boolean
Range: 0/1
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.
trendlineColor
Sets color of all the trend lines and its associated text in the chart.
Type: Color
Range: Hex Color Code
trendlineThickness
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.
Type: Number
Range: In Pixels
trendlineAlpha
Sets transparency for all the trend lines in your charts.
Type: Number
Range: 0 - 100
trendLineToolText
Sets the tooltip text of the trend-line. It accepts macros, plain text, and HTML tags, as string.
Type: String
Range:
showTrendlinesOnTop
Whether all the trend line/zone will be displayed over data plots or under them.
Type: Boolean
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.
trendValueFont
Sets the font family for the trend-line display value.
Type: String
Range: Font Name
trendValueFontSize
Sets the font size for the trend-line display value.
Type: Number
Range:
trendValueFontBold
Sets whether the trend-line display value will be bold formatted.
Default value: 0 (not bold formatted)
Type: Boolean
Range: 0/1
trendValueFontItalic
Sets whether the trend-line display value will be italicized.
Default value: 0 (not italicized)
Type: Boolean
Range: 0/1
trendValueBgColor
Sets the background color for the trend-line display value.
Type: Color
Range: Hex Color Code
trendValueBorderColor
Sets the border color for the trend-line display value.
Type: Color
Range: Hex Color Code
trendValueAlpha
Sets the transparency for the trend-line display value.
Default value: 100
Type: Number
Range: 0 - 100
trendValueBgAlpha
Sets the transparency for the background of the trend-line display value.
Default value: 100
Type: Number
Range: 0 - 100
trendValueBorderAlpha
Sets the transparency for the border around the trend-line display value.
Default value: 100
Type: Number
Range: 0 - 100
trendValueBorderPadding
Sets padding for the border around the trend-line display value.
Type: Number
Range: In pixels
trendValueBorderRadius
Sets the radius for the border around the trend-line display value.
Type: Number
Range: In pixels
trendValueBorderThickness
Sets the thickness for the border around the trend-line display value.
Type: Number
Range: In pixels
trendValueBorderDashed
Whether the border around the trend-line display value should be rendered as dashed lines.
Default value: 0 (border rendered using straight lines)
Type: Boolean
Range: 0/1
trendValueBorderDashLen
Sets the length of each dash when the border around the trend-line display value is rendered as dashed lines.
Type: Number
Range: In pixels
trendValueBorderDashGap
Sets the gap between two consecutive dashes when the border around the trend-line display value is rendered as dashed lines.
Type: Number
Range: In pixels
Vertical Trend-lines
Vertical trend lines help you create vertical trend-lines/zones on scatter (XY Plot) or Bubble charts. These are
vertical lines spanning the chart canvas which aid in interpretation of data with respect to some pre-determined
value. To add a vertical trend-line to a chart, the vTrendlines
and line
(child of the
vTrendlines
object) objects are used as shown below:
"vTRendlines"[{
"line": [{
"startValue": "20000",
"endValue": "3000",
"isTrendZone": "1",
"color": "#aaaaaa",
"alpha": "14"
}]
}]
You can control the cosmetic and functional properties of vertical trend-lines using the following attributes:
startValue
The starting value for the trendline. Say, if you want to plot a slanted trendline from value 102 to 109, the
startValue
will be 102.
Type: Number
Range: Numeric Value
endValue
The ending y-axis value for the trendline. Say, if you want to plot a slanted trendline from value 102 to
109, the endValue will be 109. If you do not specify a value for endValue
, it will
automatically assume the same value as startValue
.
Type: Number
Range: Numeric Value
displayValue
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
.
Type: String
Range:
color
Color of the trend line and its associated text
Type: String
Range: Hex Color Code
isTrendZone
Whether the trend will be displayed as a line or a zone (fill-colored rectangle).
Type: Boolean
Range: 0/1
thickness
If you've opted to show the trend as a line, this attribute lets you define the thickness of trend line.
Type: Number
Range: In Pixels
alpha
Alpha of the trend line.
Type: Number
Range: 0 - 100
dashed
Whether the trendline should be rendered as dashed lines.
Default value: 0 (trendline rendered using straight lines)
Type: Boolean
Range: 0/1
dashLen
Sets the width of each dash when trendline is rendered as dashed lines.
Type: Number
Range: In pixels
dashGap
Sets the gap between consecutive dashes when trendline is rendered as dashed lines.
Type: Number
Range: In pixels
toolText
Custom tool-text for this trendline/zone.
Type: String
Range: