Exago Logo
Search
Generic filters
Exact matches only

Chart Advanced Features: Pyramid

The following sections provide a list of available advanced attributes available for controlling and customizing Pyramid 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 lets you set the configuration whether the chart should appear in an animated fashion. If you do not want to animate any part of the chart, set this as 0.
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
clickURLURL in Exago formatAnyThe 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`)
paletteNumber1-5Each chart has 5 pre-defined color palettes which you can choose from. Each palette renders the chart in a different color theme.
paletteThemeColorColorHex Color CodeIf you want your own palette derived from a particular hex color, you can specify the same here. All other colors on the chart will automatically derive from that palette.
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.
manageResizeTrue/False0/1Setting this attribute to 1, you can allow the chart to automatically resize itself when the parent container of the chart is resized.
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.
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 captions

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

AttributeTypeValueDescription
captionTextAnyCaption of the chart.
subCaptionTextAnySub-caption 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 Labels & Values

Data labels refer to the names for the data points which appear on the x-axis and data values refer to the plot values.

AttributeTypeValueDescription
showLabelsTrue/False0/1Allows you to show/hide the labels of the pyramid chart.
showLabelsAtCenterTrue/False0/1Whether to show the labels of each pyramid at its side or at the center? This attribute is only applicable for 2D Pyramid chart.
labelDistanceNumberIn pixelsLets you set the horizontal distance between the data labels & pyramid slices.
labelSepCharTextAnyIf you’ve opted to show both pyramid label & value, this attribute lets you specify the character using which they’ll be separated.
enableSmartLabelsTrue/False0/1Whether to use smart lines & labels for the pyramid chart?
smartLineColorColorHex Color CodeIf you’ve opted to use smart lines, this attribute lets you define the color for the same.
smartLineThicknessNumberIn pixelsThickness of smart lines.
smartLineAlphaNumber0 – 100Alpha of the smart lines.
showValuesTrue/False0/1Allows you to show/hide the data values along with the pyramid slices on chart.
showPercentValuesTrue/False0/1Whether to show the values as percentage or as absolute values?

Number Formatting Properties

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

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’;
numberPrefixTextAnyUsing 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.
numberSuffixTextAnyUsing this attribute, you could add suffix to all the numbers visible on the graph. For example, to represent all figures quantified as per annum on the chart, you could specify this attribute to ‘/a’ to show like 40000/a, 50000/a.
decimalsNumberAnyNumber 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 set decimals as 2 and a number is 23.4. If `forceDecimals` is set to 1, the number will automatically be converted 23.40 (note the extra 0 at the end).
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?
decimalSeparatorTextAnyThis attribute helps you specify the character to be used as the decimal separator in a number.
thousandSeparatorTextAnyThis attribute helps you specify the character to be used as the thousands separator in a number.
thousandSeparatorPositionNumberAnyThis option helps you specify the position of the thousand separator.
inDecimalSeparatorTextAnyIn some countries, commas are used as decimal separators and dots as thousand separators. In XML/JSON, if you specify such values, it will give an error while converting to number. So, Exago accepts the input decimal and thousand separators from user, so that it can convert it accordingly into the required format. This attribute lets you input the decimal separators.
inThousandSeparatorTextAnyIn some countries, commas are used as decimal separators and dots as thousand separators. In XML/JSON, if you specify such values, it will give an error while converting to number. The chart accepts the input decimal and thousand separators from user, so that it can convert it accordingly into the required format. This attribute lets you input the thousand separators.

Pyramid Functional Properties

The following attributes are used to customize the functional properties of the pyramid.

AttributeTypeValueDescription
is2DTrue/False0/1Whether the chart will render as 2D?
isSlicedTrue/False0/1This attribute determines whether a level of the pyramid appears as a part of the total chart or is sliced out as an individual item.
pyramidYScaleNumber0-40Lets you set the 3D perspective of the pyramid. You’ll need to restrict your values to a value between 0 and 40 (depending on your pyramid chart dimensions) to get a proper drawing.
use3dlightingTrue/False0/1This attribute when set to `1` shows a 3D effect to the pyramid chart only when _is2d_ attribute is set to `1` . When we set this attribute to `0`, it displays a simple pyramid chart.

Pyramid Cosmetic properties

The following attributes are used to customize the appearance of the pyramid.

AttributeTypeValueDescription
showPlotBorderTrue/False0/1If you’ve rendered the pyramid chart in 2D mode, you can opt to show or hide the pyramid border using this attribute.
plotBorderColorColorHex Color CodeBorder color for pyramid (only when rendered in 2D mode).
plotBorderThicknessNumberIn pixelsBorder thickness for pyramid (only when rendered in 2D mode).
plotBorderAlphaNumber0 – 100Border alpha of pyramid slices (only when rendered in 2D mode).
plotFillAlphaNumber0 – 100Fill alpha for the pyramid slices.
minPlotHeightForValueNumberIn PixelsSet the minimum height in pixel of a column above which the data values will be visible.

Chart Cosmetics

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

AttributeTypeValueDescription
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.
bgRatioNumbers separated by commaAnyIf you’ve 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.
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.
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.
bgImageDisplayModeText‘stretch’, ’tile’, ‘fit’, ‘fill’, ‘center’, ‘none’Helps you specify the mode in which the background image is to be displayed. Stretch – expands the image to fit the entire chart area, without maintaining original image constraints. Tile – the image is repeated as a pattern on the entire chart area. Fit – fits the image proportionately on the chart area. Fill -proportionately fills the entire chart area with the image. Center – the image is positioned at the center of the chart area. None – Default mode.
bgImageVAlignText‘top’, ‘middle’, ‘bottom’Helps you to vertically align the background image.
bgImageHAlignText‘left’, ‘middle’, ‘right’Helps 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.
logoURLTextAnyYou 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.
logoPositionText‘TL’, ‘TR’, ‘BL’, ‘BR’, ‘CC’Where 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 – 100You can also change the size of externally loaded logo at run-time by specifying a value for this parameter.
logoLinkTextAnyIf 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.

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. Using Styles, you can also specify advanced font properties like Bold, Italics, HTML Mode etc. Using Styles you can also configure real-time values.

AttributeTypeValueDescription
baseFontTextFont NameThis attribute lets you set the font face (family) of all the text (data labels, values etc.) on chart. If you specify outCnvBaseFont attribute also, then this attribute controls only the font face of text within the chart canvas bounds.
baseFontSizeNumberAnyThis 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.

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 every data plot labels.

Legend Properties

In pyramid chart the name of each dataplot 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
legendCaptionTextAnyYou can add a caption for the entire legend by setting the same here.
legendIconScaleNumber1-5Scaling of legend icon is possible starting Exago. This attribute lets you control the size of the legend icon. The default scale value is 1. Anything less than 1 reduces the size of the legend-icons on the chart. Any value bigger than 1 enlarges the icons. e.g., 0.5 means half the size, whereas, 2 means twice the size.
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 particular legend key, the associated slice slides out from the chart. Re-clicking the key causes the slice to slide in.
legendNumColumnsNumberZero and Positive IntegersThe legend items are arranged in columns. Using this attribute, you can propose the number of columns. This value undergoes internal checking on judicious use of white-space. In case, the value is found improper, the chart auto-calculates the number of columns. When set to 0, the chart automatically decides the number of columns. The above is applicable when `legendPosition` is set to `BOTTOM“.` If the `legendPosition` is set to `RIGHT`, the number of columns is always set to 1.
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.

Tooltip Attributes

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 tooltip on chart?
showPercentInToolTipTrue/False0/1Whether to show percent values in tooltip? If not, the actual values will be shown.
toolTipBgColorColorHex Color CodeBackground color for tooltip.
toolTipColorColorHex Color CodeFont color for the tool-tip.
toolTipBorderColorColorHex Color CodeBorder color for tooltip.
tooltipBorderAlphaNumber0 – 100Sets the border transparency for tool tip.
toolTipSepCharTextAnyThe character specified as the value of this attribute separates the name and value displayed in tooltip.
showToolTipShadowTrue/False0/1Whether to show shadow for tooltips.
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, 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
plotBorderHoverColorColorHex color codeThis attribute sets the border color of the plot when hovered.
plotBorderHoverAlphaNumber0 – 100This attribute sets the transparency of plot border when hovered.
plotBorderHoverThicknessNumberIn pixelsSets the thickness of the border of plot when hovered.

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

The data Object

In single-series charts, each instance of the `data` object represents a data value to be plotted on the chart. For a single-series chart, one instance of the `data` object looks as shown in the example below:


"data"[{
		"label": "Jan",
		"value": "10000"
	}]

Attributes of the `data` object are used to set and configure the data values for the chart.

AttributeTypeValueDescription
labelTextAnyLabel for the pyramid slice.

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

valueNumberAnyNumerical value for the pyramid slice. This value will be plotted on the chart.
linkTextAnyYou can define links for individual data items. That enables the end user to click on data items (Pyramid slices) and drill-down to other pages. To define the link for data items, use the link attribute. You can define links that open in same window, new window, pop-up window or frames. Please see Drill-Down Charts section for more information. Also, you’ll need to URL Encode all the special characters (like ? and &) present in the link.
toolTextTextAnyBy default, Exago shows the “`label, value`” as tooltip text for that data item. But, if you want to display more information for the data item as tooltip, you can use this attribute to specify the same.
colorColorHex Color CodeColor for pyramid slice
alphaNumber0 – 100Alpha for pyramid slice.
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.
borderColorColorHex Color CodeBorder Color for the pyramid slice.
borderAlphaColorHex Color CodeBorder Alpha for the slice.
isSlicedTrue/False0/1This attribute determines whether a level of the pyramid appears as a part of the total chart or is sliced out as an individual item.
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 label is rendered using dashed lines.
labelBorderDashGapNumberIn pixelsSets the gap between two consecutive dashes when the border around x-axis label is rendered using dashed lines.
labelLinkURLAnySets the link for each individual data plot label.
hoverColorColorHex Color CodeThis attribute can set the hover color for a particular data plot.
hoverAlphaNumber0 – 100This attribute sets the transparency for a particular data plot when hovered.
borderHoverColorColorHex Color CodeThis attribute sets the border color of a data plot on hover.
borderHoverAlphaNumber0 – 100This attribute sets the border’s transparency for a data plot on hover.
borderHoverThicknessNumberIn pixelsThis attribute sets the thickness for a data plot’s border on hover.
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