Pyramid Chart Attributes

animation

This attribute lets you set the configuration whether the chart should appear in an animated fashion. If you do not want to animate any part of the chart, set this as 0.

Type: Boolean

Range: 0/1

animationDuration

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

Default value: 1 sec

Type: Number

Range: In seconds

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: URL in FusionCharts format

Range:

clickURLOverridesPlotLinks

Sets whether the clickURL attribute (that sets a link to which the user is directed when the chart is clicked) overrides the link attribute (that sets a link to which the user is directed when a data plot is clicked).

Default value: 0 (clickURL does not override link)

Type: Boolean

Range: 0/1

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

paletteThemeColor

If you want your own palette derived from a particular hex color, you can specify the same here. All other colors on the chart will automatically derive from that palette.

Type: Color

Range: Hex Color Code

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

manageResize

Setting this attribute to 1, you can allow the chart to automatically resize itself when the parent container of the chart is resized.

Type: Boolean

Range: 0/1

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

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'

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

caption

Caption of the chart.

Type: String

Range:

subCaption

Sub-caption of the chart.

Type: String

Range:

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

showLabels

Allows you to show/hide the labels of the pyramid chart.

Type: Boolean

Range: 0/1

showLabelsAtCenter

Whether to show the labels of each pyramid at its side or at the center? This attribute is only applicable for 2D Pyramid chart.

Type: Boolean

Range: 0/1

labelDistance

Lets you set the horizontal distance between the data labels & pyramid slices.

Type: Number

Range: In pixels

labelSepChar

If you've opted to show both pyramid label & value, this attribute lets you specify the character using which they'll be separated.

Type: String

Range:

enableSmartLabels

Whether to use smart lines & labels for the pyramid chart?

Type: Boolean

Range: 0/1

smartLineColor

If you've opted to use smart lines, this attribute lets you define the color for the same.

Type: Color

Range: Hex Color Code

smartLineThickness

Thickness of smart lines.

Type: Number

Range: In pixels

smartLineAlpha

Alpha of the smart lines.

Type: Number

Range: 0 - 100

showValues

Allows you to show/hide the data values along with the pyramid slices on chart.

Type: Boolean

Range: 0/1

showPercentValues

Whether to show the values as percentage or as absolute values?

Type: Boolean

Range: 0/1

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

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:

numberSuffix

Using this attribute, you could add suffix to all the numbers visible on the graph. For example, to represent all figures quantified as per annum on the chart, you could specify this attribute to '/a' to show like 40000/a, 50000/a.

Type: String

Range:

decimals

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

Type: Number

Range:

forceDecimals

Whether to add 0 padding at the end of decimal numbers? For example, if you set decimals as 2 and a number is 23.4. If forceDecimals is set to 1, the number will automatically be converted 23.40 (note the extra 0 at the end).

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:

decimalSeparator

This attribute helps you specify the character to be used as the decimal separator in a number.

Type: String

Range:

thousandSeparator

This attribute helps you specify the character to be used as the thousands separator in a number.

Type: String

Range:

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/JSON, if you specify such values, it will give an error while converting to number. So, Froala Charts accepts the input decimal and thousand separators from user, so that it can convert it accordingly into the required format. This attribute lets you input the decimal separators.

Type: String

Range:

inThousandSeparator

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

Type: String

Range:

is2D

Whether the chart will render as 2D?

Type: Boolean

Range: 0/1

isSliced

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

Type: Boolean

Range: 0/1

pyramidYScale

Lets you set the 3D perspective of the pyramid. You'll need to restrict your values to a value between 0 and 40 (depending on your pyramid chart dimensions) to get a proper drawing.

Type: Number

Range: 0-40

use3dlighting

This attribute when set to 1 shows a 3D effect to the pyramid chart only when _is2d_ attribute is set to 1 . When we set this attribute to 0, it displays a simple pyramid chart.

Type: Boolean

Range: 0/1

showPlotBorder

If you've rendered the pyramid chart in 2D mode, you can opt to show or hide the pyramid border using this attribute.

Type: Boolean

Range: 0/1

plotBorderColor

Border color for pyramid (only when rendered in 2D mode).

Type: Color

Range: Hex Color Code

plotBorderThickness

Border thickness for pyramid (only when rendered in 2D mode).

Type: Number

Range: In pixels

plotBorderAlpha

Border alpha of pyramid slices (only when rendered in 2D mode).

Type: Number

Range: 0 - 100

plotFillAlpha

Fill alpha for the pyramid slices.

Type: Number

Range: 0 - 100

minPlotHeightForValue

Set the minimum height in pixel of a column above which the data values will be visible.

Type: Number

Range: In Pixels

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: Numbers separated by comma

Range:

bgAngle

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

Type: Number

Range: 0-360

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

bgImage

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

Type: String

Range:

bgImageAlpha

This attribute specifies the opacity for the loaded background image.

Type: Number

Range: 0 - 100

bgImageDisplayMode

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

Type: String

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

bgImageVAlign

Helps you to vertically align the background image.

Type: String

Range: 'top', 'middle', 'bottom'

bgImageHAlign

Helps you to horizontally align the background image.

Type: String

Range: 'left', 'middle', 'right'

bgImageScale

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

Type: Number

Range: 0-300

logoURL

You can load an external logo (JPEG/PNG) to your chart, this attribute lets you specify the URL. Due to cross domain security restrictions it is advised to use a logo from the same domain name as your charts.

Type: String

Range:

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 size of externally loaded logo at run-time by specifying a value for this parameter.

Type: Number

Range: 0 - 100

logoLink

If you want to link the logo to an external URL, specify the link in this attribute. The link can be in Froala Charts Link format, allowing you to link to new windows, pop-ups, frames etc.

Type: String

Range:

baseFont

This attribute lets you set the font face (family) of all the text (data labels, values etc.) on chart. If you specify 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:

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

labelFont

Sets the x-axis label font family for the text.

Type: String

Range: Font Name

labelFontColor

Sets the x-axis label font color.

Type: Color

Range: Hex Color Code

labelFontSize

Specifies the x-axis label font size.

Type: Number

Range: 6 - 72

labelFontBold

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

Type: Boolean

Range: 0/1

labelFontItalic

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

Type: Boolean

Range: 0/1

labelBgColor

Sets the background color for x-axis label text.

Type: Color

Range: Hex Color Code

labelBorderColor

Sets the color of the border around the x-axis label text.

Type: Color

Range: Hex Color Code

labelAlpha

Sets the x-axis label alpha for both font and background.

Type: Number

Range: 0 - 100

labelBgAlpha

Sets the x-axis label background alpha.

Type: Number

Range: 0 - 100

labelBorderAlpha

Sets the x-axis label border alpha.

Type: Number

Range: 0 - 100

labelBorderPadding

Sets the x-axis label border padding.

Type: Number

Range: In Pixels

labelBorderRadius

Sets the x-axis label border radius.

Type: Number

Range: In Pixels

labelBorderThickness

Sets the x-axis label border thickness.

Type: Number

Range: In Pixels

labelBorderDashed

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

Default value: 0 (border rendered using straight lines)

Type: Boolean

Range: 0/1

labelBorderDashLen

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

Type: Number

Range: In pixels

labelBorderDashGap

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

Type: Number

Range: In pixels

labelLink

Sets a link for every data plot labels.

Type: URL

Range:

showLegend

Whether to show legend on the chart.

Type: Boolean

Range: 0/1

legendItemFontBold

Whether legend keys should be displayed in bold

Type: Boolean

Range: 0/1

legendItemFont

Sets legend item font

Type: String

Range: Font Name

legendItemFontSize

Sets legend item font size

Type: Number

Range: 6 - 72

legendItemFontColor

Sets legend item font color

Type: Color

Range: Hex Color Code

legendItemHoverFontColor

Sets legend item font color on hover

Type: Color

Range: Hex Color Code

legendPosition

The legend can be plotted at different positions with respect to the chart. Note that if the value of legendPosition is set to absolute, you also need to set the coordinates of the legend. You can do that using the attributes legendXPosition and legendYPosition, both of which accept absolute or percentage values.

Type: String

Range: bottom, right, top, top-left, top-right, bottom-left, bottom-right, left, left-top, left-bottom, right, right-top, right-bottom, and absolute

legendXPosition

When the value of legendPosition is set to absolute, use this attribute to set the X-coordinate of the legend. It accepts absolute or percentage values. By default, its value is set to 0.

Type: Number

Range: 0 to chart width (in pixels)

legendYPosition

When the value of legendPosition is set to absolute, use this attribute to set the Y-coordinate of the legend. It accepts absolute or percentage values. By default, its value is set to 0.

Type: Number

Range: 0 to chart height (in pixels)

legendNumRows

Sets the number of rows the legend should display.

Type: Number

Range:

legendNumColumns

Sets the number of columns the legend should display.

Type: Number

Range:

legendCaptionAlignment

Sets the legend caption horizontal alignment .

Type: String

Range: "left", "center", "right"

legendCaptionFontBold

Whether legend caption should be displayed in bold

Type: Boolean

Range: 0/1

legendCaptionFont

Sets legend caption font

Type: String

Range: Font Name

legendCaptionFontSize

Sets legend caption font size

Type: Number

Range: 6 - 72

legendCaptionFontColor

Sets legend caption font color

Type: Color

Range: Hex Color Code

legendCaption

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

Type: String

Range:

legendIconScale

Scaling of legend icon is possible starting Froala Charts. This attribute lets you control the size of the legend icon. The default scale value is 1. Anything less than 1 reduces the size of the legend-icons on the chart. Any value bigger than 1 enlarges the icons. e.g., 0.5 means half the size, whereas, 2 means twice the size.

Type: Number

Range: 1-5

legendBgColor

Background color for the legend.

Type: Color

Range: Hex Color Code

legendBgAlpha

Background alpha for the legend.

Type: Number

Range: 0 - 100

legendBorderColor

Border Color for the legend.

Type: Color

Range: Hex Color Code

legendBorderThickness

Border thickness for the legend.

Type: Number

Range: In pixels

legendBorderAlpha

Border alpha for the legend.

Type: Number

Range: 0 - 100

legendShadow

Whether to show a shadow for legend.

Type: Boolean

Range: 0/1

legendAllowDrag

The legend can be made drag-able by setting this attribute to 1. End viewers of the chart can drag the legend around on the chart.

Type: Boolean

Range: 0/1

legendScrollBgColor

If you've too many items on the legend, a scroll bar shows up on the same. This attribute lets you configure the background color of the scroll bar.

Type: Color

Range: Hex Color Code

reverseLegend

You can reverse the ordering of datasets in the legend by setting this attribute to 1.

Type: Boolean

Range: 0/1

interactiveLegend

This attribute lets you interact with the legend in your chart. When you click a particular legend key, the associated slice slides out from the chart. Re-clicking the key causes the slice to slide in.

Type: Boolean

Range: 0/1

legendNumColumns

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

Type: Number

Range: Zero and Positive Integers

minimiseWrappingInLegend

Whether to minimize legend item text wrapping.

Type: Boolean

Range: 0/1

drawCustomLegendIcon

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

Default value: 0 (disabled)

Type: Boolean

Range: 0/1

legendIconBorderColor

Sets the border color for the legend icon.

Default value: Data plot border color

Type: Color

Range: Hex Color Code

legendIconBgColor

Sets the background color for the legend icon.

Default value: Data plot fill color

Type: Color

Range: Hex Color Code

legendIconAlpha

Sets the legend icon transparency.

Default value: 100

Type: Number

Range: 0 - 100

legendIconBgAlpha

Sets the legend icon background transparency.

Default value: 100

Type: Number

Range: 0 - 100

legendIconSides

Sets the number of sides for the legend icon.

Default value: 4

Type: Number

Range:

legendIconBorderThickness

Sets the thickness of the legend icon border.

Default value: 1

Type: Number

Range: 1-5

legendIconStartAngle

Sets the starting angle of for drawing the legend icon.

Default value: 45

Type: Number

Range:

alignLegendWithCanvas

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

Type: Boolean

Range: 0/1

showToolTip

Whether to show tooltip on chart?

Type: Boolean

Range: 0/1

showPercentInToolTip

Whether to show percent values in tooltip? If not, the actual values will be shown.

Type: Boolean

Range: 0/1

toolTipBgColor

Background color for tooltip.

Type: Color

Range: Hex Color Code

toolTipColor

Font color for the tool-tip.

Type: Color

Range: Hex Color Code

toolTipBorderColor

Border color for tooltip.

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

Type: String

Range:

showToolTipShadow

Whether to show shadow for tooltips.

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:

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:

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:

showHoverEffect

Whether to enable hover effect on charts for all elements

Type: Boolean

Range: 0/1

plotHoverEffect

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

Type: Boolean

Range: 0/1

plotFillHoverColor

Specifies the hover color for the data plots

Type: Color

Range: Hex Color Code

plotFillHoverAlpha

Specifies the hover alpha for data plots

Type: Number

Range: 1 - 100

plotBorderHoverColor

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

Type: Color

Range: Hex color code

plotBorderHoverAlpha

This attribute sets the transparency of plot border when hovered.

Type: Number

Range: 0 - 100

plotBorderHoverThickness

Sets the thickness of the border of plot when hovered.

Type: Number

Range: In pixels

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

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

label

Label for the pyramid slice.

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:

value

Numerical value for the pyramid slice. This value will be plotted on the chart.

Type: Number

Range:

link

You can define links for individual data items. That enables the end user to click on data items (Pyramid slices) and drill-down to other pages. To define the link for data items, use the link attribute. You can define links that open in same window, new window, pop-up window or frames. Please see Drill-Down Charts section for more information. Also, you'll need to URL Encode all the special characters (like ? and &) present in the link.

Type: String

Range:

toolText

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

Type: String

Range:

color

Color for pyramid slice

Type: Color

Range: Hex Color Code

alpha

Alpha for pyramid slice.

Type: Number

Range: 0 - 100

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

borderColor

Border Color for the pyramid slice.

Type: Color

Range: Hex Color Code

borderAlpha

Border Alpha for the slice.

Type: Color

Range: Hex Color Code

isSliced

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

Type: Boolean

Range: 0/1

labelFont

Sets the x-axis label font family for the text.

Type: String

Range: Font Name

labelFontColor

Sets the x-axis label font color.

Type: Color

Range: Hex Color Code

labelFontSize

Specifies the x-axis label font size.

Type: Number

Range: 6 - 72

labelFontBold

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

Type: Boolean

Range: 0/1

labelFontItalic

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

Type: Boolean

Range: 0/1

labelBgColor

Sets the background color for x-axis label text.

Type: Color

Range: Hex Color Code

labelBorderColor

Sets the color of the border around the x-axis label text.

Type: Color

Range: Hex Color Code

labelAlpha

Sets the x-axis label alpha for both font and background.

Type: Number

Range: 0 - 100

labelBgAlpha

Sets the x-axis label background alpha.

Type: Number

Range: 0 - 100

labelBorderAlpha

Sets the x-axis label border alpha.

Type: Number

Range: 0 - 100

labelBorderPadding

Sets the x-axis label border padding.

Type: Number

Range: In Pixels

labelBorderRadius

Sets the x-axis label border radius.

Type: Number

Range: In Pixels

labelBorderThickness

Sets the x-axis label border thickness.

Type: Number

Range: In Pixels

labelBorderDashed

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

Default value: 0 (border rendered using straight lines)

Type: Boolean

Range: 0/1

labelBorderDashLen

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

Type: Number

Range: In pixels

labelBorderDashGap

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

Type: Number

Range: In pixels

labelLink

Sets the link for each individual data plot label.

Type: URL

Range:

hoverColor

This attribute can set the hover color for a particular data plot.

Type: Color

Range: Hex Color Code

hoverAlpha

This attribute sets the transparency for a particular data plot when hovered.

Type: Number

Range: 0 - 100

borderHoverColor

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

Type: Color

Range: Hex Color Code

borderHoverAlpha

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

Type: Number

Range: 0 - 100

borderHoverThickness

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

Type: Number

Range: In pixels