Exago Logo
Search
Generic filters
Exact matches only

Chart Advanced Features: Spark Line

The following sections provide a list of available advanced attributes available for controlling and customizing Spark Line 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
connectNullDataTrue/False0/1This attributes lets you control whether empty datasets in your data will be connected to each other OR will they appear as broken datasets?
setAdaptiveYMinTrue/False0/1This attribute lets you set whether the y-axis lower limit will be 0 (in case of all positive values on chart) or should the y-axis lower limit adapt itself to a different figure based on values provided to the chart.
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.
showValuesTrue/False0/1Sets the configuration whether data values will be displayed along with the data plot on chart.
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.
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
captionPositionText“top”, “middle”, “bottom”Sets the position of the caption according to the canvas.
captionOnRightTrue/False0/1Whether caption should be on right of the canvas.
Default Value: 0
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

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

Data Plot (line) Properties

These attributes let you configure how your plot (lines) will appear on the chart.

AttributeTypeValueDescription
lineColorColorHex Color CodeColor using which the lines on the chart will be drawn.
lineThicknessNumberIn pixelsThickness of the lines on the chart.
lineAlphaNumber0 – 100Alpha of the lines on the chart.
showShadowTrue/False0/1Whether to apply the shadow effect for the data plot.

Anchor Properties

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

AttributeTypeValueDescription
drawAnchorsTrue/False0/1Whether to draw anchors on the chart.
anchorSidesNumberAnyThis attribute sets the number of sides the anchor will have. For e.g., an anchor with 3 sides will represent a triangle, with 4 it will be a square and so on.
anchorStartAngleNumber0 – 360This attribute sets the starting angle of anchors.
Default value: 90
anchorRadiusNumberIn pixelsThis attribute sets the radius (in pixels) of the anchor.
anchorColorColorHex Color CodeLets you set the color of anchors.
anchorAlphaNumber0 – 100Lets you set the alpha of anchors.
anchorImageUrlExago link formatURLIf you want to use an external image (JPG/PNG) as an anchor, this attribute lets you specify the URL.

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

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

Default value: 100

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

Default value: 100

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

Open, close, high & low properties

The spark line chart highlights the open, close, high & low points and also shows their value. Using the following attributes, you can configure the chart to: Change color of open, close, high, low points Opt whether to highlight each one using anchors Whether to show values for each one of them

AttributeTypeValueDescription
openColorColorHex Color CodeColor for opening value anchor.
closeColorColorHex Color CodeColor for closing value anchor.
highColorColorHex Color CodeColor for high value anchor.
lowColorColorHex Color CodeColor for low value anchor.
showOpenAnchorTrue/False0/1Whether to show anchor for opening value? By default this attribute is set to 1.
showCloseAnchorTrue/False0/1Whether to show anchor for closing value? By default this attribute is set to 1.
showHighAnchorTrue/False0/1Whether to show anchor for high value? By default this attribute is set to 1.
showLowAnchorTrue/False0/1Whether to show anchor for low value? By default this attribute is set to 1.
showOpenValueTrue/False0/1Whether to show the opening value beside the chart? By default this attribute is set to 1.
showCloseValueTrue/False0/1Whether to show the closing value beside the chart? By default this attribute is set to 1.
showHighLowValueTrue/False0/1Whether to show the high/low value beside the chart? By default this attribute is set to 1.

Period block properties

Period blocks are alternate colored bands to easily interpret periods on the chart. The following attributes helps in configuring Period blocks.

AttributeTypeValueDescription
periodLengthNumberAnyHow many data points will each period block encapsulate?
periodColorColorHex Color CodeColor for the period block.
periodAlphaNumber0 – 100Alpha for the period block.

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.

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

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.

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 for the annotations?
toolTipBgColorColorHex Color CodeBackground color for the tooltip
toolTipColorColorHex Color CodeFont color for the tool-tip.
toolTipBorderColorColorHex Color CodeBorder Color for the tooltip.
tooltipBorderAlphaNumber0 – 100Sets the border transparency for tool tip.
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
openHoverColorColorHex color codeThis attribute sets the hover color for opening value anchor.
closeHoverColorColorHex color codeThis attribute sets the hover color for closing value anchor.
highHoverColorColorHex color codeThis attribute sets the hover color for high value anchor.
lowHoverColorColorHex color codeThis attribute sets the hover color for low value anchor.

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 horizontal space (in pixels) between the caption and left side of chart canvas.
valuePaddingNumberIn pixelsThis attribute lets you control the horizontal space between value textboxes and chart.
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.
canvasLeftMarginNumberIn pixelsLeft margin of canvas. Canvas will start from that position.
canvasRightMarginNumberIn pixelsRight margin of canvas. Canvas will end at that position.

The data Object

n 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
alphaNumber0 – 100This attribute determines the transparency of a data item. The range for this attribute is 0 to 100. 0 means complete transparency (the data item wont be shown on the graph) and 100 means opaque.
colorColorHex Color CodeIf you want to define your own colors for the data items on chart, use this attribute to specify color for the data item.
dashedTrue/False0/1Whether the border of this data item should appear as dashed. This is particularly useful when you want to highlight a data (such as forecast or trend etc.).
displayValueText If instead of the numerical value of this data, you wish to display a custom string value, you can specify the same here. Examples are annotation for a data item etc.
linkTextAnyYou can define links for individual data items. That enables the end user to click on data items (columns, lines, bars etc.) and drill down to other pages. To define the link for data items, use the link attribute. You can define links that open in same window, new window, pop-up window or frames. Please see “Drill-Down > Using JavaScript Functions as Links” for more information. Also, you’ll need to Url Encode all the special characters (like ? and &) present in the link.
showValueTrue/False0/1You can individually opt to show/hide values of individual data items using this attribute.
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.

Trend-lines

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

AttributeTypeValueDescription
alphaNumberAnyAlpha of the trend line.
colorColorHex Color CodeColor of the trend line and its associated text
dashedTrue/False0/1Whether the trendline should be rendered as dashed lines.

Default value: 0 (trendline rendered using straight lines)

dashLenNumberIn pixelsSets the length of each dash when trendline is rendered as dashed lines.
dashGapNumberIn pixelsSets the gap between consecutive dashes when trendline is rendered as dashed lines.
endValueNumberAnyThe ending y-axis value for the trendline. Say, if you want to plot a slanted trendline from value 102 to 109, the `endValue` will be 109. If you do not specify a value for `endValue`, it will automatically assume the same value as `startValue`.
isTrendZoneTrue/False0/1Whether the trend will be displayed as a line or a zone (fill-colored rectangle).
showOnTopTrue/False0/1By default, the trendline/trendzone appears below the dataplots. This attribute allows you to display the trendline/trendzone on top of the dataplots.
startValueNumberAnyThe starting value for the trendline. Say, if you want to plot a slanted trendline from value 102 to 109, the `startValue` will be 102.
thicknessNumberIn pixelsIf you’ve opted to show the trend as a line, this attribute lets you define the thickness of trend line.

Trend-lines (Chart level attributes)

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

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