Skip to content

Pie Chart Attributes

FroalaCharts will render here

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

animateClockwise


Animates the plot in clockwise direction.

Default value: 0

Type: Boolean

Range: 0/1

alphaAnimation


Instead of rotational animation, you can set alpha animation which displays your chart slowly from 0 alpha to 100. Default value : 0

Type: Boolean

Range: 0/1

palette


Froala Charts uses 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

showZeroPies


Configuration whether to show pies with 0 values (and their values). Otherwise, they won't show up in the chart.

Type: Boolean

Range: 0/1

showPercentValues


Whether to show percentage values in labels of the chart.

Type: Boolean

Range: 0/1

showPercentInToolTip


Whether to show percentage values in tool tip.

Type: Boolean

Range: 0/1

showLabels


Whether to show labels on the chart.

Type: Boolean

Range: 0/1

showValues


Whether to show values on the chart.

Type: Boolean

Range: 0/1

labelSepChar


The character to separate the data label and data values on the chart.

Type: String

Range: Character

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:

useDataPlotColorForLabels


Uses the same data plot color for data labels.

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:

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

baseChartMessageFont baseChartMessageFontSize baseChartMessageColor baseChartMessageImageHAlign baseChartMessageImageVAlign baseChartMessageImageAlpha baseChartMessageImageScale loadMessage loadMessageFont loadMessageFontSize loadMessageColor loadMessageImageHAlign loadMessageImageVAlign loadMessageImageAlpha loadMessageImageScale typeNotSupportedMessage typeNotSupportedMessageFont typeNotSupportedMessageFontSize typeNotSupportedMessageColor typeNotSupportedMessageImageHAlign typeNotSupportedMessageImageVAlign typeNotSupportedMessageImageAlpha typeNotSupportedMessageImageScale renderErrorMessage renderErrorMessageFont renderErrorMessageFontSize renderErrorMessageColor renderErrorMessageImageHAlign renderErrorMessageImageVAlign renderErrorMessageImageAlpha renderErrorMessageImageScale dataLoadStartMessage dataLoadStartMessageFont dataLoadStartMessageFontSize dataLoadStartMessageColor dataLoadStartMessageImageHAlign dataLoadStartMessageImageVAlign dataLoadStartMessageImageAlpha dataLoadStartMessageImageScale dataEmptyMessage dataEmptyMessageFont dataEmptyMessageFontSize dataEmptyMessageColor dataEmptyMessageImageHAlign dataEmptyMessageImageVAlign dataEmptyMessageImageAlpha dataEmptyMessageImageScale dataLoadErrorMessage dataLoadErrorMessageFont dataLoadErrorMessageFontSize dataLoadErrorMessageColor dataLoadErrorMessageImageHAlign dataLoadErrorMessageImageVAlign dataLoadErrorMessageImageAlpha dataLoadErrorMessageImageScale dataInvalidMessage dataInvalidMessageFont dataInvalidMessageFontSize dataInvalidMessageColor dataInvalidMessageImageHAlign dataInvalidMessageImageVAlign dataInvalidMessageImageAlpha dataInvalidMessageImageScale

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


Using these attributes, you can set the various headings and titles of chart like caption and sub-caption.

caption


Caption of the chart.

Type: String

subCaption


Sub-caption of the chart.

Type: String

Chart Caption Cosmetics


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


The following attributes let you configure chart cosmetics like background color, background 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

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

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


This attribute lets you set the fill alpha for plot.

Type: Number

Range: 0 - 100

showShadow


Whether to apply the shadow effect for pie/doughnuts.

Type: Boolean

Range: 0/1

use3DLighting


Whether to use advanced gradients and shadow effects to create better looking 3D charts.

Note: This attribute is not supported in IE8

Type: Boolean

Range: 0/1

Pie / Doughnut Properties


The following attributes let you control various functionalities of pie/doughnut chart.

radius3D


You can define the 3D Radius of chart in percentage using this attribute. It basically helps you set the bevel distance for the pie/doughnut (if in 3D Lighting Mode).

Type: Number

Range: 0-100

pieRadius


This attribute lets you explicitly set the outer radius of the chart. Froala Charts automatically calculates the best fit pie radius for the chart. This attribute is useful if you want to enforce one of your own values. , you can specify the radius of a pie chart in both percentage and pixel values.

Type: Number

Range: In Pixels & Percentage

startingAngle


By default, the pie chart starts from angle 0 degree i.e., the first pie slice starts plotting from 0 degree angle. If you want to change the starting angle of the chart, use this attribute. It obeys the conventions of co-ordinate geometry where 0 degrees means hand of a clock at 3. Starting angle Increases anti-clockwise.

Type: Number

Range: 0-360

enableSlicing


This attribute specifies whether slicing of the data plots should be enabled for pie/doughnut charts. Setting this attribute to 1 will enable slicing for the chart, setting it to 0 will disable slicing.

Default value: 1

Type: Boolean

Range: 0/1

slicingDistance


If you've opted to slice a particular pie/doughnut slice, using this attribute you can control the distance between the slice and the center of chart.

Type: Number

Range: In Pixels

enableRotation


The pie charts have three modes: Slicing, Rotation, and Link. By default, a chart starts in Slicing mode. If you need to enable rotation from XML, set this attribute to 1. But, when links are defined, the chart always works in Link mode irrespective of the value of this attribute.

Type: Boolean

Range: 0/1

enableMultiSlicing


This attribute specifes whether single-slicing for the data plots should be enabled for pie/doughnut charts. Setting this attribute to 0 will enable single-slicing for the chart, setting it to 1 will enable multi-slicing.

Default value: 1

Type: Boolean

Range: 0/1

Smart Labels & Lines


In Froala Charts, the pie and doughnut charts can now have smart labels and lines. Smart labels/lines are data connector lines which connect the pie/doughnut slices to their respective labels without over-lapping even in cases where there are lots of labels located near each other. You can configure the smart labels/lines properties using the attributes below.

enableSmartLabels


Whether to use smart labels or not.

Type: Boolean

Range: 0/1

skipOverlapLabels


Whether to skip labels that are overlapping even when using smart labels. If not, they might overlap if there are too many labels.

Type: Boolean

Range: 0/1

isSmartLineSlanted


The smart lines (smart label connector lines) can appear in two ways: Slanted or Straight. This attribute lets you choose between them.

Type: Boolean

Range: 0/1

smartLineColor


Color of smart label connector lines.

Type: Color

Range: Hex Color Code

smartLineThickness


Thickness of smart label connector lines.

Type: Number

Range: In Pixels

smartLineAlpha


Alpha of smart label connector lines.

Type: Number

Range: 0 - 100

labelDistance


This attribute helps you set the distance of the label/value text boxes from the pie/doughnut edge. This attribute will work only when the attribute enableSmartLabels is set to '0'.

Type: Number

Range: In Pixels

manageLabelOverflow


This attribute tries to manage overflow of data labels. If enabled, data labels are either wrapped or truncated with ellipses to prevent them from overflowing out of the chart canvas. In case smartLabels is disabled, the labels are wrapped to avoid the overflow. Since smartLabels is disabled, the wrapped labels might get overlapped. When smartLabels is enabled, management of the overflowing labels fit in the "quadrant specific smart labeling algorithm". Data labels try to wrap first. In case, there is a space constraint in the quadrant, the labels get truncated with ellipses.

Type: Boolean

Range: 0/1

useEllipsesWhenOverflow


When enabled, long data labels are truncated by adding ellipses to prevent them from overflowing the chart background. The default value is 1. This setting works only when manageLabelOverflow is set to 1.

Type: Boolean

Range: 0/1

labelPosition


This attribute places the data labels outside/inside of the pie slices.

Default value: Outside

Type: String

Range: Outside, Inside

valuePosition


This attribute places the data values outside/inside of the pie slices.

Default value: Outside

Type: String

Range: Outside, Inside

minAngleForLabel


Set the minimum angle for a pie slice, above which the data labels will be visible, provided labelPosition is set to inside.

Default value: 0

Type: Number

Range: 0 - 360

minAngleForValue


Set the minimum angle for a pie slice, above which the data values will be visible, provided valuePosition is set to inside.

Default value: 0

Type: Number

Range: 0 - 360

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

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.

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

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 set decimals as 2 and a number is 23.4. If forceDecimals is set to 1, Froala Charts will convert the number 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'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.

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

Data Label Cosmetics


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

Legend Properties


In pie / doughnut charts, the name of each slice 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 the legend icon. The default scale value is 1. Anything less than 1 reduces the size of the legend-icons on the chart. Any value bigger than 1 enlarges the icons. e.g., 0.5 means half the size, where as, 2 means twice the size.

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

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 particular legend key, the associated slice slides out from the chart. Re-clicking the key causes the slice to slide in.

Type: Boolean

Range: 0/1

legendNumColumns


The legend items are arranged in columns. Using this attribute, you can propose the number of columns. This value undergoes internal checking on judicious use of white-space. In case, the value is found improper, the chart auto-calculates the number of columns. When set to 0, the chart automatically decides the number of columns. The above is applicable when legendPosition is set to BOTTOM. If you have set RIGHT legendPosition, the number of columns is always set to 1.

Type: Number

Range: Zero and Positive Integers

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

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:

showToolTipShadow


Whether to show shadow for tool-tips on the chart.

Type: Boolean

Range: 0/1

tooltipbgalpha


Sets the transparency of the tooltip.

Type: Number

Range: 0 - 100

tooltipborderradius


Sets the border radius of the tooltip.

Type: Number

Range: In Pixels

tooltipborderthickness


Sets the border thickness of the tooltip.

Type: Number

Range: In Pixels

toolTipPadding


This attribute sets the vertical space between the value and the border of the tooltip. If you want more space between the value and the border, you can use this attribute to control it.

Type: Number

Range: In Pixels

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.

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


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

plotBorderHoverColor


This attribute sets the border color of the plot when hovered.

Type: Color

Range: Hex color code

plotBorderHoverAlpha


This attribute sets the transparency of plot border when hovered.

Type: Number

Range: 0 - 100

plotBorderHoverThickness


Sets the thickness of the border of plot when hovered.

Type: Number

Range: In pixels

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.

captionPadding


This attribute lets you control the space (in pixels) between the sub-caption and top of the pie. If the sub-caption is not defined, it controls the space between caption and top of the pie. If neither caption, nor sub-caption is defined, this padding does not come into play.

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

The data Object


In single-series charts, each instance of the data object represents a data value to be plotted on the chart. For a single-series chart, one instance of the data object looks as shown in the example below:


"data"[{
		"label": "Jan",
		"value": "10000"
	}]
Attributes of the data object are used to set and configure the data values for the chart.

alpha


This attribute determines the transparency of a data item. The range for this attribute is 0 to 100. 0 means complete transparency (the data item wont be shown on the graph) and 100 means opaque.

Type: Number

Range: 0 - 100

borderAlpha


If you want to set border alpha of individual pie/doughnut data items, you can specify using this attribute.

Type: Color

Range: Hex Color Code

borderColor


If you want to set border color of individual pie/doughnut data items, you can specify using this attribute.

Type: Color

Range: Hex Color Code

color


If you want to define your own colors for the data items on chart, use this attribute to specify color for the data item.

Type: Color

Range: Hex Color Code

dashed


Whether the border of this data item should appear as dashed. This is particularly useful when you want to highlight a data (such as forecast or trend etc.).

Type: Boolean

Range: 0/1

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:  

isSliced


This attribute determines whether a pie slice appears as a part of the total chart or is sliced out as an individual item.

Type: Boolean

Range: 0/1

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/hide labels of individual data items using this attribute.

Type: Boolean

Range: 0/1

showValue


You can individually opt to show/hide values of individual data items using this attribute.

Type: Boolean

Range: 0/1

labelPosition


This attribute places the data label outside/inside of a particular pie slice.

Default value: Outside

Type: String

Range: Outside, Inside

valuePosition


This attribute places the data value outside/inside of a particular pie slice.

Default value: Outside

Type: String

Range: Outside, Inside

toolText


By default, Froala Charts shows the data item name and value as tool tip text for that data item. But, if you want to display more information for the data item as tool tip, you can use this attribute to specify the same.

Type: String

Range:

value


Numerical value for the data item. This value will be plotted on the chart.

Type: Number

Range:

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 label is rendered using dashed lines.

Type: Number

Range: In pixels

labelBorderDashGap


Sets the gap between two consecutive dashes when the border around x-axis label is rendered using dashed lines.

Type: Number

Range: In pixels

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

borderHoverColor


This attribute sets the border color of a data plot on hover.

Type: Color

Range: Hex Color Code

borderHoverAlpha


This attribute sets the border's transparency for a data plot on hover.

Type: Number

Range: 0 - 100

borderHoverThickness


This attribute sets the thickness for a data plot's border on hover.

Type: Number

Range: In pixels