Exago Logo
Search
Generic filters
Exact matches only

Chart Advanced Features: Combination 2D

The following sections provide a list of available advanced attributes available for controlling and customizing 2D Combination chart elements.

Note

This article contains documentation for advanced attributes which are third-party customizations that must be manually entered into the chart wizard. These articles were converted directly from the documentation provided by this third-party source. Not every attribute listed may be supported in Exago BI as some unexpected conflicts may occur in their integration within the application.

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.

AttributeTypeValueDescription
animationTrue/False0/1This attribute gives you the option to control animation in your charts. If you do not want to animate any part of the chart, set this as 0.
animationDurationNumberIn secondsThis attribute sets the animation duration of the chart. `animationDuration` attribute is applicable only if animation of the chart is enabled.
Default value: 1 sec
paletteNumber1-5Exago uses the concept of Color Palettes. Each chart has 5 pre-defined color palettes which you can choose from. Each palette renders the chart in a different color theme.
paletteColorsTextList of hex color codes separated by commaWhile the `palette` attribute allows to select a palette theme that applies to chart background, canvas, font and tool-tips, it does not change the colors of data items (i.e., column, line, pie etc.). Using `paletteColors` attribute, you can specify your custom list of hex colors for the data items. The list of colors have to be separated by comma e.g., `”paletteColors”: “#FF0000, #0372AB, #FF5904…”`. The chart will cycle through the list of specified colors and then render the data plot accordingly. To use the same set of colors throughout all your charts in a web application, you can store the list of palette colors in your application globally and then provide the same in each chart JSON.
connectNullDataTrue/False0/1This attribute lets you control whether empty data sets in your data will be connected to each other OR do they appear as broken data sets.
areaOverColumnsTrue/False0/1If you’ve both area and column plots on the combination chart, this attribute lets you configure whether area chart will appear over column chart.
showLabelsTrue/False0/1It sets the configuration whether the x-axis labels will be displayed or not.
maxLabelHeightNumberIn PixelsThis attribute can be used to set the maximum height for the x-axis labels (data labels) excluding the x-axis title. If any label goes beyond this height, the label will be truncated. In stagger mode, the number of stagger lines will be reduced if they exceed this value.
labelDisplayText‘AUTO’, ‘WRAP’, ‘STAGGER’, ‘ROTATE’, ‘NONE’Using this attribute, you can customize the alignment of data labels (x-axis labels). There are 5 options: AUTO, WRAP, STAGGER, ROTATE or NONE. By default, this attribute is set to AUTO mode which means that the alignment of the data labels is determined automatically depending on the size of the chart. WRAP wraps the label text if it is too long to fit in one line. ROTATE rotates the labels vertically. STAGGER divides the labels into multiple lines.
useEllipsesWhenOverflowTrue/False0/1When 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.
rotateLabelsTrue/False0/1This attribute lets you set whether the data labels will show up as rotated labels on the chart.
slantLabelsTrue/False0/1If you’ve opted to show rotated labels on chart, this attribute lets you set the configuration whether the labels will show as slanted labels or fully vertical ones.
labelStepNumber1 or aboveBy default, all the labels are displayed on the chart. However, if you’ve a set of streaming data (like name of months or days of week), you can opt to show every n-th label for better clarity. This attribute just lets you do so. When a value greater than 1 (n) is set to this attribute, the first label from left and every label at the n-th position from left will be displayed. e.g., a chart showing data for 12 months and set with `labelStep: 3` will show labels for January, April, July, and October. The rest of the labels will be skipped.
staggerLinesNumber2 or aboveIf you’ve opted for STAGGER mode as `labelDisplay`, using this attribute you can control how many lines to stagger the label to. By default, all labels are displayed in a single line.
showValuesTrue/False0/1Sets the configuration whether data values will be displayed along with the data plot on chart.
valuePositionText“ABOVE”, “BELOW”, “AUTO”If you’ve opted to show data values on the chart, this attribute lets you adjust the vertical alignment of data values with respect to dataplots. By default, this attribute is set to AUTO mode in which the alignment of each data value is determined automatically based on the position of each plot point. In ABOVE mode, data values are displayed above the plot points unless a plot point is too close to the upper edge of the canvas while in BELOW mode, data values are displayed below the plot points unless a plot point is too close to the lower edge of the canvas.
rotateValuesTrue/False0/1If you’ve opted to show data values, you can rotate them using this attribute.
placeValuesInsideTrue/False0/1If you’ve opted to show data values, you can show them inside the columns using this attribute. By default, the data values show outside the column.
showLimitsTrue/False0/1Whether to show chart limit values. If not specified `showYAxisValues` attribute overrides this value.
showDivLineValuesTrue/False0/1Whether to show div line values. If not specified `showYAxisValues` attribute overrides this value.
showShadowTrue/False0/1Whether to apply the shadow effects for data plot.
adjustDivTrue/False0/1Exago automatically tries to adjust divisional lines and limit values based on the data provided. However, if you want to set your explicit lower and upper limit values and number of divisional lines, first set this attribute to false. That will disable automatic adjustment of divisional lines.
clickURLTextAnyThe 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 Exago Link format.
clickURLOverridesPlotLinksTrue/False0/1Sets 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`)
setAdaptiveYMinTrue/False0/1This attribute lets you set whether the y-axis lower limit will be 0 (in case of all positive values on chart) or should the y-axis lower limit adapt itself to a different figure based on values provided to the chart.
hasRTLTextNumberAnyThis 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.
plotHighlightEffectTextAnyThis 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`
showPrintMenuItemTrue/False0/1Whether 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.
plotBinSizeNumberIn PixelsThis attribute is used to skip the data plot without any change in visualization. When set to `1`, minimum one data plot will be rendered within the width of one pixel.
Example, if `plotBinSize: 1`, minimum one column plot will be rendered within the width of one pixel. For line and area charts, minimum of two anchors connecting one single line will be drawn. If `plotBinSize: 0.5`, minimum two column plot will be rendered within the width of one pixel. Data skipping can be disabled by setting this attribute to `0`.
Default value: `0.5`
labelBinSizeNumberIn PixelsThis attribute is used to skip the labels of the data plots. When set to `1`, minimum one label will be displayed within the width of one pixel. To disable this label skipping, set this attribute to `0`.
Default value: `1`
themeText‘fusion’, ‘gammel’, ‘candy’, ‘ocean’, ‘zune’, ‘carbon’, ‘umber’This attribute changes the theme of the chart. There are 7 types of themes which have been made according to the different color combinations.

Chart Message-related Attributes

These attributes let you set and configure custom chart messages, using text as well as images.

AttributeTypeValueDescription
baseChartMessageFontTextAnyThis attribute allows to set a custom font for all chart messages.
baseChartMessageFontSizeNumberIn pixelsThis attribute allows to set a custom font size for all chart messages.
baseChartMessageColorColorHex Color CodeThis attribute allows to set a custom font color for all chart messages.
baseChartMessageImageHAlignTextleft, middle, rightThis attribute allows to set a custom horizontal alignment for all images displayed as chart messages.
Default value: middle
baseChartMessageImageVAlignTexttop, middle, bottomThis attribute allows to set a custom vertical alignment for all images displayed as chart messages.
Default value: middle
baseChartMessageImageAlphaNumber0 – 100This attribute allows to set a transparency for all images displayed as chart messages.
Default value: 100
baseChartMessageImageScaleNumber0-300This attribute allows to set a scale for magnifying all images displayed as chart messages.
Default value: 100
loadMessageTextAnyThis 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.
loadMessageFontTextFont NameThis attribute allows to set the font for the message displayed when a chart begins to load.
loadMessageFontSizeNumberIn pixelsThis attribute allows to set the font size for the message displayed when a chart begins to load.
loadMessageColorColorHex Color CodeThis attribute allows to set the font color for the message displayed when a chart begins to load.
loadMessageImageHAlignTextleft, middle, rightIf 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
loadMessageImageVAlignTexttop, middle, bottomIf 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
loadMessageImageAlphaNumber0 – 100If an image is displayed as the chart `loadMessage`, this attribute allows to set the transparency of the image.
Default value: 100
loadMessageImageScaleNumber0-300If an image is displayed as the chart `loadMessage`, this attribute allows to set the scale for magnifying the image.
Default value: 100
typeNotSupportedMessageTextAnyThis 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.
typeNotSupportedMessageFontTextFont NameThis attribute allows to set the font for the message displayed when the specified chart type is not supported.
typeNotSupportedMessageFontSizeNumberIn pixelsThis attribute allows to set the font size for the message displayed when the specified chart type is not supported.
typeNotSupportedMessageColorColorHex Color CodeThis attribute allows to set the font color for the message displayed when the specified chart type is not supported.
typeNotSupportedMessageImageHAlignTextleft, middle, rightIf 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
typeNotSupportedMessageImageVAlignTexttop, middle, bottomIf 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
typeNotSupportedMessageImageAlphaNumber0 – 100If an image is displayed as the chart `typeNotSupportedMessage`, this attribute allows to set the transparency of the image.
Default value: 100
typeNotSupportedMessageImageScaleNumber0-300If an image is displayed as the chart `typeNotSupportedMessage`, this attribute allows to set the scale for magnifying the image.
Default value: 100
renderErrorMessageTextAnyThis 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.
renderErrorMessageFontTextFont NameThis attribute allows to set a font for the message displayed if an error is encountered while rendering the chart.
renderErrorMessageFontSizeNumberIn pixelsThis attribute allows to set the font size for the message displayed if an error is encountered while rendering the chart.
renderErrorMessageColorColorHex Color CodeThis attribute allows to set the font color for the message displayed if an error is encountered while rendering the chart.
renderErrorMessageImageHAlignTextleft, middle, rightIf 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
renderErrorMessageImageVAlignTexttop, middle, bottomIf 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
renderErrorMessageImageAlphaNumber0 – 100If an image is displayed as the chart `renderErrorMessage`, this attribute allows to set the transparency of the image.
Default value: 100
renderErrorMessageImageScaleNumber0-300If an image is displayed as the chart `renderErrorMessage`, this attribute allows to set the scale for magnifying the image.
Default value: 100
dataLoadStartMessageTextAnyThis 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.
dataLoadStartMessageFontTextFont NameThis attribute allows to set a font for the message displayed when chart data begins loading.
dataLoadStartMessageFontSizeTextIn pixelsThis attribute allows to set the font size for the message displayed when chart data begins loading.
dataLoadStartMessageColorColorHex Color CodeThis attribute allows to set the font color for the message displayed when chart data begins loading.
dataLoadStartMessageImageHAlignTextleft, middle, rightIf 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
dataLoadStartMessageImageVAlignTexttop, middle, bottomIf 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
dataLoadStartMessageImageAlphaNumber0 – 100If an image is displayed as the chart `dataLoadStartMessage`, this attribute allows to set the transparency of the image.
Default value: 100
dataLoadStartMessageImageScaleNumber0-300If an image is displayed as the chart `dataLoadStartMessage`, this attribute allows to set the scale for magnifying the image.
Default value: 100
dataEmptyMessageTextAnyThis 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.
dataEmptyMessageFontTextFont NameThis attribute allows to set the font for the message displayed if the data loaded for a chart is empty
dataEmptyMessageFontSizeNumberIn pixelsThis attribute allows to set the font size for the message displayed if the data loaded for a chart is empty.
dataEmptyMessageColorColorHex Color CodeThis attribute allows to set the font color for the message displayed if the data loaded for a chart is empty.
dataEmptyMessageImageHAlignTextleft, middle, rightIf 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
dataEmptyMessageImageVAlignTexttop, middle, bottomIf 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
dataEmptyMessageImageAlphaNumber0 – 100If an image is displayed as the chart `dataEmptyMessage`, this attribute allows to set the transparency of the image.
Default value: 100
dataEmptyMessageImageScaleNumber0-300If an image is displayed as the chart `dataEmptyMessage`, this attribute allows to set the scale for magnifying the image.
Default value: 100
dataLoadErrorMessageTextAnyThis 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.
dataLoadErrorMessageFontTextFont NameThis attribute allows to set a font for the message displayed if an error is encountered while loading chart data.
dataLoadErrorMessageFontSizeNumberIn pixelsThis attribute allows to set the font size for the message displayed if an error is encountered while loading chart data.
dataLoadErrorMessageColorColorHex Color CodeThis attribute allows to set the font color for the message displayed if an error is encountered while loading chart data.
dataLoadErrorMessageImageHAlignTextleft, middle, rightIf 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
dataLoadErrorMessageImageVAlignTexttop, middle, bottomIf 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
dataLoadErrorMessageImageAlphaNumber0 – 100If an image is displayed as the chart `dataLoadErrorMessage`, this attribute allows to set the transparency of the image.
Default value: 100
dataLoadErrorMessageImageScaleNumber0-300If an image is displayed as the chart `dataLoadErrorMessage`, this attribute allows to set the scale for magnifying the image.
Default value: 100
dataInvalidMessageTextAnyThis 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.
dataInvalidMessageFontTextFont NameThis attribute allows to set the font for the message displayed if the specified chart data is invalid.
dataInvalidMessageFontSizeNumberIn pixelsThis attribute allows to set the font size for the message displayed if the specified chart data is invalid.
dataInvalidMessageColorColorHex Color CodeThis attribute allows to set the font color for the message displayed if the specified chart data is invalid.
dataInvalidMessageImageHAlignTextleft, middle, rightIf 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
dataInvalidMessageImageVAlignTexttop, middle, bottomIf 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
dataInvalidMessageImageAlphaNumber0 – 100If an image is displayed as the chart `dataInvalidMessage`, this attribute allows to set the transparency of the image.
Default value: 100
dataInvalidMessageImageScaleNumber0-300If an image is displayed as the chart `dataInvalidMessage`, this attribute allows to set the scale for magnifying the image.
Default value: 100

Chart Titles and Axis Names

Using these attributes, you can set the various headings and titles of chart like caption, sub-caption, x-axis and y-axis names etc.

AttributeTypeValueDescription
captionTextAnyCaption of the chart.
subCaptionTextAnySub-caption of the chart.
xAxisNameTextAnyX-axis title of the chart.
yAxisNameTextAnyY-axis title of the chart.

Chart Caption Cosmetics

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

AttributeTypeValueDescription
captionAlignmentText“left”, “center”, “right”Sets horizontal alignment of caption
captionOnTopTrue/False0/1Whether caption should be on top of the data plot area
captionFontSizeNumber6 – 72Sets the caption font size in pixels
subCaptionFontSizeNumber6 – 72Sets the sub-caption font size (in pixels)
captionFontTextFont NameSets the caption font family
subCaptionFontTextFont NameSets the sub-caption font family
captionFontColorColorHex Color CodeSets the caption font color
subCaptionFontColorColorHex Color CodeSets the sub-caption font color
captionFontBoldTrue/False0/1Whether the caption font should be displayed in bold
subCaptionFontBoldTrue/False0/1Whether the sub caption font should be displayed in bold
alignCaptionWithCanvasTrue/False0/1Whether the caption is aligned with the canvas. Else, it will be aligned with the entire chart area
captionHorizontalPaddingNumberIn PixelsIf caption is not centre aligned, lets you configure the padding (in pixels) from either edge. Will be ignored if caption is centre aligned.

Chart Axis Configuration Attributes

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

AttributeTypeValueDescription
transposeAxisTrue/False0/1If you hide a dataset using legend icon, this attribute (when set to `1`) will compute the axes limit with respect to maximum and minimum value of the visible dataset(s).
Default value: 0
showXAxisLineTrue/False0/1This attribute if set to _0_, hides the x-axis of the chart.

Default value: 1

xAxisPositionTextTop, BottomThis attribute sets the position of the x-axis in the chart.

Default value: Bottom

yAxisPositionTextLeft, RightThis attribute sets the position of the y-axis in the chart.

Default value: Left

xAxisLineColorColorHex Color CodeSets color of the x-axis of the chart.
xAxisLineThicknessNumberIn PixelsSets the thickness of the x-axis line of the chart.
showYAxisLineTrue/False0/1This attribute if set to _0_, hides the y-axis of the chart.

Default value: 1

yAxisLineColorColorHex Color CodeSets color of the y-axis of the chart.
yAxisLineThicknessNumberIn PixelsSets the thickness of the y-axis line of the chart.
showYAxisValuesTrue/False0/1Exago y-axis is divided into vertical sections using div (divisional) lines. Each div line assumes a value based on its position. Using this attribute you can set whether to show those div line (y-axis) values or not. This attribute shows or hides the y-axis divisional lines and limits. The values of `showLimits` and `showDivLineValues`, if specified explicitly, overrides the value of this attribute.
yAxisValuesStepNumber1 or aboveBy default, all div lines show their values. However, you can opt to display every x(th) div line value using this attribute.
rotateYAxisNameTrue/False0/1If you do not wish to rotate y-axis name, set this as 0. It specifically comes to use when you’ve the special characters (UTF-8) in your y-axis name that do not show up in rotated mode.
yAxisNameWidthNumber(In Pixels)If you opt to not rotate y-axis name, you can choose a maximum width that will be applied to y-axis name.
yAxisMinValueNumberNumeric ValueThis attribute helps you explicitly set the lower limit of the chart. If you don’t specify this value, it is automatically calculated by Exago based on the data provided by you.
yAxisMaxValueNumberNumeric ValueThis attribute helps you explicitly set the upper limit of the chart. If you don’t specify this value, it is automatically calculated by Exago based on the data provided by you.
forceYAxisValueDecimalsTrue/False0/1Whether to forcefully attach decimal places to all y-axis values. For example, If you limit the maximum number of decimal digits to 2, a number like 55.345 will be rounded to 55.34. This does not mean that all y-axis numbers will be displayed with a fixed number of decimal places. For instance 55 will not be displayed as 55.00 and 55.1 will not become 55.10. In order to have fixed number of decimal places attached to all y-axis numbers, set this attribute to 1.
yAxisValueDecimalsNumber0-10If you’ve opted to not adjust div lines, you can specify the div line values decimal precision using this attribute.

x-Axis Name Cosmetics

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

AttributeTypeValueDescription
xAxisNameFontTextFont NameSets the x-axis font family for the text
xAxisNameFontColorColorHex Color CodeSets the x-axis font color
xAxisNameFontSizeNumber6 – 72Specifies the x-axis font size
xAxisNameFontBoldTrue/False0/1Whether x-axis font should be bold
xAxisNameFontItalicTrue/False0/1Whether x-axis font should be italicized
xAxisNameBgColorColorHex Color CodeSets the background color for x-axis text
xAxisNameBorderColorColorHex Color CodeSets the border around the x-axis text
xAxisNameAlphaNumber0 – 100Sets the x-axis alpha including font and background
xAxisNameFontAlphaNumber0 – 100Sets the x-axis font alpha
xAxisNameBgAlphaNumber0 – 100Sets the x-axis background alpha
xAxisNameBorderAlphaNumber0 – 100Sets the x-axis border alpha
xAxisNameBorderPaddingNumberIn PixelsSets the x-axis border padding
xAxisNameBorderRadiusNumberIn PixelsSets the x-axis border radius
xAxisNameBorderThicknessNumberIn PixelsSets the x-axis border thickness
xAxisNameBorderDashedTrue/False0/1Whether the border around the x-axis name should be rendered using dashed lines.

Default value: 0 (border rendered using straight lines)

xAxisNameBorderDashLenNumberIn pixelsSets the length of each dash when the border around the x-axis name is rendered using dashed lines.
xAxisNameBorderDashGapNumberIn pixelsSets the gap between consecutive dashes when the border around the x-axis name is rendered using dashed lines.

y-Axis Name Cosmetics

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

AttributeTypeValueDescription
yAxisNameFontTextFont NameSets the y-axis (primary / secondary) font family for the text
yAxisNameFontColorColorHex Color CodeSets the y-axis (primary / secondary) font color
yAxisNameFontSizeNumber6 – 72Specifies the y-axis (primary / secondary) font size
yAxisNameFontBoldTrue/False0/1Whether y-axis (primary / secondary) font should be bold
yAxisNameFontItalicTrue/False0/1Whether y-axis (primary / secondary) font should be italicized
yAxisNameBgColorColorHex Color CodeSets the background color for y-axis (primary / secondary) text
yAxisNameBorderColorColorHex Color CodeSets the border around the y-axis (primary / secondary) text
yAxisNameAlphaNumber0 – 100Sets the y-axis (primary / secondary) alpha including font and background
yAxisNameFontAlphaNumber0 – 100Sets the y-axis (primary / secondary) font alpha
yAxisNameBgAlphaNumber0 – 100Sets the y-axis (primary / secondary) background alpha
yAxisNameBorderAlphaNumber0 – 100Sets the y-axis (primary / secondary) border alpha
yAxisNameBorderPaddingNumberIn PixelsSets the y-axis (primary / secondary) border padding
yAxisNameBorderRadiusNumberIn PixelsSets the y-axis (primary / secondary) border radius
yAxisNameBorderThicknessNumberIn PixelsSets the y-axis (primary / secondary) border thickness
yAxisNameBorderDashedTrue/False0/1Whether the border around the y-axis name should be rendered using dashed lines.

Default value: 0 (border rendered using straight lines)

yAxisNameBorderDashLenNumberIn pixelsSets the length of each dash when the border around the y-axis name is rendered using dashed lines.
yAxisNameBorderDashGapNumberIn pixelsSets the gap between two consecutive dashes when the border around the y-axis name is rendered using dashed lines.

Chart Cosmetics

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

AttributeTypeValueDescription
showBorderTrue/False0/1Whether to show a border around the chart or not.
borderColorColorHex Color CodeBorder color of the chart.
borderThicknessNumberIn PixelsBorder thickness of the chart.
borderAlphaNumber0 – 100Border alpha of the chart.
bgColorColorHex Color CodeThis 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`.
bgAlphaNumber0 – 100Sets 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.
bgRatioNumber0 – 100If you’ve opted for a gradient background, this attribute lets you set the ratio of each color constituent.
bgAngleNumber0-360Sets the angle of the background color, in case of a gradient.
bgImageTextAnyTo place any image (JPG/PNG/GIF) as background of the chart, enter the (path and) name of the background image as a URL without quotes around it. It should be in the same domain as the chart.
bgImageAlphaNumber0 – 100This attribute specifies the opacity for the loaded background image.
bgImageDisplayModeTextstretch, tile, fit, fill, center, noneHelps 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.
bgImageVAlignTexttop, middle, bottomHelps you to vertically align the background image.
bgImageHAlignTextleft, middle, rightHelps you to horizontally align the background image.
bgImageScaleNumber0-300Helps you magnify the background image.This attribute will only work when the attribute `bgImageDisplayMode` is set to none, center, or tile.
showcanvasborderTrue/False0/1This attribute if set to _1_, shows a border around the canvas of the chart.

Default value: 0

canvasBgColorColorHex Color CodeThis attribute sets the background color for the chart canvas. You can set any hex color code as the value of this attribute. To specify a gradient as canvas background color, separate the hex color codes of each color in the gradient using comma. Example: #FF5904, #FFFFFF.
canvasBgAlphaNumber0 – 100This attribute sets the background transparency for the chart canvas. For gradient, separate the alpha value using comma. Example: 15, 50.
canvasBgRatioNumbers separated by comma0 – 100When a gradient is used to set the color of the canvas background, this attribute sets the ratio of the colors. Example : If the value of the `canvasBgColor` attribute is set as `#FF5904, #FFFFFF`, `canvasBgRatio` can be used to specify their ratio in the background.
canvasBgAngleNumber0-360Helps you specify canvas background angle in case of gradient.
canvasBorderColorColorHex Color CodeLets you specify canvas border color.
canvasBorderThicknessNumber0-5Lets you specify canvas border thickness.
canvasBorderAlphaNumber0 – 100Lets you control transparency of canvas border.
showVLineLabelBorderTrue/False0/1If you’ve opted to show a label for any of your vLines in the chart, you can collectively configure whether to show border for all such labels using this attribute. If you want to show label border for just a particular vLine, you can over-ride this value by specifying border configuration for that specific vLine.
rotateVLineLabelsTrue/False0/1This attribute lets you set whether the vline labels will show up as rotated labels on the chart.
Default value: 0
logoURLTextURLYou 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.
logoLeftMarginNumberIn PixelsThis 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.
logoTopMarginNumberIn PixelsThis 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.
logoPositionTextTL TR BL BR CCWhere to position the logo on the chart: TL – Top-left TR – Top-right BR – Bottom right BL – Bottom left CC – Center of screen
logoAlphaNumber0 – 100Once the logo has loaded on the chart, you can configure its opacity using this attribute.
logoScaleNumber0-300You can also change the scale of an externally loaded logo at run-time by specifying a value for this parameter.
logoLinkTextURLIf you want to link the logo to an external URL, specify the link in this attribute. The link can be in Exago Link format, allowing you to link to new windows, pop-ups, frames etc.

Data Plot Cosmetics

These attributes let you configure how your plot (columns, lines, area, pie or any data that you’re plotting) will appear on the chart. If the plots can show borders, you can control the border properties using the attributes listed below. Or, if they support gradient fills, you can again configure various properties of the gradient using these attributes. Various other controls over plot cosmetics can be attained using this set of attributes.

AttributeTypeValueDescription
useRoundEdgesTrue/False0/1If you wish to plot columns with round edges and fill them with a glass effect gradient, set this attribute to 1. The following functionalities will not work when this attribute is set to 1: `showShadow` attribute doesn’t work any more. If you want to remove shadow from columns, you’ll have to over-ride the shadow with a new shadow style (applied to DATAPLOT) with alpha as 0. Plot fill properties like gradient color, angle etc. will not work any more, as the colors for gradient are now calculated by the chart itself. Plot border properties also do not work in this mode. Also, you cannot render the border as dashed in this mode.
showPlotBorderTrue/False0/1Whether the column, area border will show up.
plotBorderColorColorHex Color CodeColor for column, area border
plotBorderThicknessNumber0-5Thickness for column, area border
plotBorderAlphaNumber0 – 100Alpha for column, area border
plotBorderDashedTrue/False0/1Whether the border around the data plots should be rendered using dashed lines.

Default value: 0 (border rendered using straight lines)

plotBorderDashLenNumberIn pixelsSets the length of each dash when the border around the data plots are rendered using dashed lines.
plotBorderDashGapNumberIn pixelsSets the gap between two consecutive dashes when the border around the data plots are rendered using dashed lines.
plotFillAngleNumber0-360If you’ve opted to fill the plot (column, area etc.) as gradient, this attribute lets you set the fill angle for gradient.
plotFillAlphaNumber0 – 100If you’ve opted to fill the plot (column, area etc.) as gradient, this attribute lets you set the fill alpha for gradient.
plotGradientColorColorHex Color CodeYou can globally add a gradient color to the entire plot of chart by specifying the second color as this attribute. For example, if you’ve specified individual colors for your columns and now you want a gradient that ends in white. You need to specify FFFFFF (white) as this color and the chart will now draw plots as gradient.
lineColorColorHex Color CodeColor using which the lines on the chart will be drawn.
lineThicknessNumberIn PixelsThickness of the lines on the chart.
lineAlphaNumber0 – 100Alpha of the lines on the chart.
lineDashedTrue/False0/1Whether the lines should be rendered as dashed lines.

Default value: 0 (lines rendered using straight lines)

lineDashLenNumberIn pixelsSets the length of each dash when lines are rendered as dashed lines.
lineDashGapNumberIn pixelsSets the gap between consecutive dashes when lines are rendered as dashed lines.
usePlotGradientColorTrue/False0/1Gradient color is a color added globally to the entire plot of chart by specifying the second color in an attribute. This attribute sets the gradient color to _true_.

Default value: 1

minPlotHeightForValueNumberIn PixelsSet the minimum height in pixel of a column above which the data values will be visible.
drawFullAreaBorderTrue/False0/1If the `showPlotBorder` atrribute is set to `1`, set this attribute to `0` to draw only the top border of the data plot.
inheritPlotBorderColorTrue/False0/1Set this attribute to `1` to inherit the data plot color of the area chart as the color of the data plot border.

Data Value Cosmetics

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

AttributeTypeValueDescription
valueFontTextFont NameSets the font of the values in the chart
valueFontColorColorHex Color CodeSpecifies the value font color
valueFontSizeNumber6 – 72Specifies the value font size
valueFontBoldTrue/False0/1Whether value font should be bold
valueFontItalicTrue/False0/1Whether value font should be italicized
valueBgColorColorHex Color CodeSets the background color for value text
valueBorderColorColorHex Color CodeSets the border color around the value text
valueAlphaNumber0 – 100Sets the value alpha including font and background
valueFontAlphaNumber0 – 100Sets the value font alpha
valueBgAlphaNumber0 – 100Sets the value background alpha
valueBorderAlphaNumber0 – 100Sets the value border alpha
valueBorderThicknessNumberIn PixelsSets the value border thickness
valueBorderPaddingNumberIn PixelsSets the padding between the value and its surrounding border
valueBorderRadiusNumberIn PixelsSets the value border radius
valueBorderDashedTrue/False0/1Whether the border around the data values should be rendered using dashed lines.

Default value: 0 (border rendered using straight lines)

valueBorderDashLenNumberIn pixelsSets the length of each dash when the border around the data values is rendered using dashed lines.
valueBorderDashGapNumberIn pixelsSets the gap between two consecutive dashes when the border around the data values is rendered using dashed lines.
textOutlineTrue/False0/1Set this attribute to `1` to draw a border on the data value text.
Default value: 0

Y-Axis Value Cosmetics

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

AttributeTypeValueDescription
yAxisValueFontTextFont NameSet the font family for the Y-axis value texts.
Default value: verdana,sans
valueFontColorColorHex Color CodeSets the font color for the Y-axis value texts.
Default value: #555555
yAxisValueFontSizeNumber6 – 72Sets the font size for the Y-axis value texts.
Default value: 10 px
yAxisValueFontBoldTrue/False0/1Displays the Y-axis value texts in bold.
Default value: 0
yAxisValueFontItalicTrue/False0/1Displays the Y-axis value texts in italic.
Default value: 0
yAxisValueBgColorColorHex Color CodeSets the background color for the Y-axis values.
yAxisValueBorderColorColorHex Color CodeSets the border color for the Y-axis values.
yAxisValueAlphaNumber0 – 100Sets the transparency for the Y-axis values between transparent (for `0`) and opaque (for `100`).
Default value: 100
yAxisValueBgAlphaNumber0 – 100Sets the transparency for the Y-axis value backgrounds between transparent (for `0`) and opaque (for `100`).
yAxisValueBorderAlphaNumber0 – 100Sets the transparency for the Y-axis values between transparent (for `0`) and opaque (for `100`).
yAxisValueBorderPaddingNumberIn PixelsSets the border padding for the Y-axis values.
yAxisValueBorderRadiusNumberIn PixelsSets the border radius for the Y-axis values.
yAxisValueBorderThicknessNumberIn PixelsSets the border thickness for the Y-axis values.
yAxisValueBorderDashedTrue/False0/1Makes the Y-axis value borders dashed.
Default value: 0 (border rendered using straight lines)
yAxisValueBorderDashLenNumberIn pixelsSets the lengths of the individual dashes when the Y-axis value borders are dashed.
yAxisValueBorderDashGapNumberIn pixelsSets the gaps between individual dashes when the Y-axis value borders are dashed.
yAxisValueLinkURLAnySets a target link for all Y-axis values.

Anchors

On line/area charts, anchors (or marker points) are polygons which appear at the joint of two consecutive line/area points. These are indicators to show the position of data points. The anchors handle tool tips and links for the data points. So, if you opt to not render anchors on a chart, the tool tips and links won’t function. You can, however, hide them by setting alpha to 0 and still enable tool tips and links. You can customize all the facets of anchors using the properties below.

AttributeTypeValueDescription
drawAnchorsTrue/False0/1Whether to draw anchors on the chart.
anchorSidesNumber3-20This attribute sets the number of sides the anchor will have. For e.g., an anchor with 3 sides will represent a triangle, with 4 it will be a square and so on.
anchorStartAngleNumber0 – 360This attribute sets the starting angle of anchors.
Default value: 90
anchorRadiusNumberIn pixelsThis attribute sets the radius (in pixels) of the anchor.
anchorBorderColorColorHex Color CodeLets you set the border color of anchors.
anchorBorderThicknessNumberIn PixelsHelps you set border thickness of anchors.
anchorBgColorColorHex Color CodeHelps you set the background color of anchors.
anchorAlphaNumber0 – 100Helps you set the alpha of entire anchors. If you need to hide the anchors on chart but still enable tool tips, set this as 0.
anchorBgAlphaNumber0 – 100Helps you set the alpha of anchor background.
anchorImageUrlExago link formatURLIf you want to use an external image (JPG/PNG) as an anchor, this attribute lets you specify the URL.

Note: Due to cross domain security restrictions it is advised to use an image from the same domain name as your charts.

anchorImageAlphaNumber0 – 100This attribute allows to set a transparency for images displayed as anchors in charts.

Default value: 100

anchorImageScaleNumber0 – 100This attribute allows to set a scale for magnifying images displayed as anchors.

Default value: 100

anchorImagePaddingNumberIn PixelsThis attribute sets the padding between the anchor image and the border of the anchor. For the anchor image, instead of decreasing the size of the image this attribute crops the image.
Default value: 1

Divisional Lines & Grids

Using this set of attributes, you can control the properties of divisional lines, zero plane and alternate color bands. Divisional Lines are horizontal or vertical lines running through the canvas. Each divisional line signifies a smaller unit of the entire axis thus aiding the users in interpreting the chart. The zero plane is a 2D/3D plane that signifies the 0 position on the chart. If there are no negative numbers on the chart, you won’t see a visible zero plane. Alternate color bands are colored blocks between two successive divisional lines.

AttributeTypeValueDescription
numDivLinesNumberNumeric value > 0Number of horizontal axis division lines that you want on the chart.
divLineColorColorHex Color CodeColor for divisional lines.
divLineThicknessNumber1-5Thickness of divisional lines.
divLineAlphaNumber0 – 100Alpha of divisional lines.
divLineDashedTrue/False0/1Whether the divisional lines should be rendered as dashed lines.

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

divLineDashLenNumberIn pixelsSets the length of each dash when divisional lines are rendered as dashed lines.
divLineDashGapNumberIn pixelsSets the gap between two consecutive dashes when divisional lines are rendered as dashed lines.
zeroPlaneColorColorHex Color CodeColor for the Zero Plane. Zero Plane is the line/plane that appears at position 0 on the y-axis, when negative data is being shown on the chart.
zeroPlaneThicknessNumberIn PixelsThickness of zero plane.
zeroPlaneAlphaNumber0 – 100Alpha of zero plane.
showZeroPlaneValueTrue/False0/1Allows you to show or hide the value on which the zero plane exists on the y-axis. By default, the value is displayed.
showAlternateHGridColorTrue/False0/1Whether to show alternate colored horizontal grid bands.
alternateHGridColorColorHex Color CodeColor of the alternate horizontal grid bands.
alternateHGridAlphaNumber0 – 100Alpha (transparency) of the alternate horizontal grid bands.

Legend Properties

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

AttributeTypeValueDescription
showLegendTrue/False0/1Whether to show legend on the chart.
legendItemFontBoldTrue/False0/1Whether legend keys should be displayed in bold
legendItemFontTextFont NameSets legend item font
legendItemFontSizeNumber6 – 72Sets legend item font size
legendItemFontColorColorHex Color CodeSets legend item font color
legendItemHoverFontColorColorHex Color CodeSets legend item font color on hover
legendPositionTextbottom, right, top, top-left, top-right, bottom-left, bottom-right, left, left-top, left-bottom, right, right-top, right-bottom, and absoluteThe 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.
legendXPositionNumber0 to chart width (in pixels)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`.
legendYPositionNumber0 to chart height (in pixels)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`.
legendNumRowsNumberAnySets the number of rows the legend should display.
legendNumColumnsNumberAnySets the number of columns the legend should display.
legendCaptionAlignmentText“left”, “center”, “right”Sets the legend caption horizontal alignment .
legendCaptionFontBoldTrue/False0/1Whether legend caption should be displayed in bold
legendCaptionFontTextFont NameSets legend caption font
legendCaptionFontSizeNumber6 – 72Sets legend caption font size
legendCaptionFontColorColorHex Color CodeSets legend caption font color
legendCaptionText You can add a caption for the entire legend by setting the same here.
legendItemHiddenColorColorHex Color CodeSets the color that applies on both text font and icon when they are in a disabled / hidden state
legendIconScaleNumber1-5Scaling of legend icon is possible in Exago. This attribute lets you control the size of legend icon.
legendBgColorColorHex Color CodeBackground color for the legend.
legendBgAlphaNumber0 – 100Background alpha for the legend.
legendBorderColorColorHex Color CodeBorder Color for the legend.
legendBorderThicknessNumberIn PixelsBorder thickness for the legend.
legendBorderAlphaNumber0 – 100Border alpha for the legend.
legendShadowTrue/False0/1Whether to show a shadow for legend.
legendAllowDragTrue/False0/1The 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.
legendScrollBgColorColorHex Color CodeIf 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.
reverseLegendTrue/False0/1You can reverse the ordering of datasets in the legend by setting this attribute to 1.
interactiveLegendTrue/False0/1This attribute lets you interact with the legend in your chart. When you click a legend key, the dataplots associated with that series are eliminated from the chart. Re-clicking the key causes the dataplots to reappear.
legendNumColumnsNumberPositive IntegerIf your chart contains multiple series, the legend is displayed as a grid comprising of multiple legend keys. With the help of this attribute you can specify the number of columns that are to be displayed in the legend.
minimiseWrappingInLegendTrue/False0/1Whether to minimize legend item text wrapping.
drawCustomLegendIconTrue/False0/1Specifies 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)
legendIconBorderColorColorHex Color CodeSets the border color for the legend icon.
Default value: Data plot border color
legendIconBgColorColorHex Color CodeSets the background color for the legend icon.
Default value: Data plot fill color
legendIconAlphaNumber0 – 100Sets the legend icon transparency.
Default value: 100
legendIconBgAlphaNumber0 – 100Sets the legend icon background transparency.
Default value: 100
legendIconSidesNumberAnySets the number of sides for the legend icon.
Default value: 4
legendIconBorderThicknessNumber1-5Sets the thickness of the legend icon border.
Default value: 1
legendIconStartAngleNumberAnySets the starting angle of for drawing the legend icon.
Default value: 45
alignLegendWithCanvasTrue/False0/1This 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.

Number Formatting

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

AttributeTypeValueDescription
formatNumberTrue/False0/1This 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’;.
formatNumberScaleTrue/False0/1Configuration 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.
defaultNumberScaleTextAnyThe default unit of the numbers that you’re providing to the chart.
numberScaleUnitTextAnyUnit of each block of the scale.
numberScaleValueTextAnyRange of the various blocks that constitute the scale.
forceNumberScaleTrue/False0/1If 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`.
scaleRecursivelyTrue/False0/1Whether recursive scaling should be applied.
maxScaleRecursionNumberAnyHow many recursions to complete during recursive scaling? -1 completes the entire set of recursion.
scaleSeparatorTextAnyWhat character to use to separate the scales that are generated after recursion?
numberPrefixTextCharacterUsing 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.
numberSuffixTextCharacterUsing this attribute, you could add a suffix to all the numbers visible on the graph. For example, to represent all figures quantified as per annum on the chart, you could specify this attribute to ‘/a’ to show like 40000/a, 50000/a.
decimalSeparatorTextCharacterThis attribute helps you specify the character to be used as the decimal separator in a number.
thousandSeparatorTextCharacterThis attribute helps you specify the character to be used as the thousands separator in a number.
thousandSeparatorPositionNumber This option helps you specify the position of the thousand separator.
inDecimalSeparatorTextCharacterIn some countries, commas are used as decimal separators and dots as thousand separators. In XML, if you specify such values, it will give an error while converting to number. So, Exago 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.
inThousandSeparatorTextCharacterIn some countries, commas are used as decimal separators and dots as thousand separators. In XML, if you specify such values, it will give an error while converting to number. So, Exago 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.
decimalsNumber0-10Number of decimal places to which all numbers on the chart will be rounded to.
forceDecimalsTrue/False0/1Whether to add 0 padding at the end of decimal numbers. For example, If you limit the maximum number of decimal digits to 2, a number like 55.345 will be rounded to 55.34. This does not mean that all numbers will be displayed with a fixed number of decimal places. For instance 55 will not be displayed as 55.00 and 55.1 will not become 55.10. In order to have fixed number of decimal places attached to all the numbers, set this attribute to 1.

Font Properties

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

AttributeTypeValueDescription
baseFontTextFont NameThis 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.
baseFontSizeNumber6 – 72This 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.
baseFontColorColorHex Color CodeThis 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.
outCnvBaseFontTextFont NameThis attribute sets the base font family of the chart text which lies outside the canvas i.e., all the values and the names in the chart which lie outside the canvas will be displayed using the font name provided here.
outCnvBaseFontSizeNumber6 – 72This attribute sets the base font size of the chart i.e., all the values and the names in the chart which lie outside the canvas will be displayed using the font size provided here.
outCnvBaseFontColorColorHex Color CodeThis attribute sets the base font color of the chart i.e., all the values and the names in the chart which lie outside the canvas will be displayed using the font color provided here.

Data Label Cosmetics

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

AttributeTypeValueDescription
labelFontTextFont NameSets the x-axis label font family for the text.
labelFontColorColorHex Color CodeSets the x-axis label font color.
labelFontSizeNumber6 – 72Specifies the x-axis label font size.
labelFontBoldTrue/False0/1Flag indicating whether x-axis label font should be bold or not.
labelFontItalicTrue/False0/1Flag indicating whether x-axis label font should be italicized or not.
labelBgColorColorHex Color CodeSets the background color for x-axis label text.
labelBorderColorColorHex Color CodeSets the color of the border around the x-axis label text.
labelAlphaNumber0 – 100Sets the x-axis label alpha for both font and background.
labelBgAlphaNumber0 – 100Sets the x-axis label background alpha.
labelBorderAlphaNumber0 – 100Sets the x-axis label border alpha.
labelBorderPaddingNumberIn PixelsSets the x-axis label border padding.
labelBorderRadiusNumberIn PixelsSets the x-axis label border radius.
labelBorderThicknessNumberIn PixelsSets the x-axis label border thickness.
labelBorderDashedTrue/False0/1Whether the border around x-axis labels should be rendered using dashed lines.

Default value: 0 (border rendered using straight lines)

labelBorderDashLenNumberIn pixelsSets the length of each dash when the border around the x-axis labels are rendered using dashed lines.
labelBorderDashGapNumberIn pixelsSets the gap between two consecutive dashes when the border around x-axis labels are rendered using dashed lines.
labelLinkURLAnySets a link for all x-axis labels.

Cross Line Attributes

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

AttributeTypeValueDescription
drawCrossLineTrue/False0/1This attribute sets a cross line (vertical line/area), when you hover a data plot.
Default value: `0`
crossLineColorColorHex Color CodeThis attribute sets the color of the cross line.
Default value: `#EEEEEE`
crossLineAlphaNumber0 – 100This attribute sets the opacity of the cross line.
Default value: `50`
crossLineAnimationTrue/False0/1This attributes enables the animation for the cross line.
Default value: `0`
crossLineAnimationDurationNumberIn secondsThis attribute sets the animation duration of the cross line.
Default value: `0.09 seconds`
plotColorinTooltipTrue/False0/1This attribute displays the color of each plot with their labels in tooltip.
Default value: `1`
tooltipGrayoutColorColorHex Color CodeThis attribute sets the color of the unfocused plot in the tooltip for multi-series chart. By default it is set as gray.
Default value: `#AAAAAA`
drawCrossLineOnTopTrue/False0/1This attribute is used to determine if the cross line will be drawn above the data plot or below the data plot.
Default value: `0`

Tooltip Attributes

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

AttributeTypeValueDescription
showToolTipTrue/False0/1Whether to show tool tip on chart.
toolTipBgColorColorHex Color CodeBackground color for tool tip.
toolTipColorColorHex Color CodeFont color for the tool-tip.
toolTipBorderColorColorHex Color CodeBorder color for tool tip.
tooltipBorderAlphaNumber0 – 100Sets the border transparency for tool tip.
toolTipSepCharTextAnyThe character specified as the value of this attribute separates the name and value displayed in tool tip.
seriesNameInToolTipTrue/False0/1For combination charts, Exago shows the following information in tool tip (unless tool text is explicitly defined): “Series Name, Category Name, Data Value”. This attribute lets you control whether series name will show up in tool tip or not.
showToolTipShadowTrue/False0/1Whether to show shadow for tool-tips on the chart.
tooltipbgalphaNumber0 – 100Sets the transparency of the tooltip.
tooltipborderradiusNumberIn PixelsSets the border radius of the tooltip.
tooltipborderthicknessNumberIn PixelsSets the border thickness of the tooltip.
toolTipPaddingNumberIn PixelsThis attribute sets the vertical space between the value and the border of the tooltip. If you want more space between the value and the border, you can use this attribute to control it.
plottooltextTextAnySpecify 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`.

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.

AttributeTypeValueDescription
toolbarPositionTextTL, TR, BL, BR, CCWhere to position the toolbar on the chart: TL – Top-left TR – Top-right BR – Bottom right BL – Bottom left CC – Center of screen
toolbarXNumberAnySets the toolbox position on the chart with respect to x-axis.
toolbarYNumberAnySets the toolbox position on the chart with respect to y-axis.
toolbarHAlignTextLeft, RightSets the horizontal alignment of the toolbar on the chart.
toolbarVAlignTextTop, BottomSets the vertical alignment of the toolbar on the chart
toolbarButtonColorColorAny (color code without the # prefix)Sets the color of the toolbar buttons.
showToolBarButtonTooltextTrue/False0/1Enables/disables display of tooltips for toolbar buttons.
toolbarButtonScaleNumberAnyYou can change the scale of the toolbar by specifying a value for this attribute.

Attributes for Exporting Charts

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

AttributeTypeValueDescription
exportEnabledTrue/False0/1Whether the chart will allow exporting to images, PDFs, SVG or XLSX.

Default value: 0

exportActionText‘save’ or ‘download’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

exportHandlerTextAnyIn case of server side exporting, this refers to the path of the server-side export handler (the ready-to-use scripts that we provide).
exportFormatsTextAnyLets 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’`
exportModeTextAnyThis attributes sets the modes of export. To enable client-side exporting, set this attribute to `client`.

Default value: auto.

Note: Starting v3.12.1, the `exportMode` attribute replaces the `exportAtClientSide` attribute. However, you don’t need to make any changes to the existing setup because, the Exago library comes with the proper mapping already provided.

exportShowMenuItemTrue/False0/1Whether the menu items related to export (e.g., Save as JPEG etc.) will appear in the context menu of chart.
exportTargetWindowText‘_self’ or ‘_blank’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

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

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.

AttributeTypeValueDescription
showHoverEffectTrue/False0/1Whether to enable hover effect on charts for all elements
plotHoverEffectTrue/False0/1Whether to enable hover effect on charts for data plots (e.g., column, pie) only
plotFillHoverColorColorHex Color CodeSpecifies the hover color for the data plots
plotFillHoverAlphaNumber1 – 100Specifies the hover alpha for data plots
anchorHoverEffectTrue/False0/1Sets whether to enable the hover effect on charts for anchors.
anchorHoverColorColorHex Color CodeThis attribute sets the hover color for anchors.
anchorHoverAlphaNumber0 – 100This attribute specifies the transparency for the anchors when hovered.
anchorHoverSidesNumberIn PixelsThis attribute sets the number of sides of the anchor when hovered.
anchorHoverRadiusNumberIn pixelsThis attribute sets the radius of the anchor when hovered.
anchorBgHoverColorColorHex color codeThis attribute sets the background color of anchor when hovered.
anchorBgHoverAlphaNumber0 – 100This attribute sets the transparency of anchor’s background when hovered.
anchorBorderHoverColorColorHex color codeSets the border color of anchors when hovered.
anchorBorderHoverAlphaNumber0 – 100Sets the border’s transparency of anchors when hovered.
anchorBorderHoverThicknessNumberIn pixelsThis attribute sets the border thickness of the anchors when hovered.
anchorHoverStartAngleNumberIn pixelsThis attribute sets the starting angle of the anchors when hovered.
columnHoverColorColorHex Color CodeThis attribute specifies the hover color for the columns.
columnHoverAlphaNumber0 – 100This attribute specifies the transparency of the column when you hover.
plotHoverGradientColorColorHex Color CodeSpecifies the gradient color for the data plots when hovered. For example, if you’ve specified individual colors and now you want hover color that ends in white, You need to specify it.
plotHoverRatioNumberAnyHelps you specify the ratio of gradient colors when hovered.
plotHoverAngleNumberAnyThis attribute specifies the angle of the gradient color when hovered.
plotBorderHoverColorColorHex Color CodeSets the color of the border of plot when hovered.
plotBorderHoverThicknessNumberIn PixelsSets the thickness of the border of plot when hovered.
plotBorderHoverDashedTrue/False0/1When a data plot is hovered, this attribute is used to specify whether the data plot border will be rendered as a dashed line.

Default value: 0 (border rendered using straight lines)

plotBorderHoverDashLenNumberIn pixelsWhen a data plot is hovered, this attribute is used to set the length of each dash if the border around the data plots are rendered using dashed lines.
plotBorderHoverDashGapNumberIn pixelsWhen a data plot is hovered, this attribute is used to set the gap between consecutive dashes if the border around the data plots are rendered using dashed lines.
anchorHoverDipNumber0 – 1This attribute adds a dip effect (different shapes) to the anchors on hover. When hovered a star shaped anchor is created. Using `anchorSides` attribute, you can specify the no. of sides for anchors. `Note : If the anchors are of circular shape, this attribute won’t be applied on it.`
anchorHoverAnimationTrue/False0/1Anchors get animated when the normal radius and the hover radius are different. To disable this effect you can set anchorHoverAnimation = `0`.
Default value: `1`

Chart Padding & Margins

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

AttributeTypeValueDescription
captionPaddingNumberIn PixelsThis 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.
xAxisNamePaddingNumberIn PixelsUsing this, you can set the distance between the top end of x-axis title and the bottom end of data labels (or canvas, if data labels are not to be shown).
yAxisNamePaddingNumberIn PixelsUsing this, you can set the distance between the right end of y-axis title and the start of y-axis values (or canvas, if the y-axis values are not to be shown).
yAxisValuesPaddingNumberIn PixelsThis attribute helps you set the horizontal space between the canvas left edge and the y-axis values or trend line values (on left/right side). This is particularly useful, when you want more space between your canvas and y-axis values.
labelPaddingNumberIn PixelsThis attribute sets the vertical space between the labels and canvas bottom edge. If you want more space between the canvas and the x-axis labels, you can use this attribute to control it.
valuePaddingNumberIn PixelsIt sets the vertical space between the end of columns and start of value textboxes. This basically helps you control the space you want between your columns/anchors and the value textboxes.
plotSpacePercentNumber0-80 (In Percent)On a column chart, there is spacing defined between two columns. By default, the spacing is set to 20% of canvas width. If you intend to increase or decrease the spacing between columns, you can do so using this attribute. For example, if you wanted all columns to stick to each other without any space in between, you can set `plotSpacePercent` to 0. Similarly, if you want very thin columns, you can set `plotSpacePercent` to its max value of 80.
plotPaddingPercentNumber0 – 100This attribute adds white space between columns/bars representing a single category. Applicable only when there are more than one datasets.
chartLeftMarginNumberIn PixelsAmount of empty space that you want to put on the left side of your chart. Nothing is rendered in this space.
chartRightMarginNumberIn PixelsAmount of empty space that you want to put on the right side of your chart. Nothing is rendered in this space.
chartTopMarginNumberIn PixelsAmount of empty space that you want to put on the top of your chart. Nothing is rendered in this space.
chartBottomMarginNumberIn PixelsAmount of empty space that you want to put at the bottom of your chart. Nothing is rendered in this space.
legendPaddingNumberIn PixelsPadding of legend from right/bottom side of canvas
canvasPaddingNumberIn PixelsAllows you to set empty space on the left and right side of Line dataset or Area dataset on the chart canvas. This setting won’t work if one or more Column datasets are present.
canvasLeftMarginNumberIn PixelsThis attribute lets you control the space between the start of chart canvas and the start (x) of chart. In case of 2D charts, the canvas is the visible rectangular box. In case of 3D charts, the canvas box is the imaginary box around the 3D canvas. Using this attribute, you can control the amount of empty space between the chart left side and canvas left side. By default, Exago automatically calculates this space depending on the elements to be placed on the chart. However, if you want to over-ride this value with a higher value, you can use this attribute to specify the same. Please note that you cannot specify a margin lower than what has been calculated by the chart. This attribute is particularly useful, when you’ve multiple charts placed in a page and want all their canvas start position to align with each other – so in such a case, you can set same margin value (a value large enough that it doesn’t get rejected by chart owing to it being lower than the calculated value) for all such charts in the page.
canvasRightMarginNumberIn PixelsLike `canvasLeftMargin`, this attribute lets you set the space between end of canvas and end of chart.
canvasTopMarginNumberIn PixelsLike `canvasLeftMargin`, this attribute lets you set the space between top of canvas and top of chart.
canvasBottomMarginNumberIn PixelsLike `canvasLeftMargin`, this attribute lets you set the space between bottom of canvas and bottom of chart.

The categories Object

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

AttributeTypeValueDescription
fontTextValid font faceLets you specify font face for the x-axis data labels.
fontColorColorHex Color CodeLets you specify font color for the x-axis data labels.
fontSizeNumberAnyLets you specify font size for the x-axis data labels.

The category Object

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

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

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

showLabelTrue/False0/1You can individually opt to show/hide labels of individual data items using this attribute.
toolTextTextAnyThe tooltip defined in the `category` object appears only when the mouse cursor is hovered over the data plots. However, this will not appear when the cursor is moved over the data labels (except for a situation when long labels are automatically truncated with ellipses. In this situation, if the mouse cursor is hovered over a truncated label, the tooltip will appear with the full label). In case you want to set a short label and show the full label in tooltip, define the full label using this attribute within the `category` object. The tooltip with the full label will appear only when the mouse is hovered on the dataplot.
fontTextAnySets the x-axis label font family for the text.
fontColorColorHex Color CodeSets the x-axis label font color.
fontSizeNumber6 – 72Specifies the x-axis label font size.
fontBoldTrue/False0/1Flag indicating whether x-axis label font should be bold or not.
fontItalicTrue/False0/1Flag indicating whether x-axis label font should be italicized or not.
bgColorColorHex Color CodeSets the background color for x-axis label text.
borderColorColorHex Color CodeSets the color of the border around the x-axis label text.
alphaNumber0 – 100Sets the x-axis label alpha for both font and background.
bgAlphaNumber0 – 100Sets the x-axis label background alpha.
borderAlphaNumber0 – 100Sets the x-axis label border alpha.
borderPaddingNumberIn PixelsSets the x-axis label border padding.
borderRadiusNumberIn PixelsSets the x-axis label border radius.
borderThicknessNumberIn PixelsSets the x-axis label border thickness.
borderDashedTrue/False0/1Whether the border around x-axis label should be rendered using dashed lines.

Default value: 0 (border rendered using straight lines)

borderDashLenNumberIn pixelsSets the length of each dash when the border around the x-axis label is rendered using dashed lines.
borderDashGapNumberIn pixelsSets the gap between two consecutive dashes when the border around x-axis label is rendered using dashed lines.

Vertical Data Separator Lines

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


"categories": [{
	"category": [{
			"label": "Grade 1",
		},
		{
			"vLine": "true",
			"label": "Appraisal"
		}]
	}]

You can configure the cosmetics of vertical separator lines using the following attributes:

AttributeTypeValueDescription
vLineTextAnySet this attribute to `true` to render a vertical data separator line.
colorColorHex Color CodeThis attribute defines the color of vertical separator line
thicknessNumberIn PixelsThickness in pixels of the vertical separator line.
alphaNumber0 – 100Alpha of the vertical separator line.
dashedTrue/False0/1Whether the vertical separator line should be rendered as dashed lines.

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

dashLenNumberIn pixelsSets the width of each dash when vertical separator line is rendered as dashed lines.
dashGapNumberIn pixelsSets the gap between consecutive dashes when vertical separator line is rendered as dashed lines.
labelText Label for the vertical separator line, if to be shown.

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

showLabelBorderTrue/False0/1Whether to show a border around the vLine label.
linePositionNumber0-1Helps configure the position of vertical line i.e., if a vLine is to be plotted between 2 points Jan and Feb, user can set any position between 0 and 1 to indicate the relative position of vLine between these two points (0 means Jan and 1 means Feb). By default, it’s 0.5 to show in between the points.
labelPositionNumber0-1Helps configure the position of the vLine label by setting a relative position between 0 and 1. In vertical charts, 0 means top of canvas and 1 means bottom. In horizontal charts, 0 means left of canvas and 1 means right.
labelHAlignTextleft, center, rightHorizontal anchor point for the alignment of vLine label.
labelVAlignTexttop, middle, bottomVertical anchor point for the alignment of vLine label.

The dataset Object

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

AttributeTypeValueDescription
renderAsTextCOLUMN, AREA, LINE, SPLINEAREA or SPLINEThis attribute defines what the particular dataset will be plotted as. Valid values are COLUMN, AREA, LINE, SPLINEAREA or SPLINE.
parentYAxisTextP or SrenderAs attribute over-rides this attribute in Exago for Single Y Combination Charts. This attribute allows you to set the parent axis of the dataset – P (primary) or S (secondary). Primary datasets are drawn as Columns and secondary datasets as lines.
showPlotBorderTrue/False0/1Whether to show the border of this dataset (area or column only).
plotBorderColorColorHex Color CodeColor for data plot border of this dataset (area or column only)
plotBorderThicknessNumber0-5Thickness for data plot border of this dataset (area or column only)
plotBorderAlphaNumber0 – 100Alpha for data plot border of this dataset (area or column only)
seriesNameTextAnyLets you specify the series name for a particular dataset. For example, if you’re plotting a chart to indicate monthly sales analysis for 2005 and 2006, the `seriesName` for the first dataset will be 2005 and that of the second will be 2006. The `seriesName` of a dataset is shown in legend.
colorColorHex Color CodeThis attribute sets the color using which columns, lines, area of that dataset will be drawn. For column chart, you can specify a list of comma separated hex codes to get a gradient plot.

Note: This attribute is not applicable on spline data plots.

alphaText0 – 100 or Comma Separated ListThis attribute sets the alpha (transparency) of the entire dataset.
showValuesTrue/False0/1Whether to show the values for this dataset.
valuePositionText“ABOVE”, “BELOW”, “AUTO”This attribute lets you adjust the vertical alignment of data values for all dataplots in the dataset. The alignment is set with respect to the position of the dataplots on the chart. By default, the attribute is set to AUTO mode in which the alignment of each data value is determined automatically based on the position of each plot point. In ABOVE mode, data values are displayed above the plot points unless a plot point is too close to the upper edge of the canvas. While in BELOW mode, data values are displayed below the plot points unless a plot point is too close to the lower edge of the canvas. The attribute will function only if `showValue` attribute is set to 1 in this particular dataset.
dashedTrue/False0/1Whether this dataset will appear as dashed.
includeInLegendTrue/False0/1Whether to include the `seriesName` of this dataset in legend. In combination charts, this can be particularly useful when you’ve used the area/line chart to plot a trend but do not want the `seriesName` of that trend to appear in legend.
drawAnchorsTrue/False0/1Whether to draw anchors for a particular dataset.
anchorSidesNumber3-20Sets the number of sides that the anchors of the particular dataset will have. For e.g., an anchor with 3 sides will represent a triangle, with 4 it will be a square and so on.
anchorStartAngleNumber0 – 360This attribute sets the starting angle for anchors of particular dataset.
Default value: 90
anchorRadiusNumberIn PixelsThis attribute sets the radius (in pixels) of the anchors of the particular dataset.
anchorBorderColorColorHex Color CodeLets you set the border color of anchors of the particular dataset.
anchorBorderThicknessNumberIn PixelsHelps you set border thickness of anchors of the particular dataset.
anchorBgColorColorHex Color CodeHelps you set the background color of anchors of the particular dataset.
anchorAlphaNumber0 – 100Helps you set the alpha of entire anchors of the particular dataset. If you need to hide the anchors for the dataset but still enable tool tips, set this as 0.
lineThicknessNumberIn PixelsThickness of the lines for the particular dataset.
lineDashLenNumberIn pixelsSets the length of each dash when lines for a data-set is rendered as dashed lines.
lineDashGapNumberIn pixelsSets the gap between consecutive dashes when lines for a data-set is rendered as dashed lines.
visibleTrue/False0/1Sets whether a dataset will be visible on the chart, when the chart is first loaded. This attribute overrides the `initiallyHidden` attribute.
`Default Value` : 1
hoverGradientColorColorHex Color CodeThis attribute sets the gradient color of the data plot on hover.
hoverRatioNumber0 – 100This attribute sets the ratio of gradient colors when hovered.
hoverAngleNumber0 – 360This attribute specifies the angle of the gradient color when hovered.
borderHoverColorColorHex Color CodeThis attribute sets the border color of the data plot on hover.
borderHoverAlphaNumber0 – 100This attribute sets the border’s transparency for the data plot on hover.
borderHoverThicknessNumberIn pixelsThis attribute sets the thickness for the data plot’s border on hover.
borderHoverDashedTrue/False0/1When a data plot is hovered, this attribute is used to specify whether a data plot border will be rendered as a dashed line.

Default value: 0 (border rendered using straight lines)

borderHoverDashLenNumberIn pixelsWhen a data plot is hovered, this attribute is used to set the length of each dash if the border around a data plot is rendered using dashed lines.
borderHoverDashGapNumberIn pixelsWhen a data plot is hovered, this attribute is used to set the gap between consecutive dashes if the border around a data plot is rendered using dashed lines.
anchorHoverSidesNumberIn PixelsThis attribute sets the number of sides for anchors of a particular dataset when hovered.
anchorBgHoverColorColorHex color codeThis attribute sets the background color for anchors of a particular dataset when hovered.
anchorBgHoverAlphaNumber0 – 100This attribute sets the transparency for anchor’s background of a particular dataset when hovered.
anchorBorderHoverColorColorHex color codeSets the border color for anchors of a particular dataset when hovered.
anchorBorderHoverAlphaNumber0 – 100Sets the border’s transparency for anchors of a particular dataset when hovered.
anchorBorderHoverThicknessNumberIn pixelsThis attribute sets the border thickness for anchors of a particular dataset when hovered.
anchorHoverStartAngleNumberIn pixelsThis attribute sets the starting angle for anchors of a particular dataset when hovered.
anchorHoverDipNumber0 – 1This attribute adds a dip effect (different shapes) for anchors of a particular dataset on hover. When hovered a star shaped anchor is created. Using `anchorSides` attribute, you can specify the no. of sides for anchors. `Note : If the anchors are of circular shape, this attribute won’t be applied on it.`

The data Object

Attributes of the `data` object, child of the `dataset` object, are used to define the values to be plotted for individual data series. The `dataset` and `data` objects defined for one data series are shown in the example below:


"dataset": [{
	"seriesname": "Previous Year",
	"data": [{
			"value": "10000",
		},
		{
			"value": "11500",
		},
		{
			"value": "12500",
		},
		{
			"value": "15000"
		}]
}]
AttributeTypeValueDescription
valueNumberAnyNumerical value for the data item. This value will be plotted on the chart.
displayValueText If instead of the numerical value of this data, you wish to display a custom string value, you can specify the same here. Examples are annotation for a data item etc.
colorColorHex Color CodeFor combination charts, you can define the color of datasets at dataset level. However, if you wish to highlight a particular data element, you can specify its color at “set” level using this attribute.
linkTextAnyYou can define links for individual data items. That enables the end user to click on data items (columns, lines, bars etc.) 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 > Using JavaScript Functions as Links” for more information. Also, you’ll need to Url Encode all the special characters (like ? and &) present in the link.
toolTextTextAnyBy default, Exago shows the series name, category name, and value as tool tip text for that data item. But, if you want to display more information for the data item as tool tip, you can use this attribute to specify the same.
showLabelTrue/False0/1You can individually opt to show/hide labels of individual data items using this attribute.
showValueTrue/False0/1You can individually opt to show/hide values of individual data items using this attribute. This value over-rides the dataset level value.
valuePositionText“ABOVE”, “BELOW”, “AUTO”If you’ve opted to show a particular data value on the chart, this attribute lets you adjust the vertical alignment of individual data values with respect to dataplots. By default, this attribute is set to AUTO mode in which the alignment of a data value is determined automatically based on the position of its plot point. In ABOVE mode, a data value is displayed above the plot point unless a plot point is too close to the upper edge of the canvas while in BELOW mode, a data value is displayed below the plot point unless a plot point is too close to the lower edge of the canvas.
dashedTrue/False0/1Whether the border of this data item should appear as dashed. This is particularly useful when you want to highlight a data (such as forecast or trend etc.). This value over-rides the dataset level value.
alphaNumber0 – 100For combination charts, you can define the alpha of datasets at dataset level. However, if you wish to highlight a particular data element, you can specify its alpha at “set” level using this attribute.
anchorSidesNumber3-20Lets you specify “set” specific sides of the anchor.
anchorStartAngleNumber0 – 360This attribute sets the starting angle for an anchor of a particular data.
Default value: 90
anchorRadiusNumberIn PixelsLets you specify “set” specific radius (in pixels) of the anchor.
anchorBorderColorColorHex Color CodeLets you specify “set” specific border color of the anchor.
anchorBorderThicknessNumberIn PixelsLets you specify “set” specific border thickness of the anchor.
anchorBgColorColorHex Color CodeLets you specify “set” specific background color of the anchor.
anchorAlphaNumber0 – 100Lets you specify “set” specific alpha of the anchor.
anchorBgAlphaNumber0 – 100Lets you specify “set” specific alpha of the anchor background.

Trend-lines

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

AttributeTypeValueDescription
startValueNumberNumeric ValueThe starting value for the trendline. Say, if you want to plot a slanted trendline from value 102 to 109, the `startValue` will be 102.
endValueNumberNumeric ValueThe ending y-axis value for the trendline. Say, if you want to plot a slanted trendline from value 102 to 109, the `endValue` will be 109. If you do not specify a value for `endValue`, it will automatically assume the same value as `startValue`.
displayValueTextAnyIf you want to display a string caption for the trend line by its side, you can use this attribute. Example: `displayValue=’Last Month High’`. When you don’t supply this attribute, it automatically takes the value of `startValue`.
colorTextHex Color CodeColor of the trend line and its associated text
isTrendZoneTrue/False0/1Whether the trend will be displayed as a line or a zone (fill-colored rectangle).
showOnTopTrue/False0/1Whether the trend line/zone will be displayed over data plots or under them.
thicknessNumberIn PixelsIf you’ve opted to show the trend as a line, this attribute lets you define the thickness of trend line.
alphaNumber0 – 100Alpha of the trend line.
dashedTrue/False0/1Whether the trendline should be rendered as dashed lines.

Default value: 0 (trendline rendered using straight lines)

dashLenNumberIn pixelsSets the width of each dash when trendline is rendered as dashed lines.
dashGapNumberIn pixelsSets the gap between consecutive dashes when trendline is rendered as dashed lines.
valueOnRightTrue/False0/1Whether to show the trend line value on left side or right side of chart. This is particularly useful when the trend line display values on the chart are colliding with divisional lines values on the chart.
toolTextText Custom tool-text for this trendline/zone.

Trend-lines (Chart level attributes)

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

AttributeTypeValueDescription
trendlineColorColorHex Color CodeSets color of all the trend lines and its associated text in the chart.
trendlineThicknessNumberIn PixelsIf you’ve opted to show the trend as a line, this attribute lets you define the thickness of all the trend lines in your chart.
trendlineAlphaNumber0 – 100Sets transparency for all the trend lines in your charts.
trendLineToolTextTextAnySets the tooltip text of the trend-line. It accepts macros, plain text, and HTML tags, as string.
showTrendlinesOnTopTrue/False0/1Whether all the trend line/zone will be displayed over data plots or under them.

Trend-lines Display Value Cosmetics

These attributes let you customize the text displayed with a trend-line.
Note: These attributes belong to the `chart` object and not to the `line` object (child of the `trendline` object). They are, therefore, applied to all trend-lines on your chart.

AttributeTypeValueDescription
trendValueFontTextFont NameSets the font family for the trend-line display value.
trendValueFontSizeNumber Sets the font size for the trend-line display value.
trendValueFontBoldTrue/False0/1Sets whether the trend-line display value will be bold formatted.
Default value: 0 (not bold formatted)
trendValueFontItalicTrue/False0/1Sets whether the trend-line display value will be italicized.
Default value: 0 (not italicized)
trendValueBgColorColorHex Color CodeSets the background color for the trend-line display value.
trendValueBorderColorColorHex Color CodeSets the border color for the trend-line display value.
trendValueAlphaNumber0 – 100Sets the transparency for the trend-line display value.
Default value: 100
trendValueBgAlphaNumber0 – 100Sets the transparency for the background of the trend-line display value.
Default value: 100
trendValueBorderAlphaNumber0 – 100Sets the transparency for the border around the trend-line display value.
Default value: 100
trendValueBorderPaddingNumberIn pixelsSets padding for the border around the trend-line display value.
trendValueBorderRadiusNumberIn pixelsSets the radius for the border around the trend-line display value.
trendValueBorderThicknessNumberIn pixelsSets the thickness for the border around the trend-line display value.
trendValueBorderDashedTrue/False0/1Whether the border around the trend-line display value should be rendered as dashed lines.

Default value: 0 (border rendered using straight lines)

trendValueBorderDashLenNumberIn pixelsSets the length of each dash when the border around the trend-line display value is rendered as dashed lines.
trendValueBorderDashGapNumberIn pixelsSets the gap between two consecutive dashes when the border around the trend-line display value is rendered as dashed lines.
Was this article helpful?
0 out of 5 stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.
Table of Contents