Skip to content

Angular chart Attributes

FroalaCharts will render here

Chart captions


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

caption


Caption of the chart.

Type: String

subCaption


Sub-caption of the chart.

Type: String

Chart Caption Cosmetics


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

captionAlignment


Sets horizontal alignment of caption

Type: String

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

captionOnTop


Whether caption should be on top of the data plot area

Type: Boolean

Range: 0/1

captionFontSize


Sets the caption font size in pixels

Type: Number

Range: 6 - 72

subCaptionFontSize


Sets the sub-caption font size (in pixels)

Type: Number

Range: 6 - 72

captionFont


Sets the caption font family

Type: String

Range: Font Name

subCaptionFont


Sets the sub-caption font family

Type: String

Range: Font Name

captionFontColor


Sets the caption font color

Type: Color

Range: Hex Color Code

subCaptionFontColor


Sets the sub-caption font color

Type: Color

Range: Hex Color Code

captionFontBold


Whether the caption font should be displayed in bold

Type: Boolean

Range: 0/1

subCaptionFontBold


Whether the sub caption font should be displayed in bold

Type: Boolean

Range: 0/1

alignCaptionWithCanvas


Whether the caption is aligned with the canvas. Else, it will be aligned with the entire chart area

Type: Boolean

Range: 0/1

captionHorizontalPadding


If caption is not centre aligned, lets you configure the padding (in pixels) from either edge. Will be ignored if caption is centre aligned.

Type: Number

Range: In Pixels

Functional Attributes


These attributes let you control a variety of functional elements on the chart. For example, you can opt to show/hide data labels, data values. You can also set chart limits and extended properties.

editMode


Whether to render the gauge in edit mode? In edit mode, user can drag and rotate the dial to new values.

Type: Boolean

Range: 0/1

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

Range:

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 be automatically derived from that palette.

Type: Color

Range: Hex Color Code

autoScale


If you've defined the chart parameters (like gauge origin, co-ordinates etc.) using a different chart size and now want to scale the chart to a different size, you need to specify the original width and height and then set this attribute to 1.

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. This setting is not applicable when autoScale is set to 0.

Type: Boolean

Range: 0/1

origW


If you've opted to dynamically resize the chart, you can convey the original width of chart using this attribute. It refers to the width based on which you had defined the various co-ordinates/radius of the gauge. For example, if you had designed an angular gauge with 300 px width and in that you had set the gauge radius to be 100, then you can use the dynamic resizing feature and specify origW='300'. It will automatically check the current width and scale the radius etc. appropriately. Please note that both the original width and height of the chart need to be set. To know more on how this attribute works, please read the Dynamic Resizing page.

Type: Number

Range: In pixels

origH


If you've opted to dynamically resize the chart, you can convey the original height of chart using this attribute. It refers to the height based on which you had defined the various co-ordinates/radius of the gauge. For example, if you had designed an angular gauge with 300 px height and in that you had set the gauge radius to be 100, then you can use the dynamic resizing feature and specify origH='300'. It will automatically check the current height and scale the radius etc. appropriately. Please note that both the original width and height of the chart need to be set. To know more on how this attribute works, please read the Dynamic Resizing page.

Type: Number

Range: In pixels

showValue


Whether to show each dial's value?

Type: Boolean

Range: 0/1

valueBelowPivot


Whether to show dial value below the pivot or above it?

Type: Boolean

Range: 0/1

showShadow


Whether to apply the shadow effect for the chart?

Type: Boolean

Range: 0/1

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

refreshInstantly


By default, the real-time charts wait for a few seconds after rendering for the first time and before updating itself with new data. To allow the chart to start updating itself as soon as it is rendered, set this attribute to 1.

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:

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


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: Font name

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

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

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

Axis & Tick mark properties


The following attributes configures the Axis and the tick marks on the chart.

setAdaptiveMin


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

Type: Boolean

Range: 0/1

upperLimit


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

Type: Number

Range:

lowerLimit


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

Type: Number

Range:

lowerLimitDisplay


This attribute allows you to display a label instead of the lower limit. For example, in a chart displaying Literacy Rate on a scale of 0 - 100%, you may need to show the label Low at the starting point of the chart. Upon using this attribute to specify the label, the value 0 will be replaced by Low.

Default value: If you do not specify the lowerLimitDisplay attribute, the lower limit value will be shown.

Type: String

Range:

upperLimitDisplay


This attribute allows you to display a label instead of the upper limit. Upon using this attribute, the upper limit of the chart gets replaced by the label specified.

Default value: If you do not specify the upperLimitDisplay attribute, the upper limit value will be shown.

Type: String

Range:

showTickMarks


Whether to show tick marks?

Type: Boolean

Range: 0/1

showTickValues


Whether to show tick values?

Type: Boolean

Range: 0/1

showLimits


Whether to show the first and last tick value (i.e., chart lower and upper limit)?

Type: Boolean

Range: 0/1

adjustTM


Whether to adjust major tick mark number so as to best distribute the specified chart scale.

Type: Boolean

Range: 0/1

placeTicksInside


Whether to place ticks inside the gauge (on the inner radius) or outside?

Type: Boolean

Range: 0/1

placeValuesInside


Whether to place tick values inside the gauge?

Type: Boolean

Range: 0/1

majorTMNumber


Number of major tick marks.

Type: Number

Range:

majorTMColor


Major tick marks color.

Type: Color

Range: Hex Color Code

majorTMAlpha


Major tick marks alpha.

Type: Number

Range: 0 - 100

majorTMHeight


Height of major tick marks.

Type: Number

Range: In pixels

majorTMThickness


Thickness of major tick mark line.

Type: Number

Range: In pixels

minorTMNumber


Number of minor tick marks.

Type: Number

Range:

minorTMColor


Color of minor tick marks.

Type: Color

Range: Hex Color Code

minorTMAlpha


Alpha of minor tick marks.

Type: Number

Range: 0 - 100

minorTMHeight


Height of minor tick marks.

Type: Number

Range: In pixels

minorTMThickness


Thickness of minor tick marks.

Type: Number

Range: In pixels

tickValueDistance


Distance between tick values and tick marks.

Type: Number

Range: In pixels

trendValueDistance


Distance between trend values and tick lines.

Type: Number

Range: In pixels

tickValueStep


If you need to show every n-th tick value only, you can specify that value here.

Type: Number

Range: In pixels

tickValueDecimals


Number of decimals to which tick values will be rounded to.

Type: Number

Range:

forceTickValueDecimals


Whether to force number of decimals on tick values?

Type: Boolean

Range: 0/1

autoAlignTickValues


Whether to ask the chart to automatically place tick values to reduce overlapping of the tick values with the gauge.

Type: Boolean

Range: 0/1

Real-time properties


Using these attributes, you can configure the real-time feature.

dataStreamURL


This parameter sets the path of the page which is supposed to relay real-time data to the chart. If you've special characters as a part of your data stream URL, like ? or &, you'll need to URL Encode the entire dataStreamURL. This page needs to be on the same sub-domain on which the chart is hosted and invoked from.

Type: URL

Range:

refreshInterval


For this parameter, you can specify the number of seconds after which the chart will look for new data. This process will happen continuously - i.e., if you specify 5 seconds here, the chart will look for new data every 5 seconds.

Type: Number

Range: In seconds

dataStamp


Constantly changing data stamp that can be added to real time Data URL, so as to maintain a state. Please see the section Real time capabilities > Adding data stamp

Type: String

Range:

showRTMenuItem


Whether to show the real-time update related menu items (like Start/Stop Update) in chart's context menu

Note: For JavaScript charts real-time update related menu items do not appear by default. You need to explicitly set 'showRTMenuItem': '1' in the chart object. The menu appears as a button on the bottom-left corner of the JavaScript chart. You can then use the button to Start/Stop Update or Clear chart.

Type: Boolean

Range: 0/1

Gauge Scale Properties


Using the following attributes you can configure the functional and cosmetic properties of the gauge scale.

gaugeStartAngle


Angle from where the gauge will start drawing. Please see the section Configuring angles & origin to learn more about this. Default value is 180.

Type: Number

Range: -360-360

gaugeEndAngle


Angle where the gauge will end drawing. Please see the section Configuring angles & origin to learn more about this. Default value is 0.

Type: Number

Range: -360-360

gaugeOriginX


You can manually specify the x co-ordinate at which the center of the gauge will be placed. This comes handy when you are designing small angle gauges or when you are using custom objects in the chart to draw certain objects and need to set the exact center position.

Type: Number

Range: In pixels

gaugeOriginY


You can manually specify the y co-ordinate at which the center of the gauge will be placed. This comes handy when you are designing small angle gauges or when you are using custom objects in the chart to draw certain objects and need to set the exact center position.

Type: Number

Range: In pixels

gaugeOuterRadius


Outer radius for the color range scale.

Type: Number

Range: In pixels

gaugeInnerRadius


Inner radius for color range scale. It can either be in exact pixels or in percentage of outer radius. For example, if the value of gaugeOuterRadius attribute is 10 and the value of gaugeInnerRadius attribute is set to 50%, the value of gaugeInnerRadius will be calculated and set as 5px, i.e. 50% of 10.

Type: Number

Range: In pixels or in percentage

gaugeFillMix


This attribute specifies the gradient fill formula for the gauge scale. Example: {light-10},{light-20},{light-60}

Note: This attribute is not supported in IE8

Type: String

Range:

gaugeFillRatio


This attribute sets the ratio of each color separated by comma using gaugeFillMix attribute.

Type: Number separated by commas

Range:

showGaugeBorder


Whether to show a border around gauge scale?

Type: Boolean

Range: 0/1

gaugeBorderColor


Color of gauge scale border. You can either specify a hex code here (like 333333), or a single token from gradient fill mix like {dark-20} or {light-30}. The chart will then calculate the border color for each color range individually (based on the color code for each color range).

Type: Color Code or Fill Mix formula (but single token)

Range: Hex Code or token from gradient fill mix

gaugeBorderThickness


Thickness of gauge scale border.

Type: Number

Range: In pixels

gaugeBorderAlpha


Alpha of gauge scale border.

Type: Number

Range: 0 - 100

Pivot properties


Using these attributes, you can configure the pivot properties:

pivotRadius


Radius of the pivot.

Type: Number

Range: In pixels

pivotFillColor


Fill color for the pivot.

Type: Color

Range: Hex Color Code

pivotFillAlpha


Fill alpha for the pivot.

Type: Number

Range: 0 - 100

pivotFillAngle


Angle for fill (if linear gradient).

Type: Number

Range: 0-360

pivotFillType


Whether to fill as linear gradient or radial gradient (if gradient at all)?

Type: linear or radial

Range:

pivotFillMix


This attribute specifies the gradient fill formula for the pivot. Example: {light-10},{light-20},{light-60}

Note: This attribute is not supported in IE8

Type: String

Range:

pivotFillRatio


This attribute sets the ratio of each color separated by comma using pivotFillMix attribute.

Type: Number separated by commas

Range:

showPivotBorder


Whether to show border for the pivot?

Type: Boolean

Range: 0/1

pivotBorderThickness


Border thickness for pivot.

Type: Number

Range: In pixels

pivotBorderColor


Border color for pivot.

Type: Color

Range: Hex Color Code

pivotBorderAlpha


Border alpha for pivot.

Type: Number

Range: 0 - 100

pivotbgcolor


This attribute fills the background color of the pivot.

Type: Color

Range: Hex Color Code

Message Logger


Froala Charts uses the concept of streaming and showing real-time messages in the chart using Message Logger. The Message logger can be effectively used to show necessary real-time information or live error logs.

useMessageLog


Whether to use message logger for the chart?

Type: Boolean

Range: 0/1

messageLogWPercent


This attribute lets you set the width percent of the message logger window w.r.t entire chart width. So, if you set it as 80, the message logger window will take up 80% of chart width.

Type: Number

Range: In percent

messageLogHPercent


This attribute lets you set the height percent of the message logger window w.r.t entire chart height.

Type: Number

Range: In percent

messageLogShowTitle


Whether to show the title for message logger?

Type: Boolean

Range: 0/1

messageLogTitle


If you've opted to show the title for message logger, you can define your custom title here. Examples are "Error log", "Server History" etc. The title displays at the top left corner of chart.

Type: String

Range:

messageLogColor


You can customize the color of the entire message log window by setting a hex value for this attribute.

Type: Color

Range: Hex Color Code

messageGoesToLog


The messages streamed to the chart can either be displayed in the message log window or can be passed to JavaScript (which we'll see next). This attribute lets you control whether the messages should be logged in the in-built log window.

Type: Boolean

Range: 0/1

messageGoesToJS


This attribute lets you configure whether each message streamed from the server should be passed to a local JavaScript function.

Type: Boolean

Range: 0/1

messageJSHandler


If you've opted to pass each message to JavaScript function, this attribute lets you define the name of the function. This helps you create your custom functions to react to messages streamed from server.

Type: String

Range:

messagePassAllToJS


Whether to pass all message envelope parameters to the custom JavaScript function.

Type: Boolean

Range: 0/1

Number Formatting Properties


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

formatNumber


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

Type: Boolean

Range: 0/1

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

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

Chart Cosmetics


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

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

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 values, tick values, limit values etc.), you'll need to use the Styles feature. Using Styles, you can also specify advanced font properties like Bold, Italics, HTML Mode etc. Using Styles you can also configure real-time values.

baseFont


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

Type: String

Range: Font Name

baseFontSize


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

Type: Number

Range: In pixels

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

valueFontSize


Specifies the value font size

Type: Number

Range: 6 - 72

Tooltip properties


These attributes let you control the tooltip. You can set the background color, border color, separator character and few other details.

showToolTip


Whether to show tooltip for the chart?

Type: Boolean

Range: 0/1

toolTipBgColor


Background color for the tooltip

Type: Color

Range: Hex Color Code

toolTipColor


Font color for the tool-tip.

Type: Color

Range: Hex Color Code

toolTipBorderColor


Border Color for the tooltip.

Type: Color

Range: Hex Color Code

tooltipBorderAlpha


Sets the border transparency for tool tip.

Type: Number

Range: 0 - 100

showToolTipShadow


Whether to show shadow for tooltips.

Type: Boolean

Range: 0/1

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

dialbgHoverColor


This attribute sets the background color of the gauge’s dial when hovered.

Type: Color

Range: Hex color code

dialbgHoverAlpha


This attribute sets the transparency of the gauge’s dial when hovered.

Type: Number

Range: 0 - 100

dialBorderHoverColor


Sets the border color for the dial of the gauge when hovered.

Type: Color

Range: Hex color code

dialBorderHoverAlpha


Sets the transparency for the dial’s border of the gauge when hovered.

Type: Number

Range: 0 - 100

dialBorderHoverThickness


Sets the thickness for the dial’s border of the gauge when hovered.

Type: Number

Range: In pixels

Chart Paddings & 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 Froala Charts is always defined in pixels, unless the attribute itself suggests some other scale (like plotSpacePercent, which configures the spacing using percentage values). You can also define the chart margins. Chart Margins refer to the empty space left on the top, bottom, left and right of the chart. It's not necessary for you to specify any padding/margin values. Froala Charts automatically assumes the best values for the same, if you do not specify the same.

chartLeftMargin


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

Type: Number

Range: In pixels

chartRightMargin


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

Type: Number

Range: In pixels

chartTopMargin


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

Type: Number

Range: In pixels

chartBottomMargin


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

Type: Number

Range: In pixels

The color Object and The colorRange Object


Attributes of the color object (child of the colorRange object) are used to define ranges for dividing the gauge scale. Although the color object has to be defined within the colorRange object, ranges cannot be collectively customized using the colorRange object because it does not have any attributes of its own.

alpha


Sets the transparency of each range in the color range.

Type: Number

Range: 0 - 100

borderAlpha


Border alpha for the color range.

Type: Number

Range: 0 - 100

borderColor


Border color of that particular color in the range. If you want to specify a different border for each range in the color range, you can use this attribute.

Type: Color

Range: Hex Color Code

code


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

Type: Color

Range: Hex Color Code

maxValue


Indicates the end value of a color range. The maxValue of the last color range should be equal to the chart's upperLimit.

Type: Number

Range:

minValue


Indicates the starting value of a color range. The minValue of the first color range should be equal to the chart's lowerLimit and the minValue of the succeeding color range should be equal to the current maxValue.

Type: Number

Range:

The dial Object


The dial object is used to create and configure dials for angular gauges. You can create as many dials for your gauge as required. For each dial to be created, a separate dial object has to be defined in the JSON data. Although the dial object has to be defined within the dials object, dials cannot be collectively customized using the dials object, because it does not have any attributes of its own. These attributes let you create and customize dials for an angular gauge.

baseWidth


Width of the bottom part of the dial (the part connected to pivot).

Type: Number

Range: In pixels

bgColor


Background color for dial. You can either specify a single color (e.g., CCCCCC) for solid fill or multiple colors separated by comma to attain a gradient fill.

Type: List of colors separated by comma

Range: Hex Color Code

borderAlpha


Border alpha for the dial.

Type: Number

Range: 0 - 100

borderColor


Border color for the dial.

Type: Color

Range: Hex Color Code

borderThickness


Border thickness for the dial.

Type: Number

Range: In pixels

editMode


Whether this dial will be editable?

Type: Boolean

Range: 0/1

id


Each dial can have a unique ID, using which it can be referred to in JavaScript and real-time data updates.

Type: String

Range:

radius


Radius for the dial (in pixels).

Type: Number

Range: In pixels

rearExtension


If you want the dial to extend beyond the pivot (in opposite side) for more realistic looks, you can set the extension distance (in pixels) using this attribute.

Type: Number

Range: In pixels

showValue


Whether to show value for this dial?

Type: Boolean

Range: 0/1

toolText


Each dial can have custom tool text using this attribute.

Type: String

Range:

topWidth


Width of the top part of dial.

Type: Number

Range: In pixels

value


Numerical value for the dial that will be shown on the chart.

Type: Number

Range:

valueX


Whether to place value textbox x-position?

Type: Number

Range: In pixels

valueY


Whether to place value textbox y-position?

Type: Number

Range: In pixels

baseRadius


Radius to be applied to the vertices of the pivot end of the dial. Default value is 0. Use this attribute along with non-zero rearExtension for better visualization. This attribute is not applicable if a topWidth is applied to the dial.

Type: Number

Range: In pixels

The trendPoint Object and the point Object


The point object, (child of the trendPoint object) is used to create a single or a range of reference points for a gauge. Although the point object has to be defined within the trendPoint object, trend-points points cannot be collectively customized using the the trendPoint object because it does not have any attributes of its own. These attributes let you create and customize trend-points for gauges.

borderColor


Lets you define the border color for trend-arc.

Type: Color

Range: Hex Color Code

color


Color of the trend point. The color of the text can be configured using Styles

Type: Color

Range: Hex Color Code

dashed


Whether the trend point should be rendered as dashed lines.

Default value: 0 (trendline rendered using straight lines)

Type: Boolean

Range: 0/1

dashLen


Sets the length of each dash when trend point is rendered as dashed lines.

Type: Number

Range: In pixels

dashGap


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

Type: Number

Range: In pixels

displayValue


Display label for the trend-point/trend-arc. If you do not specify a value, the chart displays the numeric value.

Type: String

Range:

endValue


The ending value for the trend-point. Say, if you want to plot a trend-arc from value 102 to 109, the endValue will be 109.

Type: Number

Range:

innerRadius


In case of trend-arc, radius for inner side of arc.

Type: Number

Range: In pixels

markerBorderColor


Border color of marker.

Type: Color

Range: Hex Color Code

markerColor


Fill color of marker.

Type: Color

Range: Hex Color Code

markerRadius


Radius of the marker.

Type: Number

Range: In pixels

markerTooltext


You can define the tooltip for a marker using this attribute.

Type: String

Range:

radius


Radius for trend point/outer side of trend-arc.

Type: Number (Pixels)

Range: In pixels

showBorder


If you're drawing a trend-arc, you can set its border on using this attribute.

Type: Boolean

Range: 0/1

startValue


The starting value for the trend-point. Say, if you want to plot a trend-arc from value 102 to 109, the startValue will be 102.

Type: Number

Range:

thickness


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

Type: Number

Range: In pixels

useMarker


You can opt to show a triangular marker for each trend-point by setting this attribute to 1.

Type: Boolean

Range: 0/1

valueInside


Whether to display the trend-point value inside the gauge?

Type: Boolean

Range: 0/1