Froala Editor v4.2.0 is Here LEARN MORE
Radar chart Attributes
FroalaCharts will render here
Functional Attributes
Chart Message-related
Attributes
Chart Titles and Axis Names
Chart Axis Configuration
Attributes
Chart Caption Cosmetics
Chart Cosmetics
Data Plot Cosmetics
Data Value Cosmetics
Anchors
Divisional Lines & Grids
Legend Properties
Number Formatting
Font Properties
Data Label Cosmetics
Tooltip Attributes
Toolbar Attributes
Attributes for Exporting Charts
Data Plot Hover Effects
Chart Padding & Margins
The categories Object
The category Object
The dataset Object
The data Object
Functional Attributes
animation
animationDuration
palette
paletteColors
showLabels
showValues
showLimits
showDivLineValues
labelStep
adjustDiv
showPrintMenuItem
unescapeLinks
showZeroPlaneValue
clickURL
clickURLOverridesPlotLinks
radarRadius
setAdaptiveYMin
hasRTLText
plotHighlightEffect
theme
These attributes let you control a variety of functional elements on the chart. For example, you can opt to show or hide data labels, data values. You can also set chart limits and extended properties.
animation
This attribute lets you set the configuration whether the chart should appear in an animated fashion. If you do not want to animate any part of the chart, set this as 0.
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
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 (that is, column, line, pie etc.).
Using paletteColors attribute, you can specify your custom list of hex colors for the data
items. The list of colors have to be separated by comma. For example, "paletteColors": "#FF0000,
#0372AB, #FF5904...". The chart will cycle through the list of specified colors and then render
the data plot accordingly. To use the same set of colors throughout all your charts in a web application,
you can store the list of palette colors in your application globally and then provide the same in each
chart JSON.
Type: String
Range: List of hex color codes separated by comma
showLabels
It sets the configuration whether the x-axis labels will be displayed or not.
Type: Boolean
Range: 0/1
showValues
Sets the configuration whether data values would 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 overrides this attribute.
Type: Boolean
Range: 0/1
showDivLineValues
Whether to show div line values. If not specified showYAxisValues overrides this attribute.
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
adjustDiv
The chart automatically tries to adjust divisional lines and limit values based on the data provided. However, if you want to set your explicit lower and upper limit values and number of divisional lines, first set this attribute to false. That would disable automatic adjustment of divisional lines.
Type: Boolean
Range: 0/1
showPrintMenuItem
When you right click on the chart it shows a context menu. This attribute allows you to show or hide the "Print" option in the context menu.
Type: Boolean
Range: 0/1
unescapeLinks
Internally the chart decodes a Url that you set as link. Before invoking the link it again encodes the Url.
If you are passing multilingual characters via a Url or do not want this decode-encode mechanism to be
handled by chart you can set,unescapeLinks='0'.
Type: Boolean
Range: 0/1
showZeroPlaneValue
Allows you to show or hide the value of the zero plane.
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
radarRadius
If you want to explicitly specify a radius for the radar chart, use this attribute. Otherwise, the chart will automatically calculate the best-fit radius.
Type: Number
Range: In Pixels
setAdaptiveYMin
This attribute lets you set whether the y-axis lower limit would be 0 (in case of all positive values on chart) or should the y-axis lower limit adapt itself to a different figure based on values provided to the chart.
Type: Boolean
Range: 0/1
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:
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 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.
caption
Caption of the chart.
Type: String
subCaption
Sub-caption of the chart.
Type: String
Chart Axis Configuration Attributes
showYAxisValues
yAxisValuesStep
yAxisMinValue
yAxisMaxValue
forceYAxisValueDecimals
yAxisValueDecimals
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.
showYAxisValues
The y-axis of the chart is divided into vertical sections using div (divisional) lines. Each div line assumes
a value based on its position. Using this attribute you can set whether to show those div line (y-axis)
values or not. The values of showLimits and showDivLineValues, if specified
explicitly, overrides the value of this attribute.
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
yAxisMinValue
This attribute helps you explicitly set the lower limit of the chart. If you do not specify this value, it is automatically calculated by the chart based on the data provided by you.
Type: Number
Range: Numeric Value
yAxisMaxValue
This attribute helps you explicitly set the upper limit of the chart. If you do not specify this value, it is automatically calculated by the chart based on the data provided by you.
Type: Number
Range: Numeric Value
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
yAxisValueDecimals
Specifies the decimal precision of yAxis values when adjustDiv is set to 0.
Type: Number
Range: 0-10
Chart Caption Cosmetics
captionAlignment
captionOnTop
captionFontSize
subCaptionFontSize
captionFont
subCaptionFont
captionFontColor
subCaptionFontColor
captionFontBold
subCaptionFontBold
alignCaptionWithCanvas
captionHorizontalPadding
These attributes let you configure the cosmetics of chart caption and sub-caption.
captionAlignment
Sets horizontal alignment of caption
Type: String
Range: "left", "center", "right"
captionOnTop
Whether caption should be on top of the data plot area
Type: Boolean
Range: 0/1
captionFontSize
Sets the caption font size in pixels
Type: Number
Range: 6 - 72
subCaptionFontSize
Sets the sub-caption font size (in pixels)
Type: Number
Range: 6 - 72
captionFont
Sets the caption font family
Type: String
Range: Font Name
subCaptionFont
Sets the sub-caption font family
Type: String
Range: Font Name
captionFontColor
Sets the caption font color
Type: Color
Range: Hex Color Code
subCaptionFontColor
Sets the sub-caption font color
Type: Color
Range: Hex Color Code
captionFontBold
Whether the caption font should be displayed in bold
Type: Boolean
Range: 0/1
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
captionHorizontalPadding
If caption is not centre aligned, lets you configure the padding (in pixels) from either edge. Will be ignored if caption is centre aligned.
Type: Number
Range: In Pixels
Chart Cosmetics
showBorder
borderColor
borderThickness
borderAlpha
bgColor
bgAlpha
bgRatio
bgAngle
bgImage
bgImageAlpha
bgImageDisplayMode
bgImageValign
bgImageHalign
bgImageScale
logoURL
logoLeftMargin
logoTopMargin
logoPosition
logoAlpha
logoScale
logoLink
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
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: left, center, right
bgImageHalign
Helps you to horizontally align the background image.
Type: String
Range: left, center, 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
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
Data Plot Cosmetics
showPlotBorder
plotBorderColor
plotBorderThickness
plotBorderAlpha
plotFillAlpha
plotFillColor
showRadarBorder
radarBorderColor
radarBorderThickness
radarBorderAlpha
radarFillColor
radarFillAlpha
radarSpikeColor
radarSpikeThickness
radarSpikeAlpha
These attributes let you configure how your plot (columns, lines, area, pie or any data that you are plotting) would appear on the chart. If the plots can show borders, you can control the border properties using the attributes listed below. Or, if they support gradient fills, you can again configure various properties of the gradient using these attributes. Various other controls over plot cosmetics can be attained using this set of attributes.
showPlotBorder
Whether the radar plot border would show up.
Type: Boolean
Range: 0/1
plotBorderColor
Color for radar plot border
Type: Color
Range: Hex Color Code
plotBorderThickness
Thickness for radar plot border
Type: Number
Range: 0-5
plotBorderAlpha
Alpha for radar plot border
Type: Number
Range: 0 - 100
plotFillAlpha
Lets you set the fill alpha for radar plot.
Type: Number
Range: 0 - 100
plotFillColor
Fill Color for the radar plot(hex code)
Type: Color
Range: Hex Color Code
showRadarBorder
Whether a border should be rendered around the radar chart.
Type: Boolean
Range: 0/1
radarBorderColor
Border color of radar outline.
Type: Color
Range: Hex Color Code
radarBorderThickness
Border thickness of radar outline.
Type: Number
Range: In Pixels
radarBorderAlpha
Border alpha of radar outline.
Type: Number
Range: 0 - 100
radarFillColor
Fill color for the radar.
Type: Color
Range: Hex Color Code
radarFillAlpha
Fill alpha for the radar.
Type: Number
Range: 0 - 100
radarSpikeColor
Color for radar spikes. Radar spikes are the lines that emanate from the center to the vertex of radar.
Type: Color
Range: Hex Color Code
radarSpikeThickness
Thickness for radar spikes. Radar spikes are the lines that emanate from the center to the vertex of radar.
Type: Number
Range: In Pixels
radarSpikeAlpha
Alpha for radar spikes. Radar spikes are the lines that emanate from the center to the vertex of radar.
Type: Number
Range: 0 - 100
Data Value Cosmetics
valueFont
valueFontColor
valueFontSize
valueFontBold
valueFontItalic
valueBgColor
valueBorderColor
valueAlpha
valueFontAlpha
valueBgAlpha
valueBorderAlpha
valueBorderThickness
valueBorderPadding
valueBorderRadius
valueBorderDashed
valueBorderDashLen
valueBorderDashGap
textOutline
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
Anchors
drawAnchors
anchorSides
anchorStartAngle
anchorRadius
anchorBorderColor
anchorBorderThickness
anchorBgColor
anchorAlpha
anchorBgAlpha
anchorImageUrl
anchorImageAlpha
anchorImageScale
anchorImagePadding
On radar charts, anchors (or marker points) are polygons which appear at the joint of two consecutive line or area points. These are indicators to show the position of data points. The anchors handle tool tips and links for the data points. So, if you opt to not render anchors on a chart, the tool tips and links won't function. You can, however, hide them by setting alpha to 0 and still enable tool tips and links. You can customize all the facets of anchors using the properties below.
drawAnchors
Whether to draw anchors on the chart.
Type: Boolean
Range: 0/1
anchorSides
This attribute sets the number of sides the anchor will have. For example, an anchor with 3 sides would represent a triangle, with 4 it would be a square and so on.
Type: Number
Range: 3-20
anchorStartAngle
This attribute sets the starting angle of anchors.
Default value: 90
Type: Number
Range: 0 - 360
anchorRadius
This attribute sets the radius (in pixels) of the anchor.
Type: Number
Range: In pixels
anchorBorderColor
Lets you set the border color of anchors.
Type: Color
Range: Hex Color Code
anchorBorderThickness
Helps you set border thickness of anchors.
Type: Number
Range: In Pixels
anchorBgColor
Helps you set the background color of anchors.
Type: Color
Range: Hex Color Code
anchorAlpha
Helps you set the alpha of entire anchors. If you need to hide the anchors on chart but still enable tool tips, set this as 0.
Type: Number
Range: 0 - 100
anchorBgAlpha
Helps you set the alpha of anchor background.
Type: Number
Range: 0 - 100
anchorImageUrl
If you want to use an external image (JPG/PNG) as an anchor, this attribute lets you specify the URL.
Note: Due to cross domain security restrictions it is advised to use an image from the same domain name as your charts.
Type: Froala Charts Link format
Range: URL
anchorImageAlpha
This attribute allows to set a transparency for images displayed as anchors in charts.
Default value: 100
Type: Number
Range: 0 - 100
anchorImageScale
This attribute allows to set a scale for magnifying images displayed as anchors.
Default value: 100
Type: Number
Range: 0 - 100
anchorImagePadding
This attribute sets the padding between the anchor image and the border of the anchor. For the anchor image, instead of decreasing the size of the image this attribute crops the image.
Default value: 1
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 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
Legend Properties
showLegend
legendItemFontBold
legendItemFont
legendItemFontSize
legendItemFontColor
legendItemHoverFontColor
legendPosition
legendXPosition
legendYPosition
legendNumRows
legendNumColumns
legendCaptionAlignment
legendCaptionFontBold
legendCaptionFont
legendCaptionFontSize
legendCaptionFontColor
legendCaption
legendItemHiddenColor
legendIconScale
legendBgColor
legendBgAlpha
legendBorderColor
legendBorderThickness
legendBorderAlpha
legendShadow
legendAllowDrag
legendScrollBgColor
reverseLegend
interactiveLegend
legendNumColumns
minimiseWrappingInLegend
drawCustomLegendIcon
legendIconBorderColor
legendIconBgColor
legendIconAlpha
legendIconBgAlpha
legendIconSides
legendIconBorderThickness
legendIconStartAngle
alignLegendWithCanvas
In radar charts, the series name of each data-set shows up in the legend of the chart. If you do not need the legend, you can opt to hide the same. Also, the legend can be placed at the bottom of the chart or to the right of the chart. Using the attributes below, you can configure the functional and cosmetic properties of the legend.
showLegend
Whether to show legend for 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 starting 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 have too many items on the legend, a scroll bar shows up on the same. This attribute lets you configure the background color of the scroll bar.
Type: Color
Range: Hex Color Code
reverseLegend
You can reverse the ordering of datasets in the legend by setting this attribute to 1.
Type: Boolean
Range: 0/1
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
formatNumber
formatNumberScale
defaultNumberScale
numberScaleUnit
numberScaleValue
forceNumberScale
scaleRecursively
maxScaleRecursion
scaleSeparator
numberPrefix
numberSuffix
decimalSeparator
thousandSeparator
thousandSeparatorPosition
inDecimalSeparator
inThousandSeparator
decimals
forceDecimals
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 would 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, for example, 40,000 if 'formatNumber': '1'; and 40000 if 'formatNumber': '0';.
Type: Boolean
Range: 0/1
formatNumberScale
Configuration whether to add K (thousands) and M (millions) to a number after truncating and rounding it -
for example, if formatNumberScale is set to 1, 1043 would become 1.04K (with decimals set to 2
places). Same with numbers in millions - an M will be added at the end.
Type: Boolean
Range: 0/1
defaultNumberScale
The default unit of the numbers that you're providing to the chart.
Type: String
Range:
numberScaleUnit
Unit of each block of the scale.
Type: String
Range:
numberScaleValue
Range of the various blocks that constitute the scale.
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
maxScaleRecursion
How many recursions to complete during recursive scaling? -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:
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.
Type: String
Range: Character
numberSuffix
Using this attribute, you could add 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.
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, the chart accepts the input decimal and thousand separator from user, so that it can convert it accordingly into the required format. This attribute lets you input the decimal separator.
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, the chart accepts the input decimal and thousand separator from user, so that it can convert it accordingly into the required format. This attribute lets you input the thousand separator.
Type: String
Range: Character
decimals
Number of decimal places to which all numbers on the chart would be rounded to.
Type: Number
Range: 0-10
forceDecimals
Whether to add 0 padding at the end of decimal numbers. For example, if you set decimals as 2 and a number is
23.4. If forceDecimals is set to 1, the number will automatically be converted to 23.40 (note
the extra 0 at the end).
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 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, that is, all the values and the names in the chart which lie on the canvas will be displayed using the font size provided here.
Type: Number
Range: 6 - 72
baseFontColor
This attribute sets the base font color of the chart, that is, all the values and the names in the chart which lie on the canvas will be displayed using the font color provided here.
Type: Color
Range: Hex Color Code
outCnvBaseFont
This attribute sets the base font family of the chart text which lies outside the canvas, that is, all the values and the names in the chart which lie outside the canvas will be displayed using the font name provided here.
Type: String
Range: Font Name
outCnvBaseFontSize
This attribute sets the base font size of the chart, that is, all the values and the names in the chart which lie outside the canvas will be displayed using the font size provided here.
Type: Number
Range: 6 - 72
outCnvBaseFontColor
This attribute sets the base font color of the chart, that is, all the values and the names in the chart which lie outside the canvas will be displayed using the font color provided here.
Type: Color
Range: Hex Color Code
Data Label Cosmetics
labelFont
labelFontColor
labelFontSize
labelFontBold
labelFontItalic
labelBgColor
labelBorderColor
labelAlpha
labelBgAlpha
labelBorderAlpha
labelBorderPadding
labelBorderRadius
labelBorderThickness
labelBorderDashed
labelBorderDashLen
labelBorderDashGap
labelLink
These attributes let you configure the cosmetics of all data labels of the chart.
labelFont
Sets the x-axis label font family for the text.
Type: String
Range: Font Name
labelFontColor
Sets the x-axis label font color.
Type: Color
Range: Hex Color Code
labelFontSize
Specifies the x-axis label font size.
Type: Number
Range: 6 - 72
labelFontBold
Flag indicating whether x-axis label font should be bold or not.
Type: Boolean
Range: 0/1
labelFontItalic
Flag indicating whether x-axis label font should be italicized or not.
Type: Boolean
Range: 0/1
labelBgColor
Sets the background color for x-axis label text.
Type: Color
Range: Hex Color Code
labelBorderColor
Sets the color of the border around the x-axis label text.
Type: Color
Range: Hex Color Code
labelAlpha
Sets the x-axis label alpha for both font and background.
Type: Number
Range: 0 - 100
labelBgAlpha
Sets the x-axis label background alpha.
Type: Number
Range: 0 - 100
labelBorderAlpha
Sets the x-axis label border alpha.
Type: Number
Range: 0 - 100
labelBorderPadding
Sets the x-axis label border padding.
Type: Number
Range: In Pixels
labelBorderRadius
Sets the x-axis label border radius.
Type: Number
Range: In Pixels
labelBorderThickness
Sets the x-axis label border thickness.
Type: Number
Range: In Pixels
labelBorderDashed
Whether the border around x-axis labels should be rendered using dashed lines.
Default value: 0 (border rendered using straight lines)
Type: Boolean
Range: 0/1
labelBorderDashLen
Sets the length of each dash when the border around the x-axis labels are rendered using dashed lines.
Type: Number
Range: In pixels
labelBorderDashGap
Sets the gap between two consecutive dashes when the border around x-axis labels are rendered using dashed lines.
Type: Number
Range: In pixels
labelLink
Sets a link for every data plot labels.
Type: URL
Range:
Tooltip Attributes
showToolTip
toolTipBgColor
toolTipColor
toolTipBorderColor
tooltipBorderAlpha
toolTipSepChar
seriesNameInToolTip
showToolTipShadow
plottooltext
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 Multi-series 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 would 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
toolbarPosition
toolbarX
toolbarY
toolbarHAlign
toolbarVAlign
toolbarButtonColor
showToolBarButtonTooltext
toolbarButtonScale
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
exportEnabled
exportAction
exportHandler
exportFormats
exportMode
exportShowMenuItem
exportTargetWindow
exportFileName
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.
Default value: auto.
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.
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
showHoverEffect
anchorHoverEffect
anchorHoverAlpha
anchorHoverSides
anchorHoverRadius
anchorBgHoverColor
anchorBgHoverAlpha
anchorBorderHoverColor
anchorBorderHoverAlpha
anchorBorderHoverThickness
anchorHoverStartAngle
anchorHoverDip
anchorHoverAnimation
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
anchorHoverEffect
Sets whether to enable the hover effect on charts for anchors.
Type: Boolean
Range: 0/1
anchorHoverAlpha
This attribute specifies the transparency for the anchors when hovered.
Type: Number
Range: 0 - 100
anchorHoverSides
This attribute sets the number of sides of the anchor when hovered.
Type: Number
Range: In Pixels
anchorHoverRadius
This attribute sets the radius of the anchor when hovered.
Type: Number
Range: In pixels
anchorBgHoverColor
This attribute sets the background color of anchor when hovered.
Type: Color
Range: Hex color code
anchorBgHoverAlpha
This attribute sets the transparency of anchor’s background when hovered.
Type: Number
Range: 0 - 100
anchorBorderHoverColor
Sets the border color of anchors when hovered.
Type: Color
Range: Hex color code
anchorBorderHoverAlpha
Sets the border's transparency of anchors when hovered.
Type: Number
Range: 0 - 100
anchorBorderHoverThickness
This attribute sets the border thickness of the anchors when hovered.
Type: Number
Range: In pixels
anchorHoverStartAngle
This attribute sets the starting angle of the anchors when hovered.
Type: Number
Range: In pixels
anchorHoverDip
This attribute adds a dip effect (different shapes) to the anchors on hover. When hovered a star shaped
anchor is created. Using anchorSides attribute, you can specify the no. of sides for anchors.
Note : If the anchors are of circular shape, this attribute won't be applied on it.
Type: Number
Range: 0 - 1
anchorHoverAnimation
Anchors get animated when the normal radius and the hover radius are different. To disable this effect you
can set anchorHoverAnimation = 0.
Default value: 1
Type: Boolean
Range: 0/1
Chart Padding & Margins
captionPadding
labelPadding
chartLeftMargin
chartRightMargin
chartTopMargin
chartBottomMargin
legendPadding
The following attributes help you control chart margins and paddings. Froala Charts allows you manually customize
the padding of various elements on the chart to allow advanced manipulation and control over chart
visualization. Padding in Froala Charts is always defined in pixels, unless the attribute itself suggests some
other scale (like plotSpacePercent, which configures the spacing using percentage values). You can
also define the chart margins. Chart Margins refer to the empty space left on the top, bottom, left and right of
the chart. That means, Froala Charts would not plot anything in that space. It is 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.
captionPadding
This attribute lets you control the space (in pixels) between the sub-caption and top of the chart canvas. If the sub-caption is not defined, it controls the space between caption and top of chart canvas. If neither caption, nor sub-caption is defined, this padding does not come into play.
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 or bottom side of canvas
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:
The category Object
label
showLabel
toolText
font
fontColor
fontSize
fontBold
fontItalic
bgColor
borderColor
alpha
bgAlpha
borderAlpha
borderPadding
borderRadius
borderThickness
borderDashed
borderDashLen
borderDashGap
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:
showLabel
You can individually opt to show or hide labels of individual data items using this attribute.
Type: Boolean
Range: 0/1
toolText
The tooltip defined in the category object appears only when the mouse cursor is hovered over
the data plots. However, this will not appear when the cursor is moved over the data labels (except for a
situation when long labels are automatically truncated with ellipses. In this situation, if the mouse cursor
is hovered over a truncated label, the tooltip will appear with the full label). In case you want to set a
short label and show the full label in tooltip, define the full label using this attribute within the
category object. The tooltip with the full label will appear only when the mouse is hovered on
the dataplot.
Type: String
Range:
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
seriesName
color
alpha
showValues
valueFontColor
valueBgColor
valueBorderColor
includeInLegend
showPlotBorder
plotBorderColor
plotBorderThickness
plotBorderAlpha
drawAnchors
anchorSides
anchorStartAngle
anchorRadius
anchorBorderColor
anchorBorderThickness
anchorBgColor
anchorAlpha
anchorBgAlpha
anchorHoverColor
anchorHoverAlpha
anchorHoverSides
anchorBgHoverColor
anchorBgHoverAlpha
anchorBorderHoverColor
anchorBorderHoverAlpha
anchorBorderHoverThickness
anchorHoverStartAngle
anchorHoverDip
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 data-set. For example, if you are plotting a chart to
indicate monthly sales analysis for 2005 and 2006, the seriesName for the first dataset would
be 2005 and that of the second would be 2006. The seriesName of a data-set is shown in legend.
Type: String
Range:
color
This attribute sets the color using which columns, lines, area of that data-set would be drawn. For column chart, you can specify a list of comma separated hex codes to get a gradient plot
Type: Color
Range: Hex Color Code
alpha
This attribute sets the alpha (transparency) of the entire data-set.
Type: String
Range: 0 - 100 or Comma Separated List
showValues
Whether to show the values for this data-set.
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 data-set in legend. This can be particularly useful
when you are using combination charts and you have used the area or line chart to plot a trend, and you do
not want the seriesName of that trend to appear in legend.
Type: Boolean
Range: 0/1
showPlotBorder
Whether to show the border of this data-set.
Type: Boolean
Range: 0/1
plotBorderColor
Color for data plot border of this data-set.
Type: Color
Range: Hex Color Code
plotBorderThickness
Thickness for data plot border of this data-set.
Type: Number
Range: 0-5
plotBorderAlpha
Alpha for data plot border of this data-set.
Type: Number
Range: 0 - 100
drawAnchors
Whether to draw anchors for a particular dataset.
Type: Boolean
Range: 0/1
anchorSides
Sets the number of sides that the anchors of the particular data-set will have. For example, an anchor with 3 sides would represent a triangle, with 4 it would be a square and so on.
Type: Number
Range: 3-20
anchorStartAngle
This attribute sets the starting angle for anchors of particular dataset.
Default value: 90
Type: Number
Range: 0 - 360
anchorRadius
This attribute sets the radius (in pixels) of the anchors of the particular data-set.
Type: Number
Range: In Pixels
anchorBorderColor
Lets you set the border color of anchors of the particular data-set.
Type: Color
Range: Hex Color Code
anchorBorderThickness
Helps you set border thickness of anchors of the particular data-set.
Type: Number
Range: In Pixels
anchorBgColor
Helps you set the background color of anchors of the particular data-set.
Type: Color
Range: Hex Color Code
anchorAlpha
Helps you set the alpha of entire anchors of the particular data-set. If you need to hide the anchors for the data-set but still enable tool tips, set this as 0.
Type: Number
Range: 0 - 100
anchorBgAlpha
Helps you set the alpha of anchor background of the particular data-set.
Type: Number
Range: 0 - 100
anchorHoverColor
This attribute can set the hover color for anchors of a particular dataset.
Type: Color
Range: Hex Color Code
anchorHoverAlpha
This attribute sets the transparency for anchors of a particular dataset when hovered.
Type: Number
Range: 0 - 100
anchorHoverSides
This attribute sets the number of sides for anchors of a particular dataset when hovered.
Type: Number
Range: In Pixels
anchorBgHoverColor
This attribute sets the background color for anchors of a particular dataset when hovered.
Type: Color
Range: Hex color code
anchorBgHoverAlpha
This attribute sets the transparency for anchor's background of a particular dataset when hovered.
Type: Number
Range: 0 - 100
anchorBorderHoverColor
Sets the border color for anchors of a particular dataset when hovered.
Type: Color
Range: Hex color code
anchorBorderHoverAlpha
Sets the border's transparency for anchors of a particular dataset when hovered.
Type: Number
Range: 0 - 100
anchorBorderHoverThickness
This attribute sets the border thickness for anchors of a particular dataset when hovered.
Type: Number
Range: In pixels
anchorHoverStartAngle
This attribute sets the starting angle for anchors of a particular dataset when hovered.
Type: Number
Range: In pixels
anchorHoverDip
This attribute adds a dip effect (different shapes) for anchors of a particular dataset on hover. When
hovered a star shaped anchor is created. Using anchorSides attribute, you can specify the no.
of sides for anchors.
Note : If the anchors are of circular shape, this attribute won't be applied on it.
Type: Number
Range: 0 - 1
The data Object
value
color
displayValue
link
toolText
showValue
valueFontColor
valueBgColor
valueBorderColor
alpha
anchorSides
anchorStartAngle
anchorRadius
anchorBorderColor
anchorBorderThickness
anchorBgColor
anchorAlpha
anchorBgAlpha
anchorHoverColor
anchorHoverAlpha
anchorHoverSides
anchorBgHoverColor
anchorBgHoverAlpha
anchorBorderHoverColor
anchorBorderHoverAlpha
anchorBorderHoverThickness
anchorHoverStartAngle
anchorHoverDip
Attributes of the data object, child of the dataset object, are used to define the
values to be plotted for individual data series.
The dataset and data objects are defined for one data series as shown in the example
below:
"dataset": [{
"seriesname": "Previous Year",
"data": [{
"value": "10000",
},
{
"value": "11500",
},
{
"value": "12500",
},
{
"value": "15000"
}]
}]
value
Numerical value for the data item. This value would be plotted on the chart.
Type: Number
Range:
color
For Multi-series charts, you can define the color of data-sets at dataset level. However, if you wish to highlight a particular data element, you can specify its color at "set" level using this attribute.
Type: Color
Range: Hex Color Code
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:
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 Advanced Charting > Drill Down Charts for more information. Also, you'll need to URL Encode all the special characters (like ? and &) present in the link.
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 or hide values of individual data items using this attribute. This value over-rides the data-set 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 charts, you can define the alpha of data-sets at dataset level. However, if you wish to highlight a particular data element, you can specify it's alpha at "set" level using this attribute.
Type: Number
Range: 0 - 100
anchorSides
Lets you specify "set" specific sides of the anchor.
Type: Number
Range: 3-20
anchorStartAngle
This attribute sets the starting angle for an anchor of a particular data.
Default value: 90
Type: Number
Range: 0 - 360
anchorRadius
Lets you specify "set" specific radius (in pixels) of the anchor.
Type: Number
Range: In Pixels
anchorBorderColor
Lets you specify "set" specific border color of the anchor.
Type: Color
Range: Hex Color Code
anchorBorderThickness
Lets you specify "set" specific border thickness of the anchor.
Type: Number
Range: In Pixels
anchorBgColor
Lets you specify "set" specific background color of the anchor.
Type: Color
Range: Hex Color Code
anchorAlpha
Lets you specify "set" specific alpha of the anchor.
Type: Number
Range: 0 - 100
anchorBgAlpha
Lets you specify "set" specific alpha of the anchor background.
Type: Number
Range: 0 - 100
anchorHoverColor
This attribute can set the hover color for a particular anchor.
Type: Color
Range: Hex Color Code
anchorHoverAlpha
This attribute sets the transparency for an anchor when hovered.
Type: Number
Range: 0 - 100
anchorHoverSides
This attribute sets the number of sides for a particular anchor when hovered.
Type: Number
Range: In Pixels
anchorBgHoverColor
This attribute sets the background color of a particular anchor when hovered.
Type: Color
Range: Hex color code
anchorBgHoverAlpha
This attribute sets the transparency for a particular anchor’s background when hovered.
Type: Number
Range: 0 - 100
anchorBorderHoverColor
Sets the border color of an anchor when hovered.
Type: Color
Range: Hex color code
anchorBorderHoverAlpha
Sets the border's transparency of an anchor when hovered.
Type: Number
Range: 0 - 100
anchorBorderHoverThickness
This attribute sets the border thickness of an anchor when hovered.
Type: Number
Range: In pixels
anchorHoverStartAngle
This attribute sets the starting angle of an anchor when hovered.
Type: Number
Range: In pixels
anchorHoverDip
This attribute adds a dip effect (different shapes) to a particular anchor on hover. When hovered a star
shaped anchor is created. Using anchorSides attribute, you can specify the no. of sides for
anchors.
Note : If the anchors are of circular shape, this attribute won't be applied on it.
Type: Number
Range: 0 - 1