SVG Bipolar charts API reference

Summary: Documentation about the SVG Bipolar chart including information about all the options and methods that are available to you.

 

Example

The code below produces a chart like this:

<script>
    new RGraph.SVG.Bipolar({
        id: 'chart-container',
        left: [8,6,4,5,2,9],
        right: [1,8,6,3,8,9],
        options: {
            title: 'An animated Bipolar chart',
            titleSubtitle: 'A subtitle for the chart that was generated on Sunday',
            titleSubtitleItalic: true,
            marginTop: 50,
            colors: ['Gradient(#f00:#faa:#f00)'],
            yaxisLabels: ['Monday','Tuesday','Thursday','Friday','Saturday','Sunday'],
            yaxisTextSize: 16,
            yaxisTextBold: true,
            yaxisTextItalic: true,
            xaxis: false,
            yaxisColor: '#aaa',
            shadow: true,
            marginInner: 15
        }
    }).grow();
</script>

 

The coordinates properties

The coordinates for the bars on the Bipolar chart are held in the following arrays:

 

Properties

You can use these properties to control how the chart appears. You can set them by including them in the options section of the configuration as above.

Background properties

PropertyDescriptionDefault
backgroundColorThe color of the background.null
backgroundImageLeftA URL of an image to render to the left background.null
backgroundImageLeftAspectThe aspect ratio setting of the left SVG image tag, eg it could be XMinYMin meet.none
backgroundImageLeftOpacityThe alpha/opacity value of the left background image.0.5
backgroundImageLeftStretchWhether the left background image is stretched across the whole chart (except the margins).true
backgroundImageLeftXIf you're not using the stretch option you can specify the X coordinate of the left background image.null
backgroundImageLeftYIf you're not using the stretch option you can specify the Y coordinate of the left background image.null
backgroundImageLeftWIf you're not using the stretch option you can specify the width of the left background image.null
backgroundImageLeftHIf you're not using the stretch option you can specify the height of the left background image.null
backgroundImageRightA URL of an image to render to the right background.null
backgroundImageRightAspectThe aspect ration setting of the right SVG image tag, eg it could be XMinYMin meet.none
backgroundImageRightOpacityThe alpha/opacity value of the right background image.0.5
backgroundImageRightStretchWhether the right background image is stretched across the whole chart (except the margins).true
backgroundImageRightXIf you're not using the stretch option you can specify the X coordinate of the right background image.null
backgroundImageRightYIf you're not using the stretch option you can specify the Y coordinate of the right background image.null
backgroundImageRightWIf you're not using the stretch option you can specify the width of the right background image.null
backgroundImageRightHIf you're not using the stretch option you can specify the height of the right background image.null
backgroundGridWhether to show the background grid or not.true
backgroundGridColorThe color of the background grid.#ddd
backgroundGridLinewidthThe linewidth that the background grid lines are. Decimals (eg 0.5) are permitted.1
backgroundGridBorderDetermines whether a border line is drawn around the grid.true
backgroundGridHlinesDetermines whether to draw the horizontal grid lines.true
backgroundGridHlinesCountDetermines how many horizontal grid lines you have. The default is linked to how many scale labels that you have.null
backgroundGridVlinesDetermines whether to draw the vertical grid lines.true
backgroundGridVlinesCountDetermines how many vertical grid lines you have. The default is to be linked to how many scale labels that you have.null
backgroundGridDashedYou can specify a dashed background grid by setting this to true. This option takes precedence over the dotted variant.false
backgroundGridDottedYou can specify a dotted background grid by setting this to true.false
backgroundGridDashArrayWith this option you can specify exactly what the array used for the linedash setting should be. It should be an array consisting of two numbers.null
backgroundColor
The color of the background.
Default: null

backgroundImageLeft
A URL of an image to render to the left background.
Default: null

backgroundImageLeftAspect
The aspect ratio setting of the left SVG image tag, eg it could be XMinYMin meet.
Default: none

backgroundImageLeftOpacity
The alpha/opacity value of the left background image.
Default: 0.5

backgroundImageLeftStretch
Whether the left background image is stretched across the whole chart (except the margins).
Default: true

backgroundImageLeftX
If you're not using the stretch option you can specify the X coordinate of the left background image.
Default: null

backgroundImageLeftY
If you're not using the stretch option you can specify the Y coordinate of the left background image.
Default: null

backgroundImageLeftW
If you're not using the stretch option you can specify the width of the left background image.
Default: null

backgroundImageLeftH
If you're not using the stretch option you can specify the height of the left background image.
Default: null

backgroundImageRight
A URL of an image to render to the right background.
Default: null

backgroundImageRightAspect
The aspect ration setting of the right SVG image tag, eg it could be XMinYMin meet.
Default: none

backgroundImageRightOpacity
The alpha/opacity value of the right background image.
Default: 0.5

backgroundImageRightStretch
Whether the right background image is stretched across the whole chart (except the margins).
Default: true

backgroundImageRightX
If you're not using the stretch option you can specify the X coordinate of the right background image.
Default: null

backgroundImageRightY
If you're not using the stretch option you can specify the Y coordinate of the right background image.
Default: null

backgroundImageRightW
If you're not using the stretch option you can specify the width of the right background image.
Default: null

backgroundImageRightH
If you're not using the stretch option you can specify the height of the right background image.
Default: null

backgroundGrid
Whether to show the background grid or not.
Default: true

backgroundGridColor
The color of the background grid.
Default: #ddd

backgroundGridLinewidth
The linewidth that the background grid lines are. Decimals (eg 0.5) are permitted.
Default: 1

backgroundGridBorder
Determines whether a border line is drawn around the grid.
Default: true

backgroundGridHlines
Determines whether to draw the horizontal grid lines.
Default: true

backgroundGridHlinesCount
Determines how many horizontal grid lines you have. The default is linked to how many scale labels that you have.
Default: null

backgroundGridVlines
Determines whether to draw the vertical grid lines.
Default: true

backgroundGridVlinesCount
Determines how many vertical grid lines you have. The default is to be linked to how many scale labels that you have.
Default: null

backgroundGridDashed
You can specify a dashed background grid by setting this to true. This option takes precedence over the dotted variant.
Default: false

backgroundGridDotted
You can specify a dotted background grid by setting this to true.
Default: false

backgroundGridDashArray
With this option you can specify exactly what the array used for the linedash setting should be. It should be an array consisting of two numbers.
Default: null

Margin properties

PropertyDescriptionDefault
marginLeftThe left margin of the chart, (the margin is where the labels and title are)).35
marginRightThe right margin of the chart, (the margin is where the labels and title are).35
marginTopThe top margin of the chart, (the margin is where the labels and title are).35
marginBottomThe bottom margin of the chart, (the margin is where the labels and title are).35
marginCenterThis is the center bit of the chart where the labels sit. By default it's automatically calculated for you but you can set it to a number if you wish.null
marginInnerThis is the margin between bars (or groups of bars on a grouped chart.3
marginInnerGroupedOn a grouped Bipolar chart this is the margin between bars within each group.2
marginLeft
The left margin of the chart, (the margin is where the labels and title are)).
Default: 35

marginRight
The right margin of the chart, (the margin is where the labels and title are).
Default: 35

marginTop
The top margin of the chart, (the margin is where the labels and title are).
Default: 35

marginBottom
The bottom margin of the chart, (the margin is where the labels and title are).
Default: 35

marginCenter
This is the center bit of the chart where the labels sit. By default it's automatically calculated for you but you can set it to a number if you wish.
Default: null

marginInner
This is the margin between bars (or groups of bars on a grouped chart.
Default: 3

marginInnerGrouped
On a grouped Bipolar chart this is the margin between bars within each group.
Default: 2

Color properties

PropertyDescriptionDefault
colorsAn array of the colors of the bars.An array - ['rgb(0,0,255)', '#0f0', '#00f', '#ff0', '#0ff', '#0f0']
colorsSequentialIf true, for regular bar charts, (not stacked or grouped), the colors that you specify will be used in a sequential fashion.false
colorsStrokeThe color of the outline of the bars.rgba(0,0,0,0)
colors
An array of the colors of the bars.
Default: An array - ['rgb(0,0,255)', '#0f0', '#00f', '#ff0', '#0ff', '#0f0']

colorsSequential
If true, for regular bar charts, (not stacked or grouped), the colors that you specify will be used in a sequential fashion.
Default: false

colorsStroke
The color of the outline of the bars.
Default: rgba(0,0,0,0)

X axis properties

PropertyDescriptionDefault
xaxisWhether the X axis is shown or not.true
xaxisLinewidthThe linewidth that's used to draw the X axis.1
xaxisTickmarksWhether the X axis has tickmarks or not.true
xaxisTickmarksLengthThe size of the X axis tickmarks.3
xaxisLabelsOffsetxThe X pixel offset that's added to the X axis labels.0
xaxisLabelsOffsetyThe Y pixel offset that's added to the X axis labels.0
xaxisLabelsCountThe number of X axis labels.5
xaxisLabelsPositionEdgeTickmarksCountNot something you'll use often, if at all. Determines how many tickmarks there are.null
xaxisScaleUnitsPreUnits that are prepended to the scale numbers. (An empty string
xaxisScaleUnitsPostUnits that are appended to the scale numbers.(An empty string
xaxisScaleDecimalsThe number of decimals that the scale will show.0
xaxisScalePointThe character(s) used as the decimal point..
xaxisScaleThousandThe character(s) used as the thousand separator.,
xaxisScaleRoundIf set to true the max scale value will be rounded up.false
xaxisScaleMaxThe maximum scale value.null
xaxisLabelsColorThe color of the X axis text.null
xaxisLabelsBoldWhether the X axis text is bold or not.null
xaxisLabelsItalicWhether the X axis text is italic or not.null
xaxisLabelsFontThe font of the X axis text.null
xaxisLabelsSizeThe size of the X axis text.null
xaxis
Whether the X axis is shown or not.
Default: true

xaxisLinewidth
The linewidth that's used to draw the X axis.
Default: 1

xaxisTickmarks
Whether the X axis has tickmarks or not.
Default: true

xaxisTickmarksLength
The size of the X axis tickmarks.
Default: 3

xaxisLabelsOffsetx
The X pixel offset that's added to the X axis labels.
Default: 0

xaxisLabelsOffsety
The Y pixel offset that's added to the X axis labels.
Default: 0

xaxisLabelsCount
The number of X axis labels.
Default: 5

xaxisLabelsPositionEdgeTickmarksCount
Not something you'll use often, if at all. Determines how many tickmarks there are.
Default: null

xaxisScaleUnitsPre
Units that are prepended to the scale numbers.
Default: (An empty string

xaxisScaleUnitsPost
Units that are appended to the scale numbers.
Default: (An empty string

xaxisScaleDecimals
The number of decimals that the scale will show.
Default: 0

xaxisScalePoint
The character(s) used as the decimal point.
Default: .

xaxisScaleThousand
The character(s) used as the thousand separator.
Default: ,

xaxisScaleRound
If set to true the max scale value will be rounded up.
Default: false

xaxisScaleMax
The maximum scale value.
Default: null

xaxisLabelsColor
The color of the X axis text.
Default: null

xaxisLabelsBold
Whether the X axis text is bold or not.
Default: null

xaxisLabelsItalic
Whether the X axis text is italic or not.
Default: null

xaxisLabelsFont
The font of the X axis text.
Default: null

xaxisLabelsSize
The size of the X axis text.
Default: null

Y axis properties

PropertyDescriptionDefault
yaxisWhether the Y axis is shown or not.true
yaxisLinewidthThe linewidth that's used to draw the Y axis.1
yaxisTickmarksWhether the Y axis has tickmarks or not.true
yaxisTickmarksLengthThe size of the Y axis tickmarks.3
yaxisLabelsThe labels for the Y axis.null
yaxisLabelsOffsetxThe X pixel offset that's added to the Y axis labels.0
yaxisLabelsOffsetyThe Y pixel offset that's added to the Y axis labels.0
yaxisColorThe color of the Y axis.black
yaxisLabelsColorThe color of the Y axis text.null
yaxisLabelsBoldWhether the Y axis text is bold or not.null
yaxisLabelsItalicWhether the Y axis text is italic or not.null
yaxisLabelsFontThe font of the Y axis text.null
yaxisLabelsSizeThe size of the Y axis text.null
yaxis
Whether the Y axis is shown or not.
Default: true

yaxisLinewidth
The linewidth that's used to draw the Y axis.
Default: 1

yaxisTickmarks
Whether the Y axis has tickmarks or not.
Default: true

yaxisTickmarksLength
The size of the Y axis tickmarks.
Default: 3

yaxisLabels
The labels for the Y axis.
Default: null

yaxisLabelsOffsetx
The X pixel offset that's added to the Y axis labels.
Default: 0

yaxisLabelsOffsety
The Y pixel offset that's added to the Y axis labels.
Default: 0

yaxisColor
The color of the Y axis.
Default: black

yaxisLabelsColor
The color of the Y axis text.
Default: null

yaxisLabelsBold
Whether the Y axis text is bold or not.
Default: null

yaxisLabelsItalic
Whether the Y axis text is italic or not.
Default: null

yaxisLabelsFont
The font of the Y axis text.
Default: null

yaxisLabelsSize
The size of the Y axis text.
Default: null

Other label properties

PropertyDescriptionDefault
textColorThe color of the text.black
textFontThe font used for text.Arial, Verdana, sans-serif
textSizeThe size of the text.12
textBoldWhether the text is bold or not.false
textItalicWhether the text is italic or not.false
labelsAboveWhether to show the labelsAbove style labels.false
labelsAbovePointThe decimal point character to use for the labelsAbove labels.null
labelsAboveThousandThe thousand separator character to use for the labelsAbove labels.null
labelsAboveDecimalsThe number of decimals to use for the labelsAbove labels.0
labelsAbovePreA string to prepend to the labelsAbove labels.null
labelsAbovePostA string to append to the labelsAbove labels.null
labelsAboveFormatterA function that handles ALL of the formatting of the number. The function is passed two arguments - the object and the unformatted number.null
labelsAboveOffsetxThe horizontal offset of the labelsAbove labels.0
labelsAboveOffsetyThe vertical offset of the labelsAbove labels.0
labelsAboveFontThe font of the labelsAbove labels.null
labelsAboveSizeThe size of the labelsAbove labels.null
labelsAboveBoldWhether the labelsAbove labels are bold or not.null
labelsAboveItalicWhether the labelsAbove labels are italic or not.null
labelsAboveColorThe color of the labelsAbove labels.null
labelsAboveBackgroundThe background color of the labelsAbove labels.null
labelsAboveBackgroundPaddingThe padding of the labelsAbove labels.0
labelsAboveSpecificThis property allows you to make the labelsAbove labels specific strings.null
textColor
The color of the text.
Default: black

textFont
The font used for text.
Default: Arial, Verdana, sans-serif

textSize
The size of the text.
Default: 12

textBold
Whether the text is bold or not.
Default: false

textItalic
Whether the text is italic or not.
Default: false

labelsAbove
Whether to show the labelsAbove style labels.
Default: false

labelsAbovePoint
The decimal point character to use for the labelsAbove labels.
Default: null

labelsAboveThousand
The thousand separator character to use for the labelsAbove labels.
Default: null

labelsAboveDecimals
The number of decimals to use for the labelsAbove labels.
Default: 0

labelsAbovePre
A string to prepend to the labelsAbove labels.
Default: null

labelsAbovePost
A string to append to the labelsAbove labels.
Default: null

labelsAboveFormatter
A function that handles ALL of the formatting of the number. The function is passed two arguments - the object and the unformatted number.
Default: null

labelsAboveOffsetx
The horizontal offset of the labelsAbove labels.
Default: 0

labelsAboveOffsety
The vertical offset of the labelsAbove labels.
Default: 0

labelsAboveFont
The font of the labelsAbove labels.
Default: null

labelsAboveSize
The size of the labelsAbove labels.
Default: null

labelsAboveBold
Whether the labelsAbove labels are bold or not.
Default: null

labelsAboveItalic
Whether the labelsAbove labels are italic or not.
Default: null

labelsAboveColor
The color of the labelsAbove labels.
Default: null

labelsAboveBackground
The background color of the labelsAbove labels.
Default: null

labelsAboveBackgroundPadding
The padding of the labelsAbove labels.
Default: 0

labelsAboveSpecific
This property allows you to make the labelsAbove labels specific strings.
Default: null

Key properties

PropertyDescriptionDefault
keyAn array of the labels that appear on the key.null
keyColorsAn array of colors to be shown on the key. If not specified then the colors option will be used instead.null
keyLabelsColorThe color of the text in the key.null
keyLabelsBoldWhether the key text is bold or not.null
keyLabelsFontThe font to use for the key text. If not specified it defaults to the textFont setting.null
keyLabelsSizeThe size to use for the key text. If not specified then the textSize is used.null
ketLabelsItalicWhether the key text is italic or not.null
keyLabelsOffsetxThe horizontal pixel offset of the key text (just the text).0
keyLabelsOffsetyThe vertical pixel offset of the key text (just the text).-1
keyOffsetxThe horizontal pixel offset of the entire key.0
keyOffsetyThe horizontal pixel offset of the entire key.0
keyColorShapeThis controls which shape should be displayed on the key. It can be a string or an array of strings. The possible options are: rect, circle, triangle, line, dot, rectdotrect
key
An array of the labels that appear on the key.
Default: null

keyColors
An array of colors to be shown on the key. If not specified then the colors option will be used instead.
Default: null

keyLabelsColor
The color of the text in the key.
Default: null

keyLabelsBold
Whether the key text is bold or not.
Default: null

keyLabelsFont
The font to use for the key text. If not specified it defaults to the textFont setting.
Default: null

keyLabelsSize
The size to use for the key text. If not specified then the textSize is used.
Default: null

ketLabelsItalic
Whether the key text is italic or not.
Default: null

keyLabelsOffsetx
The horizontal pixel offset of the key text (just the text).
Default: 0

keyLabelsOffsety
The vertical pixel offset of the key text (just the text).
Default: -1

keyOffsetx
The horizontal pixel offset of the entire key.
Default: 0

keyOffsety
The horizontal pixel offset of the entire key.
Default: 0

keyColorShape
This controls which shape should be displayed on the key. It can be a string or an array of strings. The possible options are: rect, circle, triangle, line, dot, rectdot
Default: rect

Tooltip properties

PropertyDescriptionDefault
tooltipsAn array of tooltips for the chart. This array should NOT be multidimensional - even for stacked or grouped charts.null
tooltipsOverrideIf required, this can be a function that totally handles the tooltip showing instead of the default RGraph tooltips. It should look like this:
tooltipsOverride: function (obj, opt)
{
    // Show tooltip
}
The opt is an argument that contains these items:
  • object The chart object.
  • index The index of the element (that triggered the tooltip).
  • sequentialIndex The sequential index of the element that was clicked.
  • text The text to be used as the tooltip. Remember that this may contain HTML (or whatever else you may have specified).
  • event The event object (either a click or mousemove event).
null
tooltipsCssClassThe CSS class that's applied to the tooltip DIV.RGraph_tooltip
tooltipsEventThe event used for tooltips (either click or mousemove.click
highlightStrokeThe stroke color that's used when highlighting the chart.rgba(0,0,0,0)
highlightFillThe fill color that's used when highlighting the chart.rgba(255,255,255,0.7)
highlightLinewidthThe linewidth that's used when highlighting the chart.1
tooltips
An array of tooltips for the chart. This array should NOT be multidimensional - even for stacked or grouped charts.
Default: null

tooltipsOverride
If required, this can be a function that totally handles the tooltip showing instead of the default RGraph tooltips. It should look like this:
tooltipsOverride: function (obj, opt)
{
    // Show tooltip
}
The opt is an argument that contains these items:
Default: null

tooltipsCssClass
The CSS class that's applied to the tooltip DIV.
Default: RGraph_tooltip

tooltipsEvent
The event used for tooltips (either click or mousemove.
Default: click

highlightStroke
The stroke color that's used when highlighting the chart.
Default: rgba(0,0,0,0)

highlightFill
The fill color that's used when highlighting the chart.
Default: rgba(255,255,255,0.7)

highlightLinewidth
The linewidth that's used when highlighting the chart.
Default: 1

Shadow properties

PropertyDescriptionDefault
shadowWhether a drop shadow is applied to the lines.false
shadowOffsetxThe horizontal offset of the shadow.2
shadowOffsetyThe vertical offset of the shadow.2
shadowBlurThe extent of the blurring effect that's applied to the shadow.2
shadow
Whether a drop shadow is applied to the lines.
Default: false

shadowOffsetx
The horizontal offset of the shadow.
Default: 2

shadowOffsety
The vertical offset of the shadow.
Default: 2

shadowBlur
The extent of the blurring effect that's applied to the shadow.
Default: 2

Title properties

PropertyDescriptionDefault
titleThe title of the chart.(An empty string)
titleXThe specific X coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.null
titleYThe specific Y coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.null
titleHalignThe horizontal alignment of the title.center
titleColorThe color of the title.null
titleFontThe font used to render the title.null
titleSizeThe size of the font used to render the title.null
titleBoldWhether the title is bold or not.null
titleItalicWhether the title is italic or not.null
titleSubtitleThe subtitle of the chart. If a subtitle is specified the title is moved up to accommodate it. As such you might need to give a larger marginTop value.(An empty string)
titleSubtitleColorThe color of the subtitle.#aaa
titleSubtitleFontThe font used to render the subtitle.null
titleSubtitleSizeThe size of the font used to render the subtitle.null
titleSubtitleBoldWhether the subtitle is bold or not.null
titleSubtitleItalicWhether the subtitle is italic or not.null
title
The title of the chart.
Default: (An empty string)

titleX
The specific X coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.
Default: null

titleY
The specific Y coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.
Default: null

titleHalign
The horizontal alignment of the title.
Default: center

titleColor
The color of the title.
Default: null

titleFont
The font used to render the title.
Default: null

titleSize
The size of the font used to render the title.
Default: null

titleBold
Whether the title is bold or not.
Default: null

titleItalic
Whether the title is italic or not.
Default: null

titleSubtitle
The subtitle of the chart. If a subtitle is specified the title is moved up to accommodate it. As such you might need to give a larger marginTop value.
Default: (An empty string)

titleSubtitleColor
The color of the subtitle.
Default: #aaa

titleSubtitleFont
The font used to render the subtitle.
Default: null

titleSubtitleSize
The size of the font used to render the subtitle.
Default: null

titleSubtitleBold
Whether the subtitle is bold or not.
Default: null

titleSubtitleItalic
Whether the subtitle is italic or not.
Default: null

Other properties

PropertyDescriptionDefault
linewidthThe linewidth (around the bars) used. Remember to set the colorsStroke setting to something other than transparent (the default).1
groupingWhether to show a grouped or stacked Bar chart. It can be stacked or grouped.grouped
linewidth
The linewidth (around the bars) used. Remember to set the colorsStroke setting to something other than transparent (the default).
Default: 1

grouping
Whether to show a grouped or stacked Bar chart. It can be stacked or grouped.
Default: grouped

 

Methods

 

obj.get(name)

This can be used to get properties if necessary. It's normally used after the chart is drawn if you need to get parameters (if you're doing custom coding for example).

 

obj.set(name, value)

This can be used to set properties if necessary. It's normally used after the chart is drawn if you need to set additional parameters or change them.

 

obj.getWidth(value)

This returns the width that represents the given value. It does not give you a start or end point - just the width.

 

obj.getLeftXCoord(value)

This returns the left hand side X coordinate for a given value. The left axis X coordinate can be retrieved by doing this:

<script>
    x0 = obj.get('marginLeft') + obj.graphWidth;
</script>

 

obj.getRightXCoord(value)

This returns the right hand side X coordinate for a given value. The right axis X coordinate can be retrieved by doing this:

<script>
    x0 = obj.get('marginLeft') + obj.graphWidth + obj.get('marginCenter');
</script>

 

obj.on(event, handler)

This function adds an event listener (such as beforedraw or draw) to the chart object. For example:

obj.on('draw', function (obj)
{
    // Put your code here
});

 

obj.exec(func)

This function can be used to execute a function (immediately). It's not event based (ie it doesn't run when something happens) - it just runs immediately - and only once. You might use it when you need to get something from the chart when it's drawn and then call the redraw function. Because this function only runs once the RGraph.SVG.redraw() function would not cause a loop - which would happen if you used the draw event.

obj.exec(function (obj)
{
    // Put your code here
});

Data properties that are used on the bars

The SVG <rect> elements that represent the bars on the Bipolar chart have various data attributes added to them that hold various bits of information. These are:

These can be retrieved by using standard DOM methods:

obj.coords[0].element.getAttribute('data-sequential-index');

 

Animation Effects

These effects are available and can be used instead of the draw() function.
<script>
    /**
    * Optional callback function that's called when the effect is complete
    */
    function myCallback (obj)
    {
        // ...
    }

    obj = new RGraph.SVG.Bipolar({
        id: 'chart-container',
        left:  [4,8,6,3,6,9,8],
        right: [4,5,3,5,6,1,2],
        options: {
        }
    }).grow({frames: 60, callback: myCallback});
</script>