Exago Logo
Search
Generic filters
Exact matches only

Chart Advanced Features: Heatmap

The following sections provide a list of available advanced attributes available for controlling and customizing Heatmap 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 or 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-5Each 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 (that is, column, line, pie etc.). Using `paletteColors` attribute, you can specify your custom list of hex colors for the data items. The list of colors have to be separated by comma, for example, `”paletteColors”: “#FF0000, #0372AB, #FF5904…”`. The chart will cycle through the list of specified colors and then render the data plot accordingly. To use the same set of colors throughout all your charts in a web application, you can store the list of palette colors in your application globally and then provide the same in each chart JSON.
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.
trTypeText Specifies the type of data provided in the top-right label. This value is displayed in the tool tip.
tlTypeText Specifies the type of data provided in the top-left label. This value is displayed in the tool tip.
brTypeText Specifies the type of data provided in the bottom-right label. This value is displayed in the tool tip.
blTypeText Specifies the type of data provided in the bottom-left label. This value is displayed in the tool tip.
staggerLinesNumber2 or aboveIf you have opted for STAGGER mode as `labelDisplay`, using this attribute you can control how many lines to stagger the label to. By default, all labels are displayed in a single line.
showValuesTrue/False0/1Sets the configuration whether data values would be displayed along with the data plot on chart.
showLimitsTrue/False0/1Whether to show chart limit values.
showDivLineValuesTrue/False0/1Whether to show div line values.
showShadowTrue/False0/1Whether to apply the shadow effects for dataplot.
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`)
interactiveAnimationDurationNumberAnySets the duration of the animation that takes place when the legends are used to show or hide dataplots.
mapByCategoryTrue/False0/1Allows you to render a category based heat map chart.
plotFillAlphaNumeric0 – 100Sets the transparency of all the dataplots in the chart.
unescapeLinksTrue/False0/1Internally the chart decodes a Url that you set as link. Before invoking the link it again encodes the Url. If you are passing multilingual characters via a Url or do not want this decode-encode mechanism to be handled by chart you can set,`unescapeLinks=’0’`.
showPrintMenuItemTrue/False0/1When you right click on the chart it shows a context menu. This attribute allows you to show or hide the “Print” option in the context menu.
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`
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
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

showXaxisLabelsTrue/False0/1This attribute is used to show or hide the x axis or the column labels.
rotatexAxisLabelsTrue/False0/1This attribute lets you set whether the data labels would show up as rotated labels on the chart.
showYaxisLabelsTrue/False0/1This attribute is used to show or hide y axis or the row labels.
rotateYAxisNameTrue/False0/1If you do not wish to rotate y-axis name, set this as 0. It specifically comes to use when you have special characters (UTF8) in your y-axis name that do not show up in rotated mode.
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.

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 have opted for gradient background, you need to set a list of alpha(s) separated by comma.
bgRatioNumber0 – 100If you have opted for a gradient background, this attribute lets you set the ratio of each color constituent.
bgAngleNumber0-360Angle 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.
bgImageValignTextleft, center, rightHelps you to vertically align the background image.
bgImageHalignTextleft, center, 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.
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 have opted to show a label for any of your vLines in the chart, you can collectively configure whether to show border for all such labels using this attribute. If you want to show label border for just a particular vLine, you can over-ride this value by specifying border configuration for that specific vLine.
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) would appear on the chart. If the plots can show borders, you can control the border properties using the attributes listed below. Or, if they support gradient fills, you can again configure various properties of the gradient using these attributes. Various other controls over plot cosmetics can be attained using this set of attributes.

AttributeTypeValueDescription
showPlotBorderTrue/False0/1Whether the column, area, pie etc. border would show up.
plotBorderColorColorHex Color CodeColor for column, area, pie border.
plotBorderThicknessNumber0-5Thickness for column, area, pie border.
plotBorderAlphaNumber0 – 100Alpha for column, area, pie 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 have opted to fill the plot (column, area etc.) as gradient, this attribute lets you set the fill angle for gradient.
plotFillRatioNumber0 – 100If you have opted to fill the plot (column, area etc.) as gradient, this attribute lets you set the ratio for gradient.

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

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

Data Label Cosmetics

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

AttributeTypeValueDescription
showLabelsTrue/False0/1It sets the configuration whether the categorical axis labels will be displayed or not.
maxLabelHeightNumberIn PixelsThis attribute can be used to set the maximum height for the categorical axis labels (data labels) excluding the axis title. If any label goes beyond this height, the label will be truncated. In stagger mode, the number of stagger lines will be reduced if they exceed this value.
maxLabelWidthPercentNumericIn PixelsRestricts the maximum space allotted for the y-axis data labels with respect to the chart’s width. If a data label is longer than the specified percentage width then it will either be wrapped or get truncated, subject to the availability of vertical space. Unnecessary space is not reserved for the labels. If all the labels are shorter than the specified maximum width, this value is not applied.
minLabelWidthPercentNumber1-100Restricts the minimum length of data labels in terms of percentage of the chart’s width that the data labels can occupy. The space thus calculated stays reserved even if the label width is less than the minimum width.
labelDisplayText‘AUTO’, ‘WRAP’, ‘STAGGER’, ‘ROTATE’, ‘NONE’Using this attribute, you can customize the alignment of data labels (categorical axis labels). There are 5 options: AUTO, WRAP, STAGGER, ROTATE or NONE. By default, this attribute is set to AUTO mode which means that the alignment of the data labels is determined automatically depending on the size of the chart. WRAP wraps the label text if it is too long to fit in one line. ROTATE rotates the labels vertically. STAGGER divides the labels into multiple lines.
labelFontTextFont NameSets the categorical axis label font family for the text.
labelFontColorColorHex Color CodeSets the categorical axis label font color.
labelFontSizeNumber6 – 72Specifies the categorical axis label font size.
labelFontBoldTrue/False0/1Flag indicating whether categorical axis label font should be bold or not.
labelFontItalicTrue/False0/1Flag indicating whether categorical axis label font should be italicized or not.
labelBgColorColorHex Color CodeSets the background color for categorical axis label text.
labelBorderColorColorHex Color CodeSets the color of the border around the categorical axis label text.
labelAlphaNumber0 – 100Sets the categorical axis label alpha for both font and background.
labelBgAlphaNumber0 – 100Sets the categorical axis label background alpha.
labelBorderAlphaNumber0 – 100Sets the categorical axis label border alpha.
labelBorderPaddingNumberIn PixelsSets the categorical axis label border padding.
labelBorderRadiusNumberIn PixelsSets the categorical axis label border radius.
labelBorderThicknessNumberIn PixelsSets the categorical axis label border thickness.
labelBorderDashedTrue/False0/1Whether the border around categorical 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 categorical axis labels are rendered using dashed lines.
labelBorderDashGapNumberIn pixelsSets the gap between two consecutive dashes when the border around categorical axis labels are rendered using dashed lines.
labelLinkURLAnySets a link for every data plot.
tlFontTextFont NameAllows user to set Top Left font for the tooltext
tlFontSizeNumber6 – 72Allows user to set Top Left font size for the tooltext
tlFontColorColorHex color codeAllows user to set Top Left font color for the tooltext
trFontTextFont NameAllows user to set Top Right font for the tooltext
trFontSizeNumber6 – 72Allows user to set Top Right font size for the tooltext
trFontColorColorHex color codeAllows user to set Top Right font color for the tooltext
blFontTextFont NameAllows user to set Bottom Left font for the tooltext
blFontSizeNumber6 – 72Allows user to set Bottom Left font size for the tooltext
blFontColorColorHex color codeAllows user to set Bottom Left font color for the tooltext
brFontTextFont NameAllows user to set Bottom Right font for the tooltext
brFontSizeNumber6 – 72Allows user to set Bottom Right font size for the tooltext
brFontColorColorHex color codeAllows user to set Bottom Right font color for the tooltext

Tooltip

These attributes let you control the tooltip. 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.
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`.
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.

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, XLSX or CSV format.

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

Legend Properties

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

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
legendCaptionText You can add a caption for the entire legend by setting the same here.
legendItemHoverFontColorColorHex Color CodeSets legend item font color on hover
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
legendIconScaleNumber1-5This attribute lets you control the size of legend icon.
legendItemHiddenColorColorHex Color CodeSets the color that applies on both text font and icon when they are in a disabled / hidden state
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.
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 have too many items on the legend, a scroll bar shows up on the same. This attribute lets you configure the background color of the scroll bar.
reverseLegendTrue/False0/1You can reverse the order 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.
legendPointerColorColorHex Color CodeSets the legend pointer color for a gradient legend.
legendPointerAlphaNumber0 – 100Sets the legend pointer transparency for a gradient legend.
legendPointerBorderAlphaNumber0 – 100Sets the transparency for the legend pointer border for a gradient legend.
legendpointerbordercolorColorHex color codeSets the color for the border of the legend pointer.
legendScaleLineColorHex Color CodeAnyAllows you to set the color of the scale in gradient legend.
legendaxisbordercolorColorHex Color CodeSets color for the gradient legend’s axis border.
legendaxisborderalphaNumber0 – 100Sets transparency for the gradient legend’s axis border.
legendScaleLineAlphaNumeric0 – 100Allows you to set the transparency of the scale in gradient legend.
legendScaleLineThicknessNumericAnyAllows you to set the thickness of the scale in gradient legend.
autoOrderLegendIconTrue/False0/1Allows you to show the legend icon in ascending order in icon legend.
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 would 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, for example, 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 – for example, if `formatNumberScale` is set to 1, 1043 would become 1.04K (with decimals set to 2 places). Same with numbers in millions – an M will be added at the end.
defaultNumberScaleTextAnyThe default unit of the numbers that you are 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, the chart accepts the input decimal and thousand separator from user, so that it can convert it accordingly into the required format. This attribute lets you input the decimal separator.
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, the chart accepts the input decimal and thousand separator from user, so that it can convert it accordingly into the required format. This attribute lets you input the thousand separator.
decimalsNumber0-10Number of decimal places to which all numbers on the chart would 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, that is, all the values and the names in the chart which lie on the canvas will be displayed using the font size provided here.
baseFontColorColorHex Color CodeThis attribute sets the base font color of the chart, that is, all the values and the names in the chart which lie on the canvas will be displayed using the font color provided here.
outCnvBaseFontTextFont NameThis attribute sets the base font family of the chart text which lies outside the canvas, that is, all the values and the names in the chart which lie outside the canvas will be displayed using the font name provided here.
outCnvBaseFontSizeNumber6 – 72This attribute sets the base font size of the chart, that is, all the values and the names in the chart which lie outside the canvas will be displayed using the font size provided here.
outCnvBaseFontColorColorHex Color CodeThis attribute sets the base font color of the chart, that is, all the values and the names in the chart which lie outside the canvas will be displayed using the font color provided here.

The rows Object and the row Object

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

AttributeTypeValueDescription
idNumber/StringAnyAllows you to specify a unique Id for the rows. This id is used in the `data` object to place the data values in the pre-defined position.
labelTextAnyAllows you to specify a label for the rows. If you do not specify the label the unique id will be displayed as the label for the rows in the chart.

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

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

The columns Object and the column Object

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

AttributeTypeValueDescription
idNumber/StringAnyAllows you to specify a unique Id for the columns. This id is used in the `data` object to place the data values in the pre-defined position.
labelTextAnyAllows you to specify a label for the columns. If you do not specify the label the unique id will be displayed as the label for the rows in the chart.

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

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

The dataset Object and the data Object

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

AttributeTypeValueDescription
rowIdTextAnySpecifies the position of the row where the data it is to be placed in the chart. If the `rows` object is used then it is mandatory to use the same id which is defined in the `row` object by the `id` attribute.
columnIdTextAnySpecifies the position of the column where the data it is to be placed in the chart. If the `columns` object is used then it is mandatory to use the same id which is defined in the `column` object by the `id` attribute.
colorRangeLabelTextAnyThis attribute is used to provide the color-range label which is defined in the `color` object of the `colorRange` object. It is used only in category based heat map chart.
valueNumberAnyThis attribute allows you to display a value at the center of a data plot.
displayValueNumber/StringAnyAllows you to display any numeric value or string at the center of the dataplot. The settings of this attribute overwrites the settings of the ` value` attribute when both are used at the same time.
tlLabelNumber/StringAnyThis attribute allows you to display a label on the top-left corner of a data plot.
trLabelNumber/StringAnyThis attribute allows you to display a label on the top-right corner of a data plot.
blLabelNumber/StringAnyThis attribute allows you to display a label on the bottom-left corner of a data plot.
brLabelNumber/StringAnyThis attribute allows you to display a label on the bottom-left corner of a data plot.
colorColorHex Color CodeIn Heat map chart, if you wish to highlight a particular cell, you can specify it’s 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 Charts > Exago Link format” for more information. Also, you need to Url Encode all the special characters (like ? and &) present in the link.
toolTextTextAnyBy default, the tooltip text for a data item in the heat map chart includes the values of the `trLabel`, `tlLabel`, `brlabel`, `bllabel`, `trType`, `tlType`, `brType`, and and `blType` attributes. Additionally, you can display more customized information using the `toolText` attribute.
showValueTrue/False0/1You can individually opt to show or hide values of individual data items using this attribute. This value over-rides the data-set level value.
valueFontColorColorHex Color CodeSpecifies the font color of a data value for an individual data plot.
valueBgColorColorHex Color CodeSets the background color of a value text for an individual data plot.
valueBorderColorColorHex Color CodeSets the border color around the value text for an individual data plot.
alphaNumber0 – 100For Multi-series charts, you can define the alpha of data-sets at dataset level. However, if you wish to highlight a particular data element, you can specify its alpha at “set” level using this attribute.

The colorRange Object

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

AttributeTypeValueDescription
codeColorHex Color CodeHex code of the color range using which it will be filled.
endLabelTextAnySpecifies the label for the upper limit of the gradient scale.
gradientTrue/False0/1Allows you to display gradient legend.
mapByPercentTrue/False0/1Allows you to display the data values in percentage.
minValueNumberAnySets the minimum value or the lower limit of the numeric range and the gradient scale.
startLabelTextAnySpecifies the label for the lower limit of the gradient scale.

The color Object

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

AttributeTypeValueDescription
alphaNumber0 – 100Sets the transparency of each range in the color range.
codeColorHex Color CodeHex code of the color range using which it will be filled.
labelTextAnyThis attribute determines the label for each numeric range. The label appears either on the gradient scale or on icon legends depending on the legend type used.

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

maxValueNumberAnySpecifies the upper limits of each numeric range. This attribute is mandatory in each `color` object for both gradient and icon legend.
minValueNumberAnySpecifies the lower limits of each numeric range. This attribute is mandatory in each `color` object when icon legend is used.
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