Skip to content

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


Each chart has 5 pre-defined color palettes which you can choose from. Each palette renders the chart in a different color theme.

Type: Number

Range: 1-5

paletteColors


While the palette attribute allows to select a palette theme that applies to chart background, canvas, font and tool-tips, it does not change the colors of data items (that is, column, line, pie etc.). Using paletteColors attribute, you can specify your custom list of hex colors for the data items. The list of colors have to be separated by comma, for example, "paletteColors": "#FF0000, #0372AB, #FF5904...". The chart will cycle through the list of specified colors and then render the data plot accordingly. To use the same set of colors throughout all your charts in a web application, you can store the list of palette colors in your application globally and then provide the same in each chart JSON.

Type: String

Range: List of hex color codes separated by comma

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

trType


Specifies the type of data provided in the top-right label. This value is displayed in the tool tip.

Type: String

Range:  

tlType


Specifies the type of data provided in the top-left label. This value is displayed in the tool tip.

Type: String

Range:  

brType


Specifies the type of data provided in the bottom-right label. This value is displayed in the tool tip.

Type: String

Range:  

blType


Specifies the type of data provided in the bottom-left label. This value is displayed in the tool tip.

Type: String

Range:  

staggerLines


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

Type: Number

Range: 2 or above

showValues


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

Type: Boolean

Range: 0/1

showLimits


Whether to show chart limit values.

Type: Boolean

Range: 0/1

showDivLineValues


Whether to show div line values.

Type: Boolean

Range: 0/1

showShadow


Whether to apply the shadow effects for dataplot.

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:

interactiveAnimationDuration


Sets the duration of the animation that takes place when the legends are used to show or hide dataplots.

Type: Number

Range:

mapByCategory


Allows you to render a category based heat map chart.

Type: Boolean

Range: 0/1

plotFillAlpha


Sets the transparency of all the dataplots in the chart.

Type: Numeric

Range: 0 - 100

showPrintMenuItem


When you right click on the chart it shows a context menu. This attribute allows you to show or hide the "Print" option in the context menu.

Type: Boolean

Range: 0/1

hasRTLText


This attribute, when set to 1, indicates to the chart that the text (rendered on the chart) may contain RTL characters and the textual display has to be managed accordingly.

Type: Number

Range:

plotHighlightEffect


This attribute lets you enable/disable the highlight effect, in the form of a fadeout, for the data plots corresponding to a legend item. When this attribute is enabled and the mouse pointer is hovered over a legend item label, plots belonging to the other data series fadeout, by reducing their opacity. The fadeout effect can be customized by specifying the fadeout color and opacity using the color and alpha attributes. Eg. fadeout|color=#ff0000, alpha=60

Type: String

Range:

theme


This attribute changes the theme of the chart. There are 7 types of themes which have been made according to the different color combinations.

Type: String

Range: 'froala', 'candy'

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

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

showXaxisLabels


This attribute is used to show or hide the x axis or the column labels.

Type: Boolean

Range: 0/1

rotatexAxisLabels


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

Type: Boolean

Range: 0/1

showYaxisLabels


This attribute is used to show or hide y axis or the row labels.

Type: Boolean

Range: 0/1

rotateYAxisName


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

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)

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 have opted for gradient background, you need to set a list of alpha(s) separated by comma.

Type: Number

Range: 0 - 100

bgRatio


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

Type: Number

Range: 0 - 100

bgAngle


Angle of the background color, in case of a gradient.

Type: Number

Range: 0-360

bgImage


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

Type: String

Range:

bgImageAlpha


This attribute specifies the opacity for the loaded background image.

Type: Number

Range: 0 - 100

bgImageDisplayMode


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

Type: String

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

bgImageValign


Helps you to vertically align the background image.

Type: String

Range: left, center, right

bgImageHalign


Helps you to horizontally align the background image.

Type: String

Range: left, center, right

bgImageScale


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

Type: Number

Range: 0-300

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

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) would appear on the chart. If the plots can show borders, you can control the border properties using the attributes listed below. Or, if they support gradient fills, you can again configure various properties of the gradient using these attributes. Various other controls over plot cosmetics can be attained using this set of attributes.

showPlotBorder


Whether the column, area, pie etc. border would show up.

Type: Boolean

Range: 0/1

plotBorderColor


Color for column, area, pie border.

Type: Color

Range: Hex Color Code

plotBorderThickness


Thickness for column, area, pie border.

Type: Number

Range: 0-5

plotBorderAlpha


Alpha for column, area, pie border.

Type: Number

Range: 0 - 100

plotBorderDashed


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

Default value: 0 (border rendered using straight lines)

Type: Boolean

Range: 0/1

plotBorderDashLen


Sets the length of each dash when the border around the data plots are rendered using dashed lines.

Type: Number

Range: In pixels

plotBorderDashGap


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

Type: Number

Range: In pixels

plotFillAngle


If you have opted to fill the plot (column, area etc.) as gradient, this attribute lets you set the fill angle for gradient.

Type: Number

Range: 0-360

plotFillRatio


If you have opted to fill the plot (column, area etc.) as gradient, this attribute lets you set the ratio for gradient.

Type: Number

Range: 0 - 100

Data Value Cosmetics


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

valueFont


Sets the font of the values in the chart

Type: String

Range: Font Name

valueFontColor


Specifies the value font color

Type: Color

Range: Hex Color Code

valueFontSize


Specifies the value font size

Type: Number

Range: 6 - 72

valueFontBold


Whether value font should be bold

Type: Boolean

Range: 0/1

valueFontItalic


Whether value font should be italicized

Type: Boolean

Range: 0/1

valueBgColor


Sets the background color for value text

Type: Color

Range: Hex Color Code

valueBorderColor


Sets the border color around the value text

Type: Color

Range: Hex Color Code

valueAlpha


Sets the value alpha including font and background

Type: Number

Range: 0 - 100

valueFontAlpha


Sets the value font alpha

Type: Number

Range: 0 - 100

valueBgAlpha


Sets the value background alpha

Type: Number

Range: 0 - 100

valueBorderAlpha


Sets the value border alpha

Type: Number

Range: 0 - 100

valueBorderThickness


Sets the value border thickness

Type: Number

Range: In Pixels

valueBorderPadding


Sets the padding between the value and its surrounding border

Type: Number

Range: In Pixels

valueBorderRadius


Sets the value border radius

Type: Number

Range: In Pixels

valueBorderDashed


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

Default value: 0 (border rendered using straight lines)

Type: Boolean

Range: 0/1

valueBorderDashLen


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

Type: Number

Range: In pixels

valueBorderDashGap


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

Type: Number

Range: In pixels

textOutline


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

Default value: 0

Type: Boolean

Range: 0/1

Chart Padding & Margins


The following attributes help you control chart margins and paddings. Froala Charts allows you manually customize the padding of various elements on the chart to allow advanced manipulation and control over chart visualization. Padding in FusionCharts Suite XT is always defined in pixels, unless the attribute itself suggests some other scale (like plotSpacePercent, which configures the spacing using percentage values). You can also define the chart margins. Chart Margins refer to the empty space left on the top, bottom, left and right of the chart. That means, FusionCharts Suite XT would not plot anything in that space. It is not necessary for you to specify any padding or margin values. FusionCharts Suite XT automatically assumes the best values for the same, if you do not specify the same.

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

labelXPadding


This attribute sets the vertical space between the x-axis labels and canvas bottom edge.

Type: Number

Range: In Pixels

labelYPadding


It sets the horizontal space between the y-axis labels and the canvas right edge.

Type: Number

Range: In Pixels

chartLeftMargin


Amount of empty space that you want to put on the left side of your chart. Nothing is rendered in this space.

Type: Number

Range: In Pixels

chartRightMargin


Amount of empty space that you want to put on the right side of your chart. Nothing is rendered in this space.

Type: Number

Range: In Pixels

chartTopMargin


Amount of empty space that you want to put on the top of your chart. Nothing is rendered in this space.

Type: Number

Range: In Pixels

chartBottomMargin


Amount of empty space that you want to put at the bottom of your chart. Nothing is rendered in this space.

Type: Number

Range: In Pixels

legendPadding


Padding of legend from right or bottom side of canvas

Type: Number

Range: In Pixels

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. Using this attribute, you can control the amount of empty space between the chart left side and canvas left side. By default, the chart automatically calculates this space depending on the elements to be placed on the chart. However, if you want to over-ride this value with a higher value, you can use this attribute to specify the same. Please note that you cannot specify a margin lower than what has been calculated by the chart. This attribute is particularly useful, when you have multiple charts placed in a page and want all their canvas start position to align with each other - so in such a case, you can set same margin value (a value large enough that it does not get rejected by chart owing to it being lower than the calculated value) for all such charts in the page.

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

Data Label Cosmetics


These attributes let you configure the cosmetics of all data labels of the chart.

showLabels


It sets the configuration whether the categorical 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 categorical axis labels (data labels) excluding the 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

maxLabelWidthPercent


Restricts the maximum space allotted for the y-axis data labels with respect to the chart's width. If a data label is longer than the specified percentage width then it will either be wrapped or get truncated, subject to the availability of vertical space. Unnecessary space is not reserved for the labels. If all the labels are shorter than the specified maximum width, this value is not applied.

Type: Numeric

Range: In Pixels

minLabelWidthPercent


Restricts the minimum length of data labels in terms of percentage of the chart's width that the data labels can occupy. The space thus calculated stays reserved even if the label width is less than the minimum width.

Type: Number

Range: 1-100

labelDisplay


Using this attribute, you can customize the alignment of data labels (categorical 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'

labelFont


Sets the categorical axis label font family for the text.

Type: String

Range: Font Name

labelFontColor


Sets the categorical axis label font color.

Type: Color

Range: Hex Color Code

labelFontSize


Specifies the categorical axis label font size.

Type: Number

Range: 6 - 72

labelFontBold


Flag indicating whether categorical axis label font should be bold or not.

Type: Boolean

Range: 0/1

labelFontItalic


Flag indicating whether categorical axis label font should be italicized or not.

Type: Boolean

Range: 0/1

labelBgColor


Sets the background color for categorical axis label text.

Type: Color

Range: Hex Color Code

labelBorderColor


Sets the color of the border around the categorical axis label text.

Type: Color

Range: Hex Color Code

labelAlpha


Sets the categorical axis label alpha for both font and background.

Type: Number

Range: 0 - 100

labelBgAlpha


Sets the categorical axis label background alpha.

Type: Number

Range: 0 - 100

labelBorderAlpha


Sets the categorical axis label border alpha.

Type: Number

Range: 0 - 100

labelBorderPadding


Sets the categorical axis label border padding.

Type: Number

Range: In Pixels

labelBorderRadius


Sets the categorical axis label border radius.

Type: Number

Range: In Pixels

labelBorderThickness


Sets the categorical axis label border thickness.

Type: Number

Range: In Pixels

labelBorderDashed


Whether the border around categorical 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 categorical axis labels are rendered using dashed lines.

Type: Number

Range: In pixels

labelBorderDashGap


Sets the gap between two consecutive dashes when the border around categorical axis labels are rendered using dashed lines.

Type: Number

Range: In pixels

tlFont


Allows user to set Top Left font for the tooltext

Type: String

Range: Font Name

tlFontSize


Allows user to set Top Left font size for the tooltext

Type: Number

Range: 6 - 72

tlFontColor


Allows user to set Top Left font color for the tooltext

Type: Color

Range: Hex color code

trFont


Allows user to set Top Right font for the tooltext

Type: String

Range: Font Name

trFontSize


Allows user to set Top Right font size for the tooltext

Type: Number

Range: 6 - 72

trFontColor


Allows user to set Top Right font color for the tooltext

Type: Color

Range: Hex color code

blFont


Allows user to set Bottom Left font for the tooltext

Type: String

Range: Font Name

blFontSize


Allows user to set Bottom Left font size for the tooltext

Type: Number

Range: 6 - 72

blFontColor


Allows user to set Bottom Left font color for the tooltext

Type: Color

Range: Hex color code

brFont


Allows user to set Bottom Right font for the tooltext

Type: String

Range: Font Name

brFontSize


Allows user to set Bottom Right font size for the tooltext

Type: Number

Range: 6 - 72

brFontColor


Allows user to set Bottom Right font color for the tooltext

Type: Color

Range: Hex color code

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:

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:

showToolTipShadow


Whether to show shadow for tool tips on the chart.

Type: Boolean

Range: 0/1

tooltipbgalpha


Sets the transparency of the tooltip.

Type: Number

Range: 0 - 100

tooltipborderradius


Sets the border radius of the tooltip.

Type: Number

Range: In Pixels

tooltipborderthickness


Sets the border thickness of the tooltip.

Type: Number

Range: In Pixels

toolTipPadding


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

Type: Number

Range: In Pixels

Toolbar Attributes


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

toolbarPosition


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

Type: String

Range: TL, TR, BL, BR, CC

toolbarX


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

Type: Number

Range:

toolbarY


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

Type: Number

Range:

toolbarHAlign


Sets the horizontal alignment of the toolbar on the chart.

Type: String

Range: Left, Right

toolbarVAlign


Sets the vertical alignment of the toolbar on the chart

Type: String

Range: Top, Bottom

toolbarButtonColor


Sets the color of the toolbar buttons.

Type: Color

Range: Any (color code without the # prefix)

showToolBarButtonTooltext


Enables/disables display of tooltips for toolbar buttons.

Type: Boolean

Range: 0/1

toolbarButtonScale


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

Type: Number

Range:

Attributes for Exporting Charts


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

exportEnabled


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

Default value: 0

Type: Boolean

Range: 0/1

exportAction


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

Default value: download

Type: String

Range: 'save' or 'download'

exportHandler


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

Type: String

Range:

exportFormats


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

Type: String

Range:

exportMode


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

Default value: auto.

Note: The exportMode attribute replaces the exportAtClientSide attribute. However, you don’t need to make any changes to the existing setup because, the Froala Charts library comes with the proper mapping already provided.

Type: String

exportShowMenuItem


Whether the menu items related to export (e.g., Save as JPEG etc.) will appear in the context menu of chart.

Type: Boolean

Range: 0/1

exportTargetWindow


In case of server-side exporting and when using download as action, this lefts you configure whether the return image, PDF, SVG or XLSX will open in same window (as an attachment for download), or whether it will open in a new window.

Default value: _self

Type: String

Range: '_self' or '_blank'

exportFileName


Using this attribute you can specify the name (excluding the extension) of the output (export) file.

Type: String

Range:

Data Plot Hover Effects


If you wish to show an effect on the data plot (column, line anchor, pie etc.) when the user hovers his mouse over the data plot, these attributes let you configure the cosmetics of the hover for all data plots in the chart.

showHoverEffect


Whether to enable hover effect on charts for all elements

Type: Boolean

Range: 0/1

plotHoverEffect


Whether to enable hover effect on charts for data plots (e.g., column, pie) only

Type: Boolean

Range: 0/1

plotFillHoverColor


Specifies the hover color for the data plots

Type: Color

Range: Hex Color Code

plotFillHoverAlpha


Specifies the hover alpha for data plots

Type: Number

Range: 1 - 100

Legend Properties


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

showLegend


Whether to show legend 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 starting 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 have too many items on the legend, a scroll bar shows up on the same. This attribute lets you configure the background color of the scroll bar.

Type: Color

Range: Hex Color Code

reverseLegend


You can reverse the order 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

legendPointerColor


Sets the legend pointer color for a gradient legend.

Type: Color

Range: Hex Color Code

legendPointerAlpha


Sets the legend pointer transparency for a gradient legend.

Type: Number

Range: 0 - 100

legendPointerBorderAlpha


Sets the transparency for the legend pointer border for a gradient legend.

Type: Number

Range: 0 - 100

legendpointerbordercolor


Sets the color for the border of the legend pointer.

Type: Color

Range: Hex color code

legendScaleLineColor


Allows you to set the color of the scale in gradient legend.

Type: Hex Color Code

Range:

legendaxisbordercolor


Sets color for the gradient legend's axis border.

Type: Color

Range: Hex Color Code

legendaxisborderalpha


Sets transparency for the gradient legend's axis border.

Type: Number

Range: 0 - 100

legendScaleLineAlpha


Allows you to set the transparency of the scale in gradient legend.

Type: Numeric

Range: 0 - 100

legendScaleLineThickness


Allows you to set the thickness of the scale in gradient legend.

Type: Numeric

Range:

autoOrderLegendIcon


Allows you to show the legend icon in ascending order in icon legend.

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 would round to Scaling of numbers based on a user defined scale Custom number input formats

formatNumber


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

Type: Boolean

Range: 0/1

formatNumberScale


Configuration whether to add K (thousands) and M (millions) to a number after truncating and rounding it - for example, if formatNumberScale is set to 1, 1043 would become 1.04K (with decimals set to 2 places). Same with numbers in millions - an M will be added at the end.

Type: Boolean

Range: 0/1

defaultNumberScale


The default unit of the numbers that you are 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, the chart accepts the input decimal and thousand separator from user, so that it can convert it accordingly into the required format. This attribute lets you input the decimal separator.

Type: String

Range: Character

inThousandSeparator


In some countries, commas are used as decimal separators and dots as thousand separators. In XML, if you specify such values, it will give an error while converting to number. So, the chart accepts the input decimal and thousand separator from user, so that it can convert it accordingly into the required format. This attribute lets you input the thousand separator.

Type: String

Range: Character

decimals


Number of decimal places to which all numbers on the chart would be rounded to.

Type: Number

Range: 0-10

forceDecimals


Whether to add 0 padding at the end of decimal numbers. For example, If you 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, that is, all the values and the names in the chart which lie on the canvas will be displayed using the font size provided here.

Type: Number

Range: 6 - 72

baseFontColor


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

Type: Color

Range: Hex Color Code

outCnvBaseFont


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

Type: String

Range: Font Name

outCnvBaseFontSize


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

Type: Number

Range: 6 - 72

outCnvBaseFontColor


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

Type: Color

Range: Hex Color Code

The rows Object and the row Object


While the dataset object and its child object, the data object can be used to define the rows and columns for a heat map chart, you have to be careful about the order of the values for the rows and columns. The rows object and its child object, the row object are used to create rows and predefine their order, enabling you to specify the data values in any order. Although the row object has to be defined within the rows object, rows cannot be collectively customized using the rows object, because it does not have any attributes of its own. These attributes let you define the order of rows for a heat map chart.

id


Allows you to specify a unique Id for the rows. This id is used in the data object to place the data values in the pre-defined position.

Type: Number/String

Range:

label


Allows you to specify a label for the rows. If you do not specify the label the unique id will be displayed as the label for the rows in the 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


Allows you to show or hide the label of a particular row.

Type: String

Range:

The columns Object and the column Object


While the dataset object and its child object, the data object can be used to define rows and columns for a heat map chart, you have to be careful about the order of the values for the rows and columns. The columns object and its child object, the column object are used to create columns and predefine their order, enabling you to specify the data values in any order. Although the column object has to be defined within the columns object, note that columns cannot be collectively customized because the columns object does not have any attributes of its own. These attributes let you define the order of columns for a heat map chart.

id


Allows you to specify a unique Id for the columns. This id is used in the data object to place the data values in the pre-defined position.

Type: Number/String

Range:

label


Allows you to specify a label for the columns. If you do not specify the label the unique id will be displayed as the label for the rows in the 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


Allows you to show or hide the label of a particular column.

Type: String

Range:

The dataset Object and the data Object


The dataset object contains a series of data defined through the data object. There are no attributes for the dataset object. The attributes used for the data object are mentioned below:

rowId


Specifies the position of the row where the data it is to be placed in the chart. If the rows object is used then it is mandatory to use the same id which is defined in the row object by the id attribute.

Type: String

Range:

columnId


Specifies the position of the column where the data it is to be placed in the chart. If the columns object is used then it is mandatory to use the same id which is defined in the column object by the id attribute.

Type: String

Range:

colorRangeLabel


This attribute is used to provide the color-range label which is defined in the color object of the colorRange object. It is used only in category based heat map chart.

Type: String

Range:

value


This attribute allows you to display a value at the center of a data plot.

Type: Number

Range:

displayValue


Allows you to display any numeric value or string at the center of the dataplot. The settings of this attribute overwrites the settings of the value attribute when both are used at the same time.

Type: Number/String

Range:

tlLabel


This attribute allows you to display a label on the top-left corner of a data plot.

Type: Number/String

Range:

trLabel


This attribute allows you to display a label on the top-right corner of a data plot.

Type: Number/String

Range:

blLabel


This attribute allows you to display a label on the bottom-left corner of a data plot.

Type: Number/String

Range:

brLabel


This attribute allows you to display a label on the bottom-left corner of a data plot.

Type: Number/String

Range:

color


In Heat map chart, if you wish to highlight a particular cell, you can specify it's color at "set" level using this attribute.

Type: Color

Range: Hex Color Code

toolText


By default, the tooltip text for a data item in the heat map chart includes the values of the trLabel, tlLabel, brlabel, bllabel, trType, tlType, brType, and and blType attributes. Additionally, you can display more customized information using the toolText attribute.

Type: String

Range:

showValue


You can individually opt to show or hide values of individual data items using this attribute. This value over-rides the data-set level value.

Type: Boolean

Range: 0/1

valueFontColor


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

Type: Color

Range: Hex Color Code

valueBgColor


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

Type: Color

Range: Hex Color Code

valueBorderColor


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

Type: Color

Range: Hex Color Code

alpha


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

Type: Number

Range: 0 - 100

The colorRange Object


Attributes of the colorRange object for the heat map chart are used to define the type of legend, the lower limit of the scale, and the start and end labels. Note that the colorRange object is not used to collectively configure all ranges; the color object (child of the colorRange object) is used to do that.

code


Hex code of the color range using which it will be filled.

Type: Color

Range: Hex Color Code

endLabel


Specifies the label for the upper limit of the gradient scale.

Type: String

Range:

gradient


Allows you to display gradient legend.

Type: Boolean

Range: 0/1

mapByPercent


Allows you to display the data values in percentage.

Type: Boolean

Range: 0/1

minValue


Sets the minimum value or the lower limit of the numeric range and the gradient scale.

Type: Number

Range:

startLabel


Specifies the label for the lower limit of the gradient scale.

Type: String

Range:

The color Object


The attributes of the color object, child of the colorRange object, are used to configure individual ranges on the gauge scale.

alpha


Sets the transparency of each range in the color range.

Type: Number

Range: 0 - 100

code


Hex code of the color range using which it will be filled.

Type: Color

Range: Hex Color Code

label


This attribute determines the label for each numeric range. The label appears either on the gradient scale or on icon legends depending on the legend type used.

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:

maxValue


Specifies the upper limits of each numeric range. This attribute is mandatory in each color object for both gradient and icon legend.

Type: Number

Range:

minValue


Specifies the lower limits of each numeric range. This attribute is mandatory in each color object when icon legend is used.

Type: Number

Range: