Scroll

Chart Attributes: Pyramid

Note. This documentation is taken from a third-party source. Not every attribute listed may be supported in Exago BI.

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.

Attribute Type Value Description
animation True/False 0/1 This attribute lets you set the configuration whether the chart should appear in an animated fashion. If you do not want to animate any part of the chart, set this as 0.
animationDuration Number In seconds This attribute sets the animation duration, if `animation` is set to `1`.
Default value: 1 sec
clickURL URL in Exago format Any The entire chart can now act as a hotspot. Use this URL to define the hotspot link for the chart. The link can be specified in Exago Link Format.
clickURLOverridesPlotLinks True/False 0/1 Sets whether the `clickURL` attribute (that sets a link to which the user is directed when the chart is clicked) overrides the `link` attribute (that sets a link to which the user is directed when a data plot is clicked).
Default value: 0 (`clickURL` does not override `link`)
palette Number 1-5 Each chart has 5 pre-defined color palettes which you can choose from. Each palette renders the chart in a different color theme.
paletteThemeColor Color Hex Color Code If you want your own palette derived from a particular hex color, you can specify the same here. All other colors on the chart will automatically derive from that palette.
annRenderDelay Number In seconds If you've defined any annotation groups over the chart, using this attribute you can set the duration after which they'll render on the chart. The timer starts from the time the chart has initialized.
showPrintMenuItem True/False 0/1 Whether to show "Print Chart" item in the context menu of the chart? Even if you opt to hide the item in context menu, you can still opt to invoke `print()` JavaScript method of the chart to print the same.
manageResize True/False 0/1 Setting this attribute to 1, you can allow the chart to automatically resize itself when the parent container of the chart is resized.
useEllipsesWhenOverflow True/False 0/1 When enabled in auto mode, long data labels are truncated by adding ellipses to prevent them from overflowing the chart background. The default value is 1.
hasRTLText Number Any This attribute, when set to `1`, indicates to the chart that the text (rendered on the chart) may contain RTL characters and the textual display has to be managed accordingly.
plotHighlightEffect Text Any This attribute lets you enable/disable the highlight effect, in the form of a `fadeout`, for the data plots corresponding to a legend item. When this attribute is enabled and the mouse pointer is hovered over a legend item label, plots belonging to the other data series fadeout, by reducing their opacity.
The fadeout effect can be customized by specifying the fadeout color and opacity using the `color` and `alpha` attributes. Eg. `fadeout|color=#ff0000, alpha=60`
theme Text ‘carbon’, ‘fint’, ‘ocean’, ‘zune’ This attribute changes the theme of the chart. There are 4 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.

Attribute Type Value Description
baseChartMessageFont Text Any This attribute allows to set a custom font for all chart messages.
baseChartMessageFontSize Number In pixels This attribute allows to set a custom font size for all chart messages.
baseChartMessageColor Color Hex Color Code This attribute allows to set a custom font color for all chart messages.
baseChartMessageImageHAlign Text left, middle, right This attribute allows to set a custom horizontal alignment for all images displayed as chart messages.
Default value: middle
baseChartMessageImageVAlign Text top, middle, bottom This attribute allows to set a custom vertical alignment for all images displayed as chart messages.
Default value: middle
baseChartMessageImageAlpha Number 0 - 100 This attribute allows to set a transparency for all images displayed as chart messages.
Default value: 100
baseChartMessageImageScale Number 0-300 This attribute allows to set a scale for magnifying all images displayed as chart messages.
Default value: 100
loadMessage Text Any This attribute allows to set the message to be displayed when a chart begins to load. To display an image as the chart message, prefix `I-` to the image URL.
loadMessageFont Text Font Name This attribute allows to set the font for the message displayed when a chart begins to load.
loadMessageFontSize Number In pixels This attribute allows to set the font size for the message displayed when a chart begins to load.
loadMessageColor Color Hex Color Code This attribute allows to set the font color for the message displayed when a chart begins to load.
loadMessageImageHAlign Text left, middle, right If an image is displayed as the chart `loadMessage`, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the `baseChartMessageImageHAlign` attribute
loadMessageImageVAlign Text top, middle, bottom If an image is displayed as the chart `loadMessage`, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the `baseChartMessageImageVAlign` attribute
loadMessageImageAlpha Number 0 - 100 If an image is displayed as the chart `loadMessage`, this attribute allows to set the transparency of the image.
Default value: 100
loadMessageImageScale Number 0-300 If an image is displayed as the chart `loadMessage`, this attribute allows to set the scale for magnifying the image.
Default value: 100
typeNotSupportedMessage Text Any This attribute allows to set the message to be displayed when the specified chart type is not supported. To display an image as the chart message, prefix `I-` to the image URL.
typeNotSupportedMessageFont Text Font Name This attribute allows to set the font for the message displayed when the specified chart type is not supported.
typeNotSupportedMessageFontSize Number In pixels This attribute allows to set the font size for the message displayed when the specified chart type is not supported.
typeNotSupportedMessageColor Color Hex Color Code This attribute allows to set the font color for the message displayed when the specified chart type is not supported.
typeNotSupportedMessageImageHAlign Text left, middle, right If an image is displayed as the chart `typeNotSupportedMessage`, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the `baseChartMessageImageHAlign` attribute
typeNotSupportedMessageImageVAlign Text top, middle, bottom If an image is displayed as the chart `typeNotSupportedMessage`, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the `baseChartMessageImageVAlign` attribute
typeNotSupportedMessageImageAlpha Number 0 - 100 If an image is displayed as the chart `typeNotSupportedMessage`, this attribute allows to set the transparency of the image.
Default value: 100
typeNotSupportedMessageImageScale Number 0-300 If an image is displayed as the chart `typeNotSupportedMessage`, this attribute allows to set the scale for magnifying the image.
Default value: 100
renderErrorMessage Text Any This attribute allows to set the message to be displayed if an error is encountered while rendering the chart. To display an image as the chart message, prefix `I-` to the image URL.
renderErrorMessageFont Text Font Name This attribute allows to set a font for the message displayed if an error is encountered while rendering the chart.
renderErrorMessageFontSize Number In pixels This attribute allows to set the font size for the message displayed if an error is encountered while rendering the chart.
renderErrorMessageColor Color Hex Color Code This attribute allows to set the font color for the message displayed if an error is encountered while rendering the chart.
renderErrorMessageImageHAlign Text left, middle, right If an image is displayed as the chart `renderErrorMessage`, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the `baseChartMessageImageHAlign` attribute
renderErrorMessageImageVAlign Text top, middle, bottom If an image is displayed as the chart `renderErrorMessage`, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the `baseChartMessageImageVAlign` attribute
renderErrorMessageImageAlpha Number 0 - 100 If an image is displayed as the chart `renderErrorMessage`, this attribute allows to set the transparency of the image.
Default value: 100
renderErrorMessageImageScale Number 0-300 If an image is displayed as the chart `renderErrorMessage`, this attribute allows to set the scale for magnifying the image.
Default value: 100
dataLoadStartMessage Text Any This attribute allows to set the message to be displayed when chart data begins loading. To display an image as the chart message, prefix `I-` to the image URL.
dataLoadStartMessageFont Text Font Name This attribute allows to set a font for the message displayed when chart data begins loading.
dataLoadStartMessageFontSize Text In pixels This attribute allows to set the font size for the message displayed when chart data begins loading.
dataLoadStartMessageColor Color Hex Color Code This attribute allows to set the font color for the message displayed when chart data begins loading.
dataLoadStartMessageImageHAlign Text left, middle, right If an image is displayed as the chart `dataLoadStartMessage`, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the `baseChartMessageImageHAlign` attribute
dataLoadStartMessageImageVAlign Text top, middle, bottom If an image is displayed as the chart `dataLoadStartMessage`, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the `baseChartMessageImageVAlign` attribute
dataLoadStartMessageImageAlpha Number 0 - 100 If an image is displayed as the chart `dataLoadStartMessage`, this attribute allows to set the transparency of the image.
Default value: 100
dataLoadStartMessageImageScale Number 0-300 If an image is displayed as the chart `dataLoadStartMessage`, this attribute allows to set the scale for magnifying the image.
Default value: 100
dataEmptyMessage Text Any This attribute allows to set the message to be displayed if the data loaded for a chart is empty. To display an image as the chart message, prefix `I-` to the image URL.
dataEmptyMessageFont Text Font Name This attribute allows to set the font for the message displayed if the data loaded for a chart is empty
dataEmptyMessageFontSize Number In pixels This attribute allows to set the font size for the message displayed if the data loaded for a chart is empty.
dataEmptyMessageColor Color Hex Color Code This attribute allows to set the font color for the message displayed if the data loaded for a chart is empty.
dataEmptyMessageImageHAlign Text left, middle, right If an image is displayed as the chart `dataEmptyMessage`, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the `baseChartMessageImageHAlign` attribute
dataEmptyMessageImageVAlign Text top, middle, bottom If an image is displayed as the chart `dataEmptyMessage`, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the `baseChartMessageImageVAlign` attribute
dataEmptyMessageImageAlpha Number 0 - 100 If an image is displayed as the chart `dataEmptyMessage`, this attribute allows to set the transparency of the image.
Default value: 100
dataEmptyMessageImageScale Number 0-300 If an image is displayed as the chart `dataEmptyMessage`, this attribute allows to set the scale for magnifying the image.
Default value: 100
dataLoadErrorMessage Text Any This attribute allows to set the message to be displayed if an error is encountered while loading chart data. To display an image as the chart message, prefix `I-` to the image URL.
dataLoadErrorMessageFont Text Font Name This attribute allows to set a font for the message displayed if an error is encountered while loading chart data.
dataLoadErrorMessageFontSize Number In pixels This attribute allows to set the font size for the message displayed if an error is encountered while loading chart data.
dataLoadErrorMessageColor Color Hex Color Code This attribute allows to set the font color for the message displayed if an error is encountered while loading chart data.
dataLoadErrorMessageImageHAlign Text left, middle, right If an image is displayed as the chart `dataLoadErrorMessage`, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the `baseChartMessageImageHAlign` attribute
dataLoadErrorMessageImageVAlign Text top, middle, bottom If an image is displayed as the chart `dataLoadErrorMessage`, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the `baseChartMessageImageVAlign` attribute
dataLoadErrorMessageImageAlpha Number 0 - 100 If an image is displayed as the chart `dataLoadErrorMessage`, this attribute allows to set the transparency of the image.
Default value: 100
dataLoadErrorMessageImageScale Number 0-300 If an image is displayed as the chart `dataLoadErrorMessage`, this attribute allows to set the scale for magnifying the image.
Default value: 100
dataInvalidMessage Text Any This attribute allows to set the message to be displayed if the data to be loaded for the chart is invalid. To display an image as the chart message, prefix `I-` to the image URL.
dataInvalidMessageFont Text Font Name This attribute allows to set the font for the message displayed if the specified chart data is invalid.
dataInvalidMessageFontSize Number In pixels This attribute allows to set the font size for the message displayed if the specified chart data is invalid.
dataInvalidMessageColor Color Hex Color Code This attribute allows to set the font color for the message displayed if the specified chart data is invalid.
dataInvalidMessageImageHAlign Text left, middle, right If an image is displayed as the chart `dataInvalidMessage`, this attribute allows to set a custom horizontal alignment for the image.
Default value: value assigned to the `baseChartMessageImageHAlign` attribute
dataInvalidMessageImageVAlign Text top, middle, bottom If an image is displayed as the chart `dataInvalidMessage`, this attribute allows to set a custom vertical alignment for the image.
Default value: value assigned to the `baseChartMessageImageVAlign` attribute
dataInvalidMessageImageAlpha Number 0 - 100 If an image is displayed as the chart `dataInvalidMessage`, this attribute allows to set the transparency of the image.
Default value: 100
dataInvalidMessageImageScale Number 0-300 If 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.

Attribute Type Value Description
caption Text Any Caption of the chart.
subCaption Text Any Sub-caption of the chart.

Chart Caption Cosmetics

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

Attribute Type Value Description
captionAlignment Text "left", "center", "right" Sets horizontal alignment of caption
captionOnTop True/False 0/1 Whether caption should be on top of the data plot area
captionFontSize Number 6 - 72 Sets the caption font size in pixels
subCaptionFontSize Number 6 - 72 Sets the sub-caption font size (in pixels)
captionFont Text Font Name Sets the caption font family
subCaptionFont Text Font Name Sets the sub-caption font family
captionFontColor Color Hex Color Code Sets the caption font color
subCaptionFontColor Color Hex Color Code Sets the sub-caption font color
captionFontBold True/False 0/1 Whether the caption font should be displayed in bold
subCaptionFontBold True/False 0/1 Whether the sub caption font should be displayed in bold
alignCaptionWithCanvas True/False 0/1 Whether the caption is aligned with the canvas. Else, it will be aligned with the entire chart area
captionHorizontalPadding Number In Pixels If 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.

Attribute Type Value Description
showLabels True/False 0/1 Allows you to show/hide the labels of the pyramid chart.
showLabelsAtCenter True/False 0/1 Whether to show the labels of each pyramid at its side or at the center? This attribute is only applicable for 2D Pyramid chart.
labelDistance Number In pixels Lets you set the horizontal distance between the data labels & pyramid slices.
labelSepChar Text Any If you've opted to show both pyramid label & value, this attribute lets you specify the character using which they'll be separated.
enableSmartLabels True/False 0/1 Whether to use smart lines & labels for the pyramid chart?
smartLineColor Color Hex Color Code If you've opted to use smart lines, this attribute lets you define the color for the same.
smartLineThickness Number In pixels Thickness of smart lines.
smartLineAlpha Number 0 - 100 Alpha of the smart lines.
showValues True/False 0/1 Allows you to show/hide the data values along with the pyramid slices on chart.
showPercentValues True/False 0/1 Whether 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

Attribute Type Value Description
formatNumber True/False 0/1 This configuration determines whether the numbers displayed on the chart will be formatted using commas, e.g., 40,000 if 'formatNumber': '1'; and 40000 if 'formatNumber': '0';
numberPrefix Text Any Using this attribute, you could add prefix to all the numbers visible on the graph. For example, to represent all dollars figure on the chart, you could specify this attribute to $ to show like $40000, $50000.
numberSuffix Text Any Using this attribute, you could add suffix to all the numbers visible on the graph. For example, to represent all figures quantified as per annum on the chart, you could specify this attribute to '/a' to show like 40000/a, 50000/a.
decimals Number Any Number of decimal places to which all numbers on the chart will be rounded to.
forceDecimals True/False 0/1 Whether to add 0 padding at the end of decimal numbers? For example, if you set decimals as 2 and a number is 23.4. If `forceDecimals` is set to 1, the number will automatically be converted 23.40 (note the extra 0 at the end).
formatNumberScale True/False 0/1 Configuration whether to add K (thousands) and M (millions) to a number after truncating and rounding it - e.g., if `formatNumberScale` is set to 1, 1043 will become 1.04K (with decimals set to 2 places). Same with numbers in millions - an M will be added at the end.
defaultNumberScale Text Any The default unit of the numbers that you're providing to the chart.
numberScaleUnit Text Any Unit of each block of the scale.
numberScaleValue Text Any Range of the various blocks that constitute the scale.
forceNumberScale True/False 0/1 If a data value is less than the lowest given number is the number scale, this attribute forces the lower value of the `numberScaleUnit` to be applied to that data value. This attribute works only when `“formatNumberScale”: “1”` and the `defaultNumberScale` attribute is not defined.
For example, if `“numberScaleUnit”: “K, M”`, `“numberScaleValue”: “1000, 1000”`, and `“forceNumberScale”: “1”`, a data value of `400` will be rendered as `0.40K`.
scaleRecursively True/False 0/1 Whether recursive scaling should be applied.
maxScaleRecursion Number Any How many recursions to complete during recursive scaling? -1 completes the entire set of recursion.
scaleSeparator Text Any What character to use to separate the scales that are generated after recursion?
decimalSeparator Text Any This attribute helps you specify the character to be used as the decimal separator in a number.
thousandSeparator Text Any This attribute helps you specify the character to be used as the thousands separator in a number.
thousandSeparatorPosition Number Any This option helps you specify the position of the thousand separator.
inDecimalSeparator Text Any In some countries, commas are used as decimal separators and dots as thousand separators. In XML/JSON, if you specify such values, it will give an error while converting to number. So, 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.
inThousandSeparator Text Any In some countries, commas are used as decimal separators and dots as thousand separators. In XML/JSON, if you specify such values, it will give an error while converting to number. The chart accepts the input decimal and thousand separators from user, so that it can convert it accordingly into the required format. This attribute lets you input the thousand separators.

Pyramid Functional Properties

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

Attribute Type Value Description
is2D True/False 0/1 Whether the chart will render as 2D?
isSliced True/False 0/1 This attribute determines whether a level of the pyramid appears as a part of the total chart or is sliced out as an individual item.
pyramidYScale Number 0-40 Lets you set the 3D perspective of the pyramid. You'll need to restrict your values to a value between 0 and 40 (depending on your pyramid chart dimensions) to get a proper drawing.
use3dlighting True/False 0/1 This attribute when set to `1` shows a 3D effect to the pyramid chart only when _is2d_ attribute is set to `1` . When we set this attribute to `0`, it displays a simple pyramid chart.

Pyramid Cosmetic properties

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

Attribute Type Value Description
showPlotBorder True/False 0/1 If you've rendered the pyramid chart in 2D mode, you can opt to show or hide the pyramid border using this attribute.
plotBorderColor Color Hex Color Code Border color for pyramid (only when rendered in 2D mode).
plotBorderThickness Number In pixels Border thickness for pyramid (only when rendered in 2D mode).
plotBorderAlpha Number 0 - 100 Border alpha of pyramid slices (only when rendered in 2D mode).
plotFillAlpha Number 0 - 100 Fill alpha for the pyramid slices.

Chart Cosmetics

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

Attribute Type Value Description
bgColor Color Hex Color Code This attribute sets the background color for the chart. You can set any hex color code as the value of this attribute. To specify a gradient as background color, separate the hex color codes of each color in the gradient using comma. Example: `#FF5904, #FFFFFF`.
bgAlpha Number 0 - 100 Sets the alpha (transparency) for the background. If you've opted for gradient background, you need to set a list of alpha(s) separated by comma.
bgRatio Numbers separated by comma Any If you've opted for a gradient background, this attribute lets you set the ratio of each color constituent.
bgAngle Number 0-360 Angle of the background color, in case of a gradient.
showBorder True/False 0/1 Whether to show a border around the chart or not?
borderColor Color Hex Color Code Border color of the chart.
borderThickness Number In pixels Border thickness of the chart.
borderAlpha Number 0 - 100 Border alpha of the chart.
bgImage Text Any To place any image (JPG/PNG/GIF) as background of the chart, enter the (path and) name of the background image. It should be in the same domain as the chart.
bgImageAlpha Number 0 - 100 This attribute specifies the opacity for the loaded background image.
bgImageDisplayMode Text '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.
bgImageVAlign Text 'top', 'middle', 'bottom' Helps you to vertically align the background image.
bgImageHAlign Text 'left', 'middle', 'right' Helps you to horizontally align the background image.
bgImageScale Number 0-300 Helps you magnify the background image. This attribute will only work when the attribute `bgImageDisplayMode` is set to none, center, or tile.
logoURL Text Any You can load an external logo (JPEG/PNG) to your chart, this attribute lets you specify the URL. Due to cross domain security restrictions it is advised to use a logo from the same domain name as your charts.
logoLeftMargin Number In Pixels This attribute helps you set the amount of empty space that you want to put on the left side of your logo image. Nothing is rendered in this space.
logoTopMargin Number In Pixels This attribute helps you set the amount of empty space that you want to put on top of your logo image. Nothing is rendered in this space.
logoPosition Text '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
logoAlpha Number 0 - 100 Once the logo has loaded on the chart, you can configure its opacity using this attribute.
logoScale Number 0 - 100 You can also change the size of externally loaded logo at run-time by specifying a value for this parameter.
logoLink Text Any If 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.

Attribute Type Value Description
baseFont Text Font Name This attribute lets you set the font face (family) of all the text (data labels, values etc.) on chart. If you specify outCnvBaseFont attribute also, then this attribute controls only the font face of text within the chart canvas bounds.
baseFontSize Number Any This attribute sets the base font size of the chart i.e., all the values and the names in the chart which lie on the canvas will be displayed using the font size provided here.
baseFontColor Color Hex Color Code This attribute sets the base font color of the chart i.e., all the values and the names in the chart which lie on the canvas will be displayed using the font color provided here.

Data Label Cosmetics

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

Attribute Type Value Description
labelFont Text Font Name Sets the x-axis label font family for the text.
labelFontColor Color Hex Color Code Sets the x-axis label font color.
labelFontSize Number 6 - 72 Specifies the x-axis label font size.
labelFontBold True/False 0/1 Flag indicating whether x-axis label font should be bold or not.
labelFontItalic True/False 0/1 Flag indicating whether x-axis label font should be italicized or not.
labelBgColor Color Hex Color Code Sets the background color for x-axis label text.
labelBorderColor Color Hex Color Code Sets the color of the border around the x-axis label text.
labelAlpha Number 0 - 100 Sets the x-axis label alpha for both font and background.
labelBgAlpha Number 0 - 100 Sets the x-axis label background alpha.
labelBorderAlpha Number 0 - 100 Sets the x-axis label border alpha.
labelBorderPadding Number In Pixels Sets the x-axis label border padding.
labelBorderRadius Number In Pixels Sets the x-axis label border radius.
labelBorderThickness Number In Pixels Sets the x-axis label border thickness.
labelBorderDashed True/False 0/1 Whether the border around x-axis labels should be rendered using dashed lines.

Default value: 0 (border rendered using straight lines)
labelBorderDashLen Number In pixels Sets the length of each dash when the border around the x-axis labels are rendered using dashed lines.
labelBorderDashGap Number In pixels Sets the gap between two consecutive dashes when the border around x-axis labels are rendered using dashed lines.
labelLink URL Any Sets 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.

Attribute Type Value Description
showLegend True/False 0/1 Whether to show legend on the chart.
legendItemFontBold True/False 0/1 Whether legend keys should be displayed in bold
legendItemFont Text Font Name Sets legend item font
legendItemFontSize Number 6 - 72 Sets legend item font size
legendItemFontColor Color Hex Color Code Sets legend item font color
legendItemHoverFontColor Color Hex Color Code Sets legend item font color on hover
legendPosition Text 'BOTTOM' or 'RIGHT' The legend can be plotted at two positions on the chart - below (BOTTOM) the chart and to the right (RIGHT) of the chart.
legendCaptionAlignment Text "left", "center", "right" Sets the legend caption horizontal alignment .
legendCaptionFontBold True/False 0/1 Whether legend caption should be displayed in bold
legendCaptionFont Text Font Name Sets legend caption font
legendCaptionFontSize Number 6 - 72 Sets legend caption font size
legendCaptionFontColor Color Hex Color Code Sets legend caption font color
legendCaption Text Any You can add a caption for the entire legend by setting the same here.
legendIconScale Number 1-5 Scaling 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.
legendBgColor Color Hex Color Code Background color for the legend.
legendBgAlpha Number 0 - 100 Background alpha for the legend.
legendBorderColor Color Hex Color Code Border Color for the legend.
legendBorderThickness Number In pixels Border thickness for the legend.
legendBorderAlpha Number 0 - 100 Border alpha for the legend.
legendShadow True/False 0/1 Whether to show a shadow for legend.
legendAllowDrag True/False 0/1 The legend can be made drag-able by setting this attribute to 1. End viewers of the chart can drag the legend around on the chart.
legendScrollBgColor Color Hex Color Code If you've too many items on the legend, a scroll bar shows up on the same. This attribute lets you configure the background color of the scroll bar.
reverseLegend True/False 0/1 You can reverse the ordering of datasets in the legend by setting this attribute to 1.
interactiveLegend True/False 0/1 This attribute lets you interact with the legend in your chart. When you click a particular legend key, the associated slice slides out from the chart. Re-clicking the key causes the slice to slide in.
legendNumColumns Number Zero and Positive Integers The legend items are arranged in columns. Using this attribute, you can propose the number of columns. This value undergoes internal checking on judicious use of white-space. In case, the value is found improper, the chart auto-calculates the number of columns. When set to 0, the chart automatically decides the number of columns. The above is applicable when `legendPosition` is set to `BOTTOM``.` If the `legendPosition` is set to `RIGHT`, the number of columns is always set to 1.
minimiseWrappingInLegend True/False 0/1 Whether to minimize legend item text wrapping.
drawCustomLegendIcon True/False 0/1 Specifies whether drawing a custom legend icon will be enabled. All legend icon customization attributes will work only if this feature is enabled.
Default value: 0 (disabled)
legendIconBorderColor Color Hex Color Code Sets the border color for the legend icon.
Default value: Data plot border color
legendIconBgColor Color Hex Color Code Sets the background color for the legend icon.
Default value: Data plot fill color
legendIconAlpha Number 0 - 100 Sets the legend icon transparency.
Default value: 100
legendIconBgAlpha Number 0 - 100 Sets the legend icon background transparency.
Default value: 100
legendIconSides Number Any Sets the number of sides for the legend icon.
Default value: 4
legendIconBorderThickness Number 1-5 Sets the thickness of the legend icon border.
Default value: 1
legendIconStartAngle Number Any Sets the starting angle of for drawing the legend icon.
Default value: 45
alignLegendWithCanvas True/False 0/1 This attribute if set to `0`, the legend box will be center aligned with respect to the entire width of the chart only if the total width of the legend box is more than the canvas width. By default, the legend box is center aligned with respect to the canvas width and it remains the same if the width of the legend box is less than the canvas width.

Tooltip properties

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

Attribute Type Value Description
showToolTip True/False 0/1 Whether to show tooltip on chart?
showPercentInToolTip True/False 0/1 Whether to show percent values in tooltip? If not, the actual values will be shown.
toolTipBgColor Color Hex Color Code Background color for tooltip.
toolTipColor Color Hex Color Code Font color for the tool-tip.
toolTipBorderColor Color Hex Color Code Border color for tooltip.
tooltipBorderAlpha NUmber 0 - 100 Sets the border transparency for tool tip.
toolTipSepChar Text Any The character specified as the value of this attribute separates the name and value displayed in tooltip.
showToolTipShadow True/False 0/1 Whether to show shadow for tooltips.
plottooltext Text Any This attribute works on text of the tooltip. It is used to specify the text, i.e. you can use it to give a specific constant string for every tooltip. You can also use variable values from the data level by putting a "$" sign infront of it, eg $name, and you'll get the value of the name in the tooltip according to the pyramid.

Attributes for Exporting Charts

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

Attribute Type Value Description
exportEnabled True/False 0/1 Whether the chart will allow exporting to images, PDFs, SVG or XLS.

Default value: 0
exportAction Text '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
exportHandler Text Any In case of server side exporting, this refers to the path of the server-side export handler (the ready-to-use scripts that we provide).
exportFormats Text Any Lets you configure what output formats to allow for export of chart, in the export context menu, and also customize the label for each menu item. The attribute value should be a pipe (|) delimited separated key-value pair. Example: `exportFormats: 'PNG=Export as High Quality Image|JPG|PDF=Export as PDF File'`
exportAtClientSide True/False 0/1 This attribute when set to `1`, enables the client-side export feature.

Default value: 0
exportShowMenuItem True/False 0/1 Whether the menu items related to export (e.g., Save as JPEG etc.) will appear in the context menu of chart.
exportTargetWindow Text '_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 XLS will open in same window (as an attachment for download), or whether it will open in a new window.

Default value: _self
exportFileName Text Any Using 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.

Attribute Type Value Description
showHoverEffect True/False 0/1 Whether to enable hover effect on charts for all elements
plotHoverEffect True/False 0/1 Whether to enable hover effect on charts for data plots (e.g., column, pie) only
plotFillHoverColor Color Hex Color Code Specifies the hover color for the data plots
plotFillHoverAlpha Number 1 - 100 Specifies the hover alpha for data plots
plotBorderHoverColor Color Hex color code This attribute sets the border color of the plot when hovered.
plotBorderHoverAlpha Number 0 - 100 This attribute sets the transparency of plot border when hovered.
plotBorderHoverThickness Number In pixels Sets 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.

Attribute Type Value Description
captionPadding Number In pixels This attribute lets you control the space (in pixels) between the sub-caption and top of the chart canvas. If the sub-caption is not defined, it controls the space between caption and top of chart canvas. If neither caption, nor sub-caption is defined, this padding does not come into play.
chartLeftMargin Number In pixels Amount of empty space that you want to put on the left side of your chart. Nothing is rendered in this space.
chartRightMargin Number In pixels Amount of empty space that you want to put on the right side of your chart. Nothing is rendered in this space.
chartTopMargin Number In pixels Amount of empty space that you want to put on the top of your chart. Nothing is rendered in this space.
chartBottomMargin Number In pixels Amount 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.

Attribute Type Value Description
label Text Any Label for the pyramid slice.

Note: The `label` attribute replaces the `name` attribute. Previously, either one of the attributes could be used to set the label. Support for the `name` attribute has been discontinued since v3.10.0.
value Number Any Numerical value for the pyramid slice. This value will be plotted on the chart.
link Text Any You can define links for individual data items. That enables the end user to click on data items (Pyramid slices) and drill-down to other pages. To define the link for data items, use the link attribute. You can define links that open in same window, new window, pop-up window or frames. Please see Drill-Down Charts section for more information. Also, you'll need to URL Encode all the special characters (like ? and &) present in the link.
toolText Text Any By 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.
color Color Hex Color Code Color for pyramid slice
alpha Number 0 - 100 Alpha for pyramid slice.
showValue True/False 0/1 You can individually opt to show/hide values of individual data items using this attribute. This value over-rides the dataset level value.
borderColor Color Hex Color Code Border Color for the pyramid slice.
borderAlpha Color Hex Color Code Border Alpha for the slice.
isSliced True/False 0/1 This attribute determines whether a level of the pyramid appears as a part of the total chart or is sliced out as an individual item.
labelFont Text Font Name Sets the x-axis label font family for the text.
labelFontColor Color Hex Color Code Sets the x-axis label font color.
labelFontSize Number 6 - 72 Specifies the x-axis label font size.
labelFontBold True/False 0/1 Flag indicating whether x-axis label font should be bold or not.
labelFontItalic True/False 0/1 Flag indicating whether x-axis label font should be italicized or not.
labelBgColor Color Hex Color Code Sets the background color for x-axis label text.
labelBorderColor Color Hex Color Code Sets the color of the border around the x-axis label text.
labelAlpha Number 0 - 100 Sets the x-axis label alpha for both font and background.
labelBgAlpha Number 0 - 100 Sets the x-axis label background alpha.
labelBorderAlpha Number 0 - 100 Sets the x-axis label border alpha.
labelBorderPadding Number In Pixels Sets the x-axis label border padding.
labelBorderRadius Number In Pixels Sets the x-axis label border radius.
labelBorderThickness Number In Pixels Sets the x-axis label border thickness.
labelBorderDashed True/False 0/1 Whether the border around x-axis labels should be rendered using dashed lines.

Default value: 0 (border rendered using straight lines)
labelBorderDashLen Number In pixels Sets the length of each dash when the border around the x-axis label is rendered using dashed lines.
labelBorderDashGap Number In pixels Sets the gap between two consecutive dashes when the border around x-axis label is rendered using dashed lines.
labelLink URL Any Sets the link for each individual data plot label.
hoverColor Color Hex Color Code This attribute can set the hover color for a particular data plot.
hoverAlpha Number 0 - 100 This attribute sets the transparency for a particular data plot when hovered.
borderHoverColor Color Hex Color Code This attribute sets the border color of a data plot on hover.
borderHoverAlpha Number 0 - 100 This attribute sets the border's transparency for a data plot on hover.
borderHoverThickness Number In pixels This attribute sets the thickness for a data plot's border on hover.

Hidden Article Information

Article Author
Exago Development
created 2017-11-16 15:36:38 UTC
updated 2017-11-16 15:36:38 UTC

Labels
no labels yet!
Have more questions? Submit a request