Skip to content

Line 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. You can also set chart limits and extended properties.

animation


This attribute gives you the option to control animation in your charts. If you do not want to animate any part of the chart, set this as 0.

Type: Boolean

Range: 0/1

animationDuration


This attribute sets the animation duration of the chart. animationDuration attribute is applicable only if animation of the chart is enabled.

Default value: 1 sec

Type: Number

Range: In seconds

palette


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

connectNullData


This attribute lets you control whether empty data sets in your data will be connected to each other OR do they appear as broken data sets.

Type: Boolean

Range: 0/1

showLabels


It sets the configuration whether the x-axis labels will be displayed or not.

Type: Boolean

Range: 0/1

maxLabelHeight


This attribute can be used to set the maximum height for the x-axis labels (data labels) excluding the x-axis title. If any label goes beyond this height, the label will be truncated. In stagger mode, the number of stagger lines will be reduced if they exceed this value.

Type: Number

Range: In Pixels

labelDisplay


Using this attribute, you can customize the alignment of data labels (x-axis labels). There are 5 options: AUTO, WRAP, STAGGER, ROTATE or NONE. By default, this attribute is set to AUTO mode which means that the alignment of the data labels is determined automatically depending on the size of the chart. WRAP wraps the label text if it is too long to fit in one line. ROTATE rotates the labels vertically. STAGGER divides the labels into multiple lines.

Type: String

Range: 'AUTO', 'WRAP', 'STAGGER', 'ROTATE', 'NONE'

useEllipsesWhenOverflow


When enabled in auto mode, long data labels are truncated by adding ellipses to prevent them from overflowing the chart background. The default value is 1.

Type: Boolean

Range: 0/1

rotateLabels


This attribute lets you set whether the data labels will show up as rotated labels on the chart.

Type: Boolean

Range: 0/1

slantLabels


If you've opted to show rotated labels on chart, this attribute lets you set the configuration whether the labels will show as slanted labels or fully vertical ones.

Type: Boolean

Range: 0/1

labelStep


By default, all the labels are displayed on the chart. However, if you've a set of streaming data (like name of months or days of week), you can opt to show every n-th label for better clarity. This attribute just lets you do so. When a value greater than 1 (n) is set to this attribute, the first label from left and every label at the n-th position from left will be displayed. e.g., a chart showing data for 12 months and set with labelStep: 3 will show labels for January, April, July, and October. The rest of the labels will be skipped.

Type: Number

Range: 1 or above

staggerLines


If you've opted for STAGGER mode as labelDisplay, using this attribute you can control how many lines to stagger the label to. By default, all labels are displayed in a single line.

Type: Number

Range: 2 or above

showValues


Sets the configuration whether data values will be displayed along with the data plot on chart.

Type: Boolean

Range: 0/1

valuePosition


If you've opted to show data values on the chart, this attribute lets you adjust the vertical alignment of data values with respect to dataplots. By default, this attribute is set to AUTO mode in which the alignment of each data value is determined automatically based on the position of each plot point. In ABOVE mode, data values are displayed above the plot points unless a plot point is too close to the upper edge of the canvas while in BELOW mode, data values are displayed below the plot points unless a plot point is too close to the lower edge of the canvas.

Type: String

Range: "ABOVE", "BELOW", "AUTO"

rotateValues


If you've opted to show data values, you can rotate them using this attribute.

Type: Boolean

Range: 0/1

showLimits


Whether to show chart limit values.If not specified showYAxisValues attribute overrides this value.

Type: Boolean

Range: 0/1

showDivLineValues


Whether to show div line values. If not specified showYAxisValues attribute overrides this value.

Type: Boolean

Range: 0/1

showShadow


Whether to apply the shadow effects for data plot.

Type: Boolean

Range: 0/1

adjustDiv


Froala Charts automatically tries to adjust divisional lines and limit values based on the data provided. However, if you want to set your explicit lower and upper limit values and number of divisional lines, first set this attribute to false. That will disable automatic adjustment of divisional lines.

Type: Boolean

Range: 0/1

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:

setAdaptiveYMin


This attribute lets you set whether the y-axis lower limit will be 0 (in case of all positive values on chart) or should the y-axis lower limit adapt itself to a different figure based on values provided to the chart.

Type: Boolean

Range: 0/1

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

plotBinSize


This attribute is used to skip the data plot without any change in visualization. When set to 1, minimum one data plot will be rendered within the width of one pixel. Example, if plotBinSize: 1, minimum one column plot will be rendered within the width of one pixel. For line and area charts, minimum of two anchors connecting one single line will be drawn. If plotBinSize: 0.5, minimum two column plot will be rendered within the width of one pixel. Data skipping can be disabled by setting this attribute to 0.

Default value: 0.5

Type: Number

Range: In Pixels

labelBinSize


This attribute is used to skip the labels of the data plots. When set to 1, minimum one label will be displayed within the width of one pixel. To disable this label skipping, set this attribute to 0.

Default value: 1

Type: Number

Range: In Pixels

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

xAxisName


X-axis title of the chart.

Type: String

yAxisName


Y-axis title of the chart.

Type: String

Chart Caption Cosmetics


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

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 Axis Configuration Attributes


Using these attributes, you can set and configure x-axis labels, y-axis values and set chart cosmetics for the axis like color, alpha, etc.

transposeAxis


If you hide a dataset using legend icon, this attribute (when set to 1) will compute the axes limit with respect to maximum and minimum value of the visible dataset(s).

Default value: 0

Type: Boolean

Range: 0/1

showaxislines


Sets whether to display the x-axis and y-axis lines.

Type: Boolean

Range: 0/1

showXAxisLine


This attribute if set to _0_, hides the x-axis of the chart.

Default value: 1

Type: Boolean

Range: 0/1

xAxisPosition


This attribute sets the position of the x-axis in the chart.

Default value: Bottom

Type: String

Range: Top, Bottom

yAxisPosition


This attribute sets the position of the y-axis in the chart.

Default value: Left

Type: String

Range: Left, Right

xAxisLineColor


Sets color of the x-axis of the chart.

Type: Color

Range: Hex Color Code

xAxisLineThickness


Sets the thickness of the x-axis line of the chart.

Type: Number

Range: In Pixels

showYAxisLine


This attribute if set to _0_, hides the y-axis of the chart.

Default value: 1

Type: Boolean

Range: 0/1

yAxisLineColor


Sets color of the y-axis of the chart.

Type: Color

Range: Hex Color Code

yAxisLineThickness


Sets the thickness of the y-axis line of the chart.

Type: Number

Range: In Pixels

showYAxisValues


Froala Charts y-axis is divided into vertical sections using div (divisional) lines. Each div line assumes a value based on its position. Using this attribute you can set whether to show those div line (y-axis) values or not. This attribute shows or hides the y-axis divisional lines and limits. The values of showLimits and showDivLineValues, if specified explicitly, overrides the value of this attribute.

Type: Boolean

Range: 0/1

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

rotateYAxisName


If you do not wish to rotate y-axis name, set this as 0. It specifically comes to use when you've the special characters (UTF-8) in your y-axis name that do not show up in rotated mode.

Type: Boolean

Range: 0/1

yAxisNameWidth


If you opt to not rotate y-axis name, you can choose a maximum width that will be applied to y-axis name.

Type: Number

Range: (In Pixels)

yAxisMinValue


This attribute helps you explicitly set the lower limit of the chart. If you don't specify this value, it is automatically calculated by Froala Charts based on the data provided by you.

Type: Number

Range: Numeric Value

yAxisMaxValue


This attribute helps you explicitly set the upper limit of the chart. If you don't specify this value, it is automatically calculated by Froala Charts based on the data provided by you.

Type: Number

Range: Numeric Value

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

x-Axis Name Cosmetics


To configure the font cosmetics of x-axis name (title), you can use the following attributes.

xAxisNameFont


Sets the x-axis font family for the text

Type: String

Range: Font Name

xAxisNameFontColor


Sets the x-axis font color

Type: Color

Range: Hex Color Code

xAxisNameFontSize


Specifies the x-axis font size

Type: Number

Range: 6 - 72

xAxisNameFontBold


Whether x-axis font should be bold

Type: Boolean

Range: 0/1

xAxisNameFontItalic


Whether x-axis font should be italicized

Type: Boolean

Range: 0/1

xAxisNameBgColor


Sets the background color for x-axis text

Type: Color

Range: Hex Color Code

xAxisNameBorderColor


Sets the border around the x-axis text

Type: Color

Range: Hex Color Code

xAxisNameAlpha


Sets the x-axis alpha including font and background

Type: Number

Range: 0 - 100

xAxisNameFontAlpha


Sets the x-axis font alpha

Type: Number

Range: 0 - 100

xAxisNameBgAlpha


Sets the x-axis background alpha

Type: Number

Range: 0 - 100

xAxisNameBorderAlpha


Sets the x-axis border alpha

Type: Number

Range: 0 - 100

xAxisNameBorderPadding


Sets the x-axis border padding

Type: Number

Range: In Pixels

xAxisNameBorderRadius


Sets the x-axis border radius

Type: Number

Range: In Pixels

xAxisNameBorderThickness


Sets the x-axis border thickness

Type: Number

Range: In Pixels

xAxisNameBorderDashed


Whether the border around the x-axis name should be rendered using dashed lines.

Default value: 0 (border rendered using straight lines)

Type: Boolean

Range: 0/1

xAxisNameBorderDashLen


Sets the length of each dash when the border around the x-axis name is rendered using dashed lines.

Type: Number

Range: In pixels

xAxisNameBorderDashGap


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

Type: Number

Range: In pixels

y-Axis Name Cosmetics


To configure the font cosmetics of y-axis name (title), you can use the following attributes.

yAxisNameFont


Sets the y-axis (primary / secondary) font family for the text

Type: String

Range: Font Name

yAxisNameFontColor


Sets the y-axis (primary / secondary) font color

Type: Color

Range: Hex Color Code

yAxisNameFontSize


Specifies the y-axis (primary / secondary) font size

Type: Number

Range: 6 - 72

yAxisNameFontBold


Whether y-axis (primary / secondary) font should be bold

Type: Boolean

Range: 0/1

yAxisNameFontItalic


Whether y-axis (primary / secondary) font should be italicized

Type: Boolean

Range: 0/1

yAxisNameBgColor


Sets the background color for y-axis (primary / secondary) text

Type: Color

Range: Hex Color Code

yAxisNameBorderColor


Sets the border around the y-axis (primary / secondary) text

Type: Color

Range: Hex Color Code

yAxisNameAlpha


Sets the y-axis (primary / secondary) alpha including font and background

Type: Number

Range: 0 - 100

yAxisNameFontAlpha


Sets the y-axis (primary / secondary) font alpha

Type: Number

Range: 0 - 100

yAxisNameBgAlpha


Sets the y-axis (primary / secondary) background alpha

Type: Number

Range: 0 - 100

yAxisNameBorderAlpha


Sets the y-axis (primary / secondary) border alpha

Type: Number

Range: 0 - 100

yAxisNameBorderPadding


Sets the y-axis (primary / secondary) border padding

Type: Number

Range: In Pixels

yAxisNameBorderRadius


Sets the y-axis (primary / secondary) border radius

Type: Number

Range: In Pixels

yAxisNameBorderThickness


Sets the y-axis (primary / secondary) border thickness

Type: Number

Range: In Pixels

yAxisNameBorderDashed


Whether the border around the y-axis name should be rendered using dashed lines.

Default value: 0 (border rendered using straight lines)

Type: Boolean

Range: 0/1

yAxisNameBorderDashLen


Sets the length of each dash when the border around the y-axis name is rendered using dashed lines.

Type: Number

Range: In pixels

yAxisNameBorderDashGap


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

Type: Number

Range: In pixels

Chart Cosmetics


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

showBorder


Whether to show a border around the chart or not.

Type: Boolean

Range: 0/1

borderColor


Border color of the chart.

Type: Color

Range: Hex Color Code

borderThickness


Border thickness of the chart.

Type: Number

Range: In Pixels

borderAlpha


Border alpha of the chart.

Type: Number

Range: 0 - 100

bgColor


This attribute sets the background color for the chart. You can set any hex color code as the value of this attribute. To specify a gradient as background color, separate the hex color codes of each color in the gradient using comma. Example: #FF5904, #FFFFFF.

Type: Color

Range: Hex Color Code

bgAlpha


Sets the alpha (transparency) for the background. If you've opted for gradient background, you need to set a list of alpha(s) separated by comma.

Type: Number

Range: 0 - 100

bgRatio


If you've opted for a gradient background, this attribute lets you set the ratio of each color constituent.

Type: Number

Range: 0 - 100

bgAngle


Sets the angle of the background color, in case of a gradient.

Type: Number

Range: 0-360

bgImage


To place any image (JPG/PNG/GIF) as background of the chart, enter the (path and) name of the background image. It should be in the same domain as the chart.

Type: String

Range:

bgImageAlpha


This attribute specifies the opacity for the loaded background image.

Type: Number

Range: 0 - 100

bgImageDisplayMode


Helps you specify the mode in which the background image is to be displayed. Stretch - expands the image to fit the entire chart area, without maintaining original image constraints. Tile - the image is repeated as a pattern on the entire chart area. Fit - fits the image proportionately on the chart area. Fill -proportionately fills the entire chart area with the image. Center - the image is positioned at the center of the chart area. None - Default mode.

Type: String

Range: stretch, tile, fit, fill, center, none

bgImageVAlign


Helps you to vertically align the background image.

Type: String

Range: top, middle, bottom

bgImageHAlign


Helps you to horizontally align the background image.

Type: String

Range: left, middle, right

bgImageScale


Helps you magnify the background image.This attribute will only work when the attribute bgImageDisplayMode is set to none, center, or tile.

Type: Number

Range: 0-300

showcanvasborder


This attribute if set to _1_, shows a border around the canvas of the chart.

Default value: 0

Type: Boolean

Range: 0/1

canvasBgColor


This attribute sets the background color for the chart canvas. You can set any hex color code as the value of this attribute. To specify a gradient as canvas background color, separate the hex color codes of each color in the gradient using comma. Example: #FF5904, #FFFFFF.

Type: Color

Range: Hex Color Code

canvasBgAlpha


This attribute sets the background transparency for the chart canvas. For gradient, separate the alpha value using comma. Example: 15, 50.

Type: Number

Range: 0 - 100

canvasBgRatio


When a gradient is used to set the color of the canvas background, this attribute sets the ratio of the colors. Example : If the value of the canvasBgColor attribute is set as #FF5904, #FFFFFF, canvasBgRatio can be used to specify their ratio in the background.

Type: Numbers separated by comma

Range: 0 - 100

canvasBgAngle


Helps you specify canvas background angle in case of gradient.

Type: Number

Range: 0-360

canvasBorderColor


Lets you specify canvas border color.

Type: Color

Range: Hex Color Code

canvasBorderThickness


Lets you specify canvas border thickness.

Type: Number

Range: 0-5

canvasBorderAlpha


Lets you control transparency of canvas border.

Type: Number

Range: 0 - 100

showVLineLabelBorder


If you've opted to show a label for any of your vLines in the chart, you can collectively configure whether to show border for all such labels using this attribute. If you want to show label border for just a particular vLine, you can over-ride this value by specifying border configuration for that specific vLine.

Type: Boolean

Range: 0/1

rotateVLineLabels


This attribute lets you set whether the vline labels will show up as rotated labels on the chart.

Default value: 0

Type: Boolean

Range: 0/1

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.

lineColor


Color using which the lines on the chart will be drawn.

Type: Color

Range: Hex Color Code

lineThickness


Thickness of the lines on the chart.

Type: Number

Range: In Pixels

lineAlpha


Alpha of the lines on the chart.

Type: Number

Range: 0 - 100

lineDashed


Whether the lines should be rendered as dashed lines.

Default value: 0 (lines rendered using straight lines)

Type: Boolean

Range: 0/1

lineDashLen


Sets the length of each dash when lines are rendered as dashed lines.

Type: Number

Range: In pixels

lineDashGap


Sets the gap between consecutive dashes when lines are rendered as dashed lines.

Type: Number

Range: In pixels

Data Value Cosmetics


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

valueFont


Sets the font of the values in the chart

Type: String

Range: Font Name

valueFontColor


Specifies the value font color

Type: Color

Range: Hex Color Code

valueFontSize


Specifies the value font size

Type: Number

Range: 6 - 72

valueFontBold


Whether value font should be bold

Type: Boolean

Range: 0/1

valueFontItalic


Whether value font should be italicized

Type: Boolean

Range: 0/1

valueBgColor


Sets the background color for value text

Type: Color

Range: Hex Color Code

valueBorderColor


Sets the border color around the value text

Type: Color

Range: Hex Color Code

valueAlpha


Sets the value alpha including font and background

Type: Number

Range: 0 - 100

valueFontAlpha


Sets the value font alpha

Type: Number

Range: 0 - 100

valueBgAlpha


Sets the value background alpha

Type: Number

Range: 0 - 100

valueBorderAlpha


Sets the value border alpha

Type: Number

Range: 0 - 100

valueBorderThickness


Sets the value border thickness

Type: Number

Range: In Pixels

valueBorderPadding


Sets the padding between the value and its surrounding border

Type: Number

Range: In Pixels

valueBorderRadius


Sets the value border radius

Type: Number

Range: In Pixels

valueBorderDashed


Whether the border around the data values should be rendered using dashed lines.

Default value: 0 (border rendered using straight lines)

Type: Boolean

Range: 0/1

valueBorderDashLen


Sets the length of each dash when the border around the data values is rendered using dashed lines.

Type: Number

Range: In pixels

valueBorderDashGap


Sets the gap between two consecutive dashes when the border around the data values is rendered using dashed lines.

Type: Number

Range: In pixels

textOutline


Set this attribute to 1 to draw a border on the data value text.

Default value: 0

Type: Boolean

Range: 0/1

Y-Axis Value Cosmetics


These attributes let you configure font, background and border cosmetics, of the Y-axis value text.

yAxisValueFont


Set the font family for the Y-axis value texts.

Default value: verdana,sans

Type: String

Range: Font Name

yAxisValueFontColor


Sets the font color for the Y-axis value texts.

Default value: #555555

Type: Color

Range: Hex Color Code

yAxisValueFontSize


Sets the font size for the Y-axis value texts.

Default value: 10 px

Type: Number

Range: 6 - 72

yAxisValueFontBold


Displays the Y-axis value texts in bold.

Default value: 0

Type: Boolean

Range: 0/1

yAxisValueFontItalic


Displays the Y-axis value texts in italic.

Default value: 0

Type: Boolean

Range: 0/1

yAxisValueBgColor


Sets the background color for the Y-axis values.

Type: Color

Range: Hex Color Code

yAxisValueBorderColor


Sets the border color for the Y-axis values.

Type: Color

Range: Hex Color Code

yAxisValueAlpha


Sets the transparency for the Y-axis values between transparent (for 0) and opaque (for 100).

Default value: 100

Type: Number

Range: 0 - 100

yAxisValueBgAlpha


Sets the transparency for the Y-axis value backgrounds between transparent (for 0) and opaque (for 100).

Type: Number

Range: 0 - 100

yAxisValueBorderAlpha


Sets the transparency for the Y-axis values between transparent (for 0) and opaque (for 100).

Type: Number

Range: 0 - 100

yAxisValueBorderPadding


Sets the border padding for the Y-axis values.

Type: Number

Range: In Pixels

yAxisValueBorderRadius


Sets the border radius for the Y-axis values.

Type: Number

Range: In Pixels

yAxisValueBorderThickness


Sets the border thickness for the Y-axis values.

Type: Number

Range: In Pixels

yAxisValueBorderDashed


Makes the Y-axis value borders dashed.

Default value: 0 (border rendered using straight lines)

Type: Boolean

Range: 0/1

yAxisValueBorderDashLen


Sets the lengths of the individual dashes when the Y-axis value borders are dashed.

Type: Number

Range: In pixels

yAxisValueBorderDashGap


Sets the gaps between individual dashes when the Y-axis value borders are dashed.

Type: Number

Range: In pixels

Anchors


On line/area charts, anchors (or marker points) are polygons which appear at the joint of two consecutive line/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 e.g., an anchor with 3 sides will represent a triangle, with 4 it will 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/3D plane that signifies the 0 position on the chart. If there are no negative numbers on the chart, you won't see a visible zero plane. Alternate color bands are colored blocks between two successive divisional lines.

numVDivLines


Number of vertical axis division lines

Type: Number

Range: Numeric value > 0

vDivLineColor


Color of vertical axis division lines.

Type: Color

Range: Hex Color Code

vDivLineThickness


Thickness of vertical axis division lines.

Type: Number

Range: In Pixels

vDivLineAlpha


Alpha of vertical axis division lines.

Type: Number

Range: 0 - 100

vDivLineDashed


Whether the vertical divisional lines should be rendered as dashed lines.

Default value: 0 (vertical divisional lines using straight lines)

Type: Boolean

Range: 0/1

vDivLineDashLen


Sets the width of each dash when vertical divisional lines are rendered as dashed lines.

Type: Number

Range: In pixels

vDivLineDashGap


Sets the gap between two consecutive dashes when vertical divisional lines are rendered as dashed lines.

Type: Number

Range: In pixels

showAlternateVGridColor


Whether to show alternate vertical colored grid bands.

Type: Boolean

Range: 0/1

alternateVGridColor


Color of alternate vertical colored grid bands.

Type: Color

Range: Hex Color Code

alternateVGridAlpha


Alpha of alternate vertical colored grid bands.

Type: Number

Range: 0 - 100

numDivLines


Number of horizontal axis division lines that you want on the chart.

Type: Number

Range: Numeric value > 0

divLineColor


Color for divisional lines.

Type: Color

Range: Hex Color Code

divLineThickness


Thickness of divisional lines.

Type: Number

Range: 1-5

divLineAlpha


Alpha of divisional lines.

Type: Number

Range: 0 - 100

divLineDashed


Whether the divisional lines should be rendered as dashed lines.

Default value: 0 (divisional lines rendered using straight lines)

Type: Boolean

Range: 0/1

divLineDashLen


Sets the length of each dash when divisional lines are rendered as dashed lines.

Type: Number

Range: In pixels

divLineDashGap


Sets the gap between two consecutive dashes when divisional lines are rendered as dashed lines.

Type: Number

Range: In pixels

zeroPlaneColor


Color for the Zero Plane. Zero Plane is the line/plane that appears at position 0 on the y-axis, when negative data is being shown on the chart.

Type: Color

Range: Hex Color Code

zeroPlaneThickness


Thickness of zero plane.

Type: Number

Range: In Pixels

zeroPlaneAlpha


Alpha of zero plane.

Type: Number

Range: 0 - 100

showZeroPlaneValue


Allows you to show or hide the value on which the zero plane exists on the y-axis. By default, the value is displayed.

Type: Boolean

Range: 0/1

showAlternateHGridColor


Whether to show alternate colored horizontal grid bands.

Type: Boolean

Range: 0/1

alternateHGridColor


Color of the alternate horizontal grid bands.

Type: Color

Range: Hex Color Code

alternateHGridAlpha


Alpha (transparency) of the alternate horizontal grid bands.

Type: Number

Range: 0 - 100

showZeroPlane


Whether to show the zero plane on chart (if negative values are present).

Type: Boolean

Range: 0/1

Legend Properties


In multi-series charts, the series name of each dataset shows up in the legend of the chart. If you do not need the legend, you can opt to hide the same. Also, the legend can be placed at the bottom of the chart or to the right of the chart. Using the attributes below, you can configure the functional and cosmetic properties of the legend.

showLegend


Whether to show legend on the chart.

Type: Boolean

Range: 0/1

legendItemFontBold


Whether legend keys should be displayed in bold

Type: Boolean

Range: 0/1

legendItemFont


Sets legend item font

Type: String

Range: Font Name

legendItemFontSize


Sets legend item font size

Type: Number

Range: 6 - 72

legendItemFontColor


Sets legend item font color

Type: Color

Range: Hex Color Code

legendCaption


You can add a caption for the entire legend by setting the same here.

Type: String

Range:  

legendItemHoverFontColor


Sets legend item font color on hover

Type: Color

Range: Hex Color Code

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

legendIconScale


Scaling of legend icon is possible in Froala Charts. This attribute lets you control the size of legend icon.

Type: Number

Range: 1-5

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

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:

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 legend key, the dataplots associated with that series are eliminated from the chart. Re-clicking the key causes the dataplots to reappear.

Type: Boolean

Range: 0/1

legendNumColumns


If your chart contains multiple series, the legend is displayed as a grid comprising of multiple legend keys. With the help of this attribute you can specify the number of columns that are to be displayed in the legend.

Type: Number

Range: Positive Integer

minimiseWrappingInLegend


Whether to minimize legend item text wrapping.

Type: Boolean

Range: 0/1

drawCustomLegendIcon


Specifies whether drawing a custom legend icon will be enabled. All legend icon customization attributes will work only if this feature is enabled.

Default value: 0 (disabled)

Type: Boolean

Range: 0/1

legendIconBorderColor


Sets the border color for the legend icon.

Default value: Data plot border color

Type: Color

Range: Hex Color Code

legendIconBgColor


Sets the background color for the legend icon.

Default value: Data plot fill color

Type: Color

Range: Hex Color Code

legendIconAlpha


Sets the legend icon transparency.

Default value: 100

Type: Number

Range: 0 - 100

legendIconBgAlpha


Sets the legend icon background transparency.

Default value: 100

Type: Number

Range: 0 - 100

legendIconSides


Sets the number of sides for the legend icon.

Default value: 4

Type: Number

Range:

legendIconBorderThickness


Sets the thickness of the legend icon border.

Default value: 1

Type: Number

Range: 1-5

legendIconStartAngle


Sets the starting angle of for drawing the legend icon.

Default value: 45

Type: Number

Range:

alignLegendWithCanvas


This attribute if set to 0, the legend box will be center aligned with respect to the entire width of the chart only if the total width of the legend box is more than the canvas width. By default, the legend box is center aligned with respect to the canvas width and it remains the same if the width of the legend box is less than the canvas width.

Type: Boolean

Range: 0/1

Number Formatting


Froala Charts offers you a lot of options to format your numbers on the chart. Using the attributes below, you can control a myriad of options like: Formatting of commas and decimals Number prefixes and suffixes Decimal places to which the numbers will round to Scaling of numbers based on a user defined scale Custom number input formats

formatNumber


This configuration determines whether the numbers displayed on the chart will be formatted using commas, e.g., 40,000 if 'formatNumber': '1'; and 40000 if 'formatNumber': '0';.

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 limit the maximum number of decimal digits to 2, a number like 55.345 will be rounded to 55.34. This does not mean that all numbers will be displayed with a fixed number of decimal places. For instance 55 will not be displayed as 55.00 and 55.1 will not become 55.10. In order to have fixed number of decimal places attached to all the numbers, set this attribute to 1.

Type: Boolean

Range: 0/1

Font Properties


Using the attributes below, you can define the generic font properties for all the text on the chart. These attributes allow you a high level control over font properties. If you intend to specify font properties for individual chart elements (like Caption, sub-caption etc.), you'll need to use the Styles feature of Froala Charts. Using Styles, you can also specify advanced font properties like Bold, Italics, HTML Mode etc.

baseFont


This attribute lets you set the font face (family) of all the text (data labels, values etc.) on chart. If you specify the outCnvBaseFont attribute also, then this attribute controls only the font face of text within the chart canvas bounds.

Type: String

Range: Font Name

baseFontSize


This attribute sets the base font size of the chart i.e., all the values and the names in the chart which lie on the canvas will be displayed using the font size provided here.

Type: Number

Range: 6 - 72

baseFontColor


This attribute sets the base font color of the chart i.e., all the values and the names in the chart which lie on the canvas will be displayed using the font color provided here.

Type: Color

Range: Hex Color Code

outCnvBaseFont


This attribute sets the base font family of the chart text which lies outside the canvas i.e., all the values and the names in the chart which lie outside the canvas will be displayed using the font name provided here.

Type: String

Range: Font Name

outCnvBaseFontSize


This attribute sets the base font size of the chart i.e., all the values and the names in the chart which lie outside the canvas will be displayed using the font size provided here.

Type: Number

Range: 6 - 72

outCnvBaseFontColor


This attribute sets the base font color of the chart i.e., all the values and the names in the chart which lie outside the canvas will be displayed using the font color provided here.

Type: Color

Range: Hex Color Code

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

Cross Line Attributes


Using these attributes, you can set and configure cross line and set its cosmetics like color, alpha, etc.

drawCrossLine


This attribute sets a cross line (vertical line/area), when you hover a data plot.

Default value: 0

Type: Boolean

Range: 0/1

crossLineColor


This attribute sets the color of the cross line.

Default value: #EEEEEE

Type: Color

Range: Hex Color Code

crossLineAlpha


This attribute sets the opacity of the cross line.

Default value: 50

Type: Number

Range: 0 - 100

crossLineAnimation


This attributes enables the animation for the cross line.

Default value: 0

Type: Boolean

Range: 0/1

crossLineAnimationDuration


This attribute sets the animation duration of the cross line.

Default value: 0.09 seconds

Type: Number

Range: In seconds

plotColorinTooltip


This attribute displays the color of each plot with their labels in tooltip.

Default value: 1

Type: Boolean

Range: 0/1

tooltipGrayoutColor


This attribute sets the color of the unfocused plot in the tooltip for multi-series chart. By default it is set as gray.

Default value: #AAAAAA

Type: Color

Range: Hex Color Code

drawCrossLineOnTop


This attribute is used to determine if the cross line will be drawn above the data plot or below the data plot.

Default value: 0

Type: Boolean

Range: 0/1

Tool-tip


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 will show up in tool tip or not.

Type: Boolean

Range: 0/1

showToolTipShadow


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

Type: Boolean

Range: 0/1

plottooltext


Specify custom text for the tooltip You can either specify a constant string as the tooltip text or you can use variable values from the data level by prefixing a $ to the attribute name, for example, $name, $value.

Type: String

Range:

Toolbar Attributes


Using this set of attributes, you can customize the toolbar on the chart. The advantage of having a toolbar is that it manages all the UI action elements (context menus, checkboxes, buttons) centrally. This provides a clean, uniform look and a better, more meaningful and logical grouping.

toolbarPosition


Where to position the toolbar on the chart: TL - Top-left TR - Top-right BR - Bottom right BL - Bottom left CC - Center of screen

Type: String

Range: TL, TR, BL, BR, CC

toolbarX


Sets the toolbox position on the chart with respect to x-axis.

Type: Number

Range:

toolbarY


Sets the toolbox position on the chart with respect to y-axis.

Type: Number

Range:

toolbarHAlign


Sets the horizontal alignment of the toolbar on the chart.

Type: String

Range: Left, Right

toolbarVAlign


Sets the vertical alignment of the toolbar on the chart

Type: String

Range: Top, Bottom

toolbarButtonColor


Sets the color of the toolbar buttons.

Type: Color

Range: Any (color code without the # prefix)

showToolBarButtonTooltext


Enables/disables display of tooltips for toolbar buttons.

Type: Boolean

Range: 0/1

toolbarButtonScale


You can change the scale of the toolbar by specifying a value for this attribute.

Type: Number

Range:

Attributes for Exporting Charts


These attributes allow you to control the saving of chart as image, SVG or XLSX.

exportEnabled


Whether the chart will allow exporting to images, PDFs, SVG, XLSX or CSV format.

Default value: 0

Type: Boolean

Range: 0/1

exportAction


In case of server-side exporting, the action specifies whether the exported image will be sent back to client as download, or whether it'll be saved on the server.

Default value: download

Type: String

Range: 'save' or 'download'

exportHandler


In case of server side exporting, this refers to the path of the server-side export handler (the ready-to-use scripts that we provide).

Type: String

Range:

exportFormats


Lets you configure what output formats to allow for export of chart, in the export context menu, and also customize the label for each menu item. The attribute value should be a pipe (|) delimited separated key-value pair. Example: exportFormats: 'PNG=Export as High Quality Image|JPG|PDF=Export as PDF File'

Type: String

Range:

exportMode


This attributes sets the modes of export. To enable client-side exporting, set this attribute to client.

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

anchorHoverEffect


Sets whether to enable the hover effect on charts for anchors.

Type: Boolean

Range: 0/1

anchorHoverColor


This attribute sets the hover color for anchors.

Type: Color

Range: Hex Color Code

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


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

xAxisNamePadding


Using this, you can set the distance between the top end of x-axis title and the bottom end of data labels (or canvas, if data labels are not to be shown).

Type: Number

Range: In Pixels

yAxisNamePadding


Using this, you can set the distance between the right end of y-axis title and the start of y-axis values (or canvas, if the y-axis values are not to be shown).

Type: Number

Range: In Pixels

yAxisValuesPadding


This attribute helps you set the horizontal space between the canvas left edge and the y-axis values or trend line values (on left/right side). This is particularly useful, when you want more space between your canvas and y-axis values.

Type: Number

Range: In Pixels

labelPadding


This attribute sets the vertical space between the labels and canvas bottom edge. If you want more space between the canvas and the x-axis labels, you can use this attribute to control it.

Type: Number

Range: In Pixels

valuePadding


It sets the vertical space between the end of columns and start of value textboxes. This basically helps you control the space you want between your columns/anchors and the value textboxes.

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

canvasPadding


Lets you set the space between the canvas border and first & last data points

Type: Number

Range: In Pixels

canvasLeftPadding


This attribute lets you set the space between the left of the canvas border and the canvas of the chart. This attribute is particularly useful when your data plot gets clipped by the left border of the canvas. Using this attribute, you can control the amount of empty space between the chart left side and data plot which might get clipped.

Type: Number

Range: In Pixels

canvasRightPadding


This attribute lets you set the space between the right of the canvas border and the canvas of the chart. This attribute is particularly useful when your data plot gets clipped by the right border of the canvas. Using this attribute, you can control the amount of empty space between the chart right side and data plot which might get clipped.

Type: Number

Range: In Pixels

canvasTopPadding


This attribute lets you set the space between the top of the canvas border and the canvas of the chart. This attribute is particularly useful when your data plot gets clipped by the top border of the canvas. Using this attribute, you can control the amount of empty space between the chart's top and data plot which might get clipped.

Type: Number

Range: In Pixels

canvasBottomPadding


This attribute lets you set the space between the bottom of the canvas border and the canvas of the chart. This attribute is particularly useful when your data plot gets clipped by the bottom border of the canvas. Using this attribute, you can control the amount of empty space between the chart's bottom and data plot which might get clipped.

Type: Number

Range: In Pixels

legendPadding


Padding of legend from right/bottom side of canvas

Type: Number

Range: In Pixels

canvasLeftMargin


This attribute lets you control the space between the start of chart canvas and the start (x) of chart. In case of 2D charts, the canvas is the visible rectangular box. In case of 3D charts, the canvas box is the imaginary box around the 3D canvas. Using this attribute, you can control the amount of empty space between the chart left side and canvas left side. By default, Froala Charts automatically calculates this space depending on the elements to be placed on the chart. However, if you want to over-ride this value with a higher value, you can use this attribute to specify the same. Please note that you cannot specify a margin lower than what has been calculated by the chart. This attribute is particularly useful, when you've multiple charts placed in a page and want all their canvas start position to align with each other - so in such a case, you can set same margin value (a value large enough that it doesn't get rejected by chart owing to it being lower than the calculated value) for all such charts in the page.

Type: Number

Range: In Pixels

canvasRightMargin


Like canvasLeftMargin, this attribute lets you set the space between end of canvas and end of chart.

Type: Number

Range: In Pixels

canvasTopMargin


Like canvasLeftMargin, this attribute lets you set the space between top of canvas and top of chart.

Type: Number

Range: In Pixels

canvasBottomMargin


Like canvasLeftMargin, this attribute lets you set the space between bottom of canvas and bottom of chart.

Type: Number

Range: In Pixels

The categories Object


The categories object and the category object (child of the categories object) are used to specify x-axis labels for multi-series charts. The attributes of the categories object are used to set the font properties of all x-axis labels collectively.

font


Lets you specify font face for the x-axis data labels.

Type: String

Range: Valid font face

fontColor


Lets you specify font color for the x-axis data labels.

Type: Color

Range: Hex Color Code

fontSize


Lets you specify font size for the x-axis data labels.

Type: Number

Range:

The category Object


The attributes of the category object are used to define and customize individual x-axis labels for multi-series charts.

label


This attribute determines the label for the data item. The label appears on the x-axis of chart.

Note: The label attribute replaces the name attribute. Previously, either one of the attributes could be used to set the label. Support for the name attribute has been discontinued.

Type: String

Range:

showLabel


You can individually opt to show/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

Vertical Data Separator Lines


Vertical data separator lines help you separate data blocks. These lines run through the height of the chart, thereby segregating the data into two different blocks. Vertical lines are defined as shown in the example below:


"categories": [{
	"category": [{
			"label": "Grade 1",
		},
		{
			"vLine": "true ",
			"label": "Appraisal"
		}]
	}]
You can configure the cosmetics of vertical separator lines using the following attributes:

vLine


Set this attribute to true to render a vertical data separator line.

Type: String

Range:

color


This attribute defines the color of vertical separator line

Type: Color

Range: Hex Color Code

thickness


Thickness in pixels of the vertical separator line.

Type: Number

Range: In Pixels

alpha


Alpha of the vertical separator line.

Type: Number

Range: 0 - 100

dashed


Whether the vertical separator line should be rendered as dashed lines.

Default value: 0 (vertical separator line rendered using straight lines)

Type: Boolean

Range: 0/1

dashLen


Sets the width of each dash when vertical separator line is rendered as dashed lines.

Type: Number

Range: In pixels

dashGap


Sets the gap between consecutive dashes when vertical separator line is rendered as dashed lines.

Type: Number

Range: In pixels

label


Label for the vertical separator line, if to be shown.

Note: The label attribute replaces the name attribute. Previously, either one of the attributes could be used to set the label. Support for the name attribute has been discontinued.

Type: String

Range:  

showLabelBorder


Whether to show a border around the vLine label.

Type: Boolean

Range: 0/1

linePosition


Helps configure the position of vertical line i.e., if a vLine is to be plotted between 2 points Jan and Feb, user can set any position between 0 and 1 to indicate the relative position of vLine between these two points (0 means Jan and 1 means Feb). By default, it’s 0.5 to show in between the points.

Type: Number

Range: 0-1

labelPosition


Helps configure the position of the vLine label by setting a relative position between 0 and 1. In vertical charts, 0 means top of canvas and 1 means bottom. In horizontal charts, 0 means left of canvas and 1 means right.

Type: Number

Range: 0-1

labelHAlign


Horizontal anchor point for the alignment of vLine label.

Type: String

Range: left, center, right

labelVAlign


Vertical anchor point for the alignment of vLine label.

Type: String

Range: top, middle, bottom

The dataset Object


Each dataset object contains a series of data. For example, for a monthly sales comparison chart for two successive years, the first data-set would contain the data for first year and the next one for the second year. You can provide data-set level cosmetics so that all data within that data-set will be plotted in the same color/alpha/etc. Depending on the chart type, there are a number of attributes that you can define for each dataset object.

alpha


This attribute sets the alpha (transparency) of the entire dataset.

Type: String

Range: 0 - 100 or Comma Separated List

anchorAlpha


Helps you set the alpha of entire anchors of the particular dataset. If you need to hide the anchors for the dataset 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 dataset.

Type: Number

Range: 0 - 100

anchorBgColor


Helps you set the background color of anchors of the particular dataset.

Type: Color

Range: Hex Color Code

anchorBorderColor


Lets you set the border color of anchors of the particular dataset.

Type: Color

Range: Hex Color Code

anchorBorderThickness


Helps you set border thickness of anchors of the particular dataset.

Type: Number

Range: In Pixels

anchorRadius


This attribute sets the radius (in pixels) of the anchors of the particular dataset.

Type: Number

Range: In Pixels

anchorSides


Sets the number of sides that the anchors of the particular dataset will have. For e.g., an anchor with 3 sides will represent a triangle, with 4 it will 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

color


This attribute sets the color using which columns, lines, area of that dataset will be drawn. For column chart, you can specify a list of comma separated hex codes to get a gradient plot

Type: Color

Range: Hex Color Code

dashed


Whether this dataset will appear as dashed.

Type: Boolean

Range: 0/1

drawAnchors


Whether to draw anchors for a particular dataset.

Type: Boolean

Range: 0/1

includeInLegend


Whether to include the seriesName of this dataset in legend.

Type: Boolean

Range: 0/1

lineDashLen


Sets the length of each dash when lines for a data-set is rendered as dashed lines.

Type: Number

Range: In pixels

lineDashGap


Sets the gap between consecutive dashes when lines for a data-set is rendered as dashed lines.

Type: Number

Range: In pixels

lineThickness


Thickness of the lines for the particular dataset.

Type: Number

Range: In Pixels

seriesName


Lets you specify the series name for a particular dataset. For example, if you're plotting a chart to indicate monthly sales analysis for 2005 and 2006, the seriesName for the first dataset will be 2005 and that of the second will be 2006. The seriesName of a dataset is shown in legend.

Type: String

Range:

showValues


Whether to show the values for this dataset.

Type: Boolean

Range: 0/1

valueFontColor


Specifies the font color of data values for a particular dataset.

Type: Color

Range: Hex Color Code

valueBgColor


Sets the background color of value text for a particular dataset.

Type: Color

Range: Hex Color Code

valueBorderColor


Sets the border color around the value text for a particular dataset.

Type: Color

Range: Hex Color Code

valuePosition


This attribute lets you adjust the vertical alignment of data values for all dataplots in the dataset. The alignment is set with respect to the position of the dataplots on the chart. By default, the attribute is set to AUTO mode in which the alignment of each data value is determined automatically based on the position of each plot point. In ABOVE mode, data values are displayed above the plot points unless a plot point is too close to the upper edge of the canvas. While in BELOW mode, data values are displayed below the plot points unless a plot point is too close to the lower edge of the canvas. The attribute will function only if showValue attribute is set to 1 in this particular dataset.

Type: String

Range: "ABOVE", "BELOW", "AUTO"

visible


Sets whether a dataset will be visible on the chart, when the chart is first loaded. This attribute overrides the initiallyHidden attribute. Default Value : 1

Type: Boolean

Range: 0/1

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


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 defined for one data series are shown in the example below:


"dataset": [{
	"seriesname": "Previous Year",
	"data": [{
			"value": "10000",
		},
		{
			"value": "11500",
		},
		{
			"value": "12500",
		},
		{
			"value": "15000"
		}]
}]

alpha


For multi-series charts, you can define the alpha of datasets at dataset level. However, if you wish to highlight a particular data element, you can specify its alpha at "set" level using this attribute.

Type: Number

Range: 0 - 100

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

anchorBgColor


Lets you specify "set" specific background color of the anchor.

Type: Color

Range: Hex Color Code

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

anchorRadius


Lets you specify "set" specific radius (in pixels) of the anchor.

Type: Number

Range: In Pixels

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

color


For multi-series charts, you can define the color of datasets at dataset level. However, if you wish to highlight a particular data element, you can specify its color at "set" level using this attribute.

Type: Color

Range: Hex Color Code

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.). This value over-rides the dataset level value.

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:  

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. This value over-rides the dataset level value.

Type: Boolean

Range: 0/1

valueFontColor


Specifies the font color of a data value for an individual data plot.

Type: Color

Range: Hex Color Code

valueBgColor


Sets the background color of a value text for an individual data plot.

Type: Color

Range: Hex Color Code

valueBorderColor


Sets the border color around the value text for an individual data plot.

Type: Color

Range: Hex Color Code

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:

value


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

Type: Number

Range:

valuePosition


If you've opted to show a particular data value on the chart, this attribute lets you adjust the vertical alignment of individual data values with respect to dataplots. By default, this attribute is set to AUTO mode in which the alignment of a data value is determined automatically based on the position of its plot point. In ABOVE mode, a data value is displayed above the plot point unless a plot point is too close to the upper edge of the canvas while in BELOW mode, a data value is displayed below the plot point unless a plot point is too close to the lower edge of the canvas.

Type: String

Range: "ABOVE", "BELOW", "AUTO"

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

Trend-lines


Trend-lines are horizontal lines that aid in interpretation of data with respect to some pre-determined value. For example, if you are plotting the sales data for the current year, you might want to show the previous year's average monthly sales as a trend indicator for ease of comparison. The lines object, child of the trendlines object is used to add trend-lines to a chart. Although the line object has to be defined within the trendlines object, the latter cannot be used to collectively customize trend-lines, because it does not have any attributes of its own. The attributes of the lines object, child of the trendlines object, are used to create and customize trend-lines for charts.

startValue


The starting value for the trendline. Say, if you want to plot a slanted trendline from value 102 to 109, the startValue will be 102.

Type: Number

Range: Numeric Value

endValue


The ending y-axis value for the trendline. Say, if you want to plot a slanted trendline from value 102 to 109, the endValue will be 109. If you do not specify a value for endValue, it will automatically assume the same value as startValue.

Type: Number

Range: Numeric Value

displayValue


If you want to display a string caption for the trend line by its side, you can use this attribute. Example: displayValue='Last Month High'. When you don't supply this attribute, it automatically takes the value of startValue.

Type: String

Range:

color


Color of the trend line and its associated text

Type: String

Range: Hex Color Code

isTrendZone


Whether the trend will be displayed as a line or a zone (fill-colored rectangle).

Type: Boolean

Range: 0/1

showOnTop


Whether the trend line/zone will be displayed over data plots or under them.

Type: Boolean

Range: 0/1

thickness


If you've opted to show the trend as a line, this attribute lets you define the thickness of trend line.

Type: Number

Range: In Pixels

alpha


Alpha of the trend line.

Type: Number

Range: 0 - 100

dashed


Whether the trendline should be rendered as dashed lines.

Default value: 0 (trendline rendered using straight lines)

Type: Boolean

Range: 0/1

dashLen


Sets the width of each dash when trendline is rendered as dashed lines.

Type: Number

Range: In pixels

dashGap


Sets the gap between consecutive dashes when trendline is rendered as dashed lines.

Type: Number

Range: In pixels

valueOnRight


Whether to show the trend line value on left side or right side of chart. This is particularly useful when the trend line display values on the chart are colliding with divisional lines values on the chart.

Type: Boolean

Range: 0/1

toolText


Custom tool-text for this trendline/zone.

Type: String

Range:  

Trend-lines (Chart level attributes)


Trend-lines are horizontal lines that aid in interpretation of data with respect to some pre-determined value. For example, if you are plotting the sales data for the current year, you might want to show the previous year's average monthly sales as a trend indicator for ease of comparison. Cosmetics for all the trend-lines rendered can be attained using this set of attributes. Although there are set of attributes of the line object, used to create and customize trend-lines, these set of attributes effect all the trend-lines rendered in your chart.

trendlineColor


Sets color of all the trend lines and its associated text in the chart.

Type: Color

Range: Hex Color Code

trendlineThickness


If you've opted to show the trend as a line, this attribute lets you define the thickness of all the trend lines in your chart.

Type: Number

Range: In Pixels

trendlineAlpha


Sets transparency for all the trend lines in your charts.

Type: Number

Range: 0 - 100

trendLineToolText


Sets the tooltip text of the trend-line. It accepts macros, plain text, and HTML tags, as string.

Type: String

Range:

showTrendlinesOnTop


Whether all the trend line/zone will be displayed over data plots or under them.

Type: Boolean

Range: 0/1

Trend-lines Display Value Cosmetics


These attributes let you customize the text displayed with a trend-line.

Note: These attributes belong to the chart object and not to the line object (child of the trendline object). They are, therefore, applied to all trend-lines on your chart.

trendValueFont


Sets the font family for the trend-line display value.

Type: String

Range: Font Name

trendValueFontSize


Sets the font size for the trend-line display value.

Type: Number

Range:  

trendValueFontBold


Sets whether the trend-line display value will be bold formatted.

Default value: 0 (not bold formatted)

Type: Boolean

Range: 0/1

trendValueFontItalic


Sets whether the trend-line display value will be italicized.

Default value: 0 (not italicized)

Type: Boolean

Range: 0/1

trendValueBgColor


Sets the background color for the trend-line display value.

Type: Color

Range: Hex Color Code

trendValueBorderColor


Sets the border color for the trend-line display value.

Type: Color

Range: Hex Color Code

trendValueAlpha


Sets the transparency for the trend-line display value.

Default value: 100

Type: Number

Range: 0 - 100

trendValueBgAlpha


Sets the transparency for the background of the trend-line display value.

Default value: 100

Type: Number

Range: 0 - 100

trendValueBorderAlpha


Sets the transparency for the border around the trend-line display value.

Default value: 100

Type: Number

Range: 0 - 100

trendValueBorderPadding


Sets padding for the border around the trend-line display value.

Type: Number

Range: In pixels

trendValueBorderRadius


Sets the radius for the border around the trend-line display value.

Type: Number

Range: In pixels

trendValueBorderThickness


Sets the thickness for the border around the trend-line display value.

Type: Number

Range: In pixels

trendValueBorderDashed


Whether the border around the trend-line display value should be rendered as dashed lines.

Default value: 0 (border rendered using straight lines)

Type: Boolean

Range: 0/1

trendValueBorderDashLen


Sets the length of each dash when the border around the trend-line display value is rendered as dashed lines.

Type: Number

Range: In pixels

trendValueBorderDashGap


Sets the gap between two consecutive dashes when the border around the trend-line display value is rendered as dashed lines.

Type: Number

Range: In pixels