SVG Bipolar charts API reference

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

The SVG Bipolar chart is not available as yet - it is coming in version 4.65

 

Example

The code below produces a chart like this: A preview of the new SVG Bipolar chart

<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 aubtitle for the chart that was generated on Sunday',
            titleSubtitleItalic: true,
            gutterTop: 50,
            colors: ['Gradient(#a00:#b00:#a00)'],
            yaxisLabels: ['Monday','Tuesday','Thursday','Friday','Saturday','Sunday'],
            yaxisTextSize: 16,
            yaxisTextBold: true,
            yaxisTextItalic: true,
            xaxis: false,
            yaxisColor: '#aaa'
        }
    }).grow();
</script>

 

The coordinates properties

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

  • obj.coords
    All of the coordinates - which are simply appended to this array as the bars are drawn. Each element of the array is an object which consists of x, y, width, height, element and object properties. The element property is the SVG rect element and the object property is the RGraph object.

  • obj.coordsLeft
    Similar to the obj.coords array but just for the left-hand side bars.

  • obj.coordsRight
    Similar to the obj.coords array but just for the right-hand side bars.

  • obj.coords2
    Again, this is all of the coordinates - but arranged slightly differently. This is only used by stacked and grouped charts - each element is an array of that groups/stacks segments. then each sub-element is an object which consists of x, y, width and height, element and object properties. The element property is the SVG rect element and the object property is the RGraph object.

  • obj.coords2Left
    Similar to the obj.coords2 array but just for the left-hand side bars.

  • obj.coords2Right
    Similar to the obj.coords2 array but just for the right-hand side bars.

 

Properties

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

Layout style:     
  

Background

PropertyDescriptionDefault
backgroundColorThe color of the background.null
backgroundImageLeftA URL of an image to render to the left backgroundnull
backgroundImageLeftAspectThe aspect ration setting of the left SVG image tag, eg it could be XMinYMin meetnone
backgroundImageLeftOpacityThe alpha/opacity value of the left background image.0.5
backgroundImageLeftStretchWhether the left background image is stretched across the whole chart (except the gutters).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 backgroundnull
backgroundImageRightAspectThe aspect ration setting of the right SVG image tag, eg it could be XMinYMin meetnone
backgroundImageRightOpacityThe alpha/opacity value of the right background image.0.5
backgroundImageRightStretchWhether the right background image is stretched across the whole chart (except the gutters).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

Margins

PropertyDescriptionDefault
gutterLeftThe left gutter of the chart, (the gutter is where the labels and title are)).35
gutterRightThe right gutter of the chart, (the gutter is where the labels and title are).35
gutterTopThe top gutter of the chart, (the gutter is where the labels and title are).35
gutterBottomThe bottom gutter of the chart, (the gutter is where the labels and title are).35
gutterCenterThis 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
vmarginThis is the margin between bars (or groups of bars on a grouped chart.3
vmarginGroupedOn a grouped Bipolar chart this is the margin between bars within each group.2

Colors

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
strokestyleThe color of the outline of the bars.rgba(0,0,0,0)

X axis

PropertyDescriptionDefault
xaxisWhether the X axis is shown or not.true
xaxisLinewidthThe linewidth thats used to draw the X axis.1
xaxisTickmarksWhether the X axis has tickmarks or not.true
xaxisTickmarksLengthThe size of the X axis tickmarks3
xaxisLabelsOffsetxThe X pixel offset thats added to the X axis labels.0
xaxisLabelsOffsetyThe Y pixel offset thats 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
xaxisUnitsPreUnits that are prepended to the scale numbers. (An empty string
xaxisUnitsPostUnits that are appended to the scale numbers.(An empty string
xaxisDecimalsThe number of decimals that the scale will show.0
xaxisPointThe character(s) used as the decimal point..
xaxisThousandThe character(s) used as the thousand seperator.,
xaxisRoundIf set to true the max scale value will be rounded up.false
xaxisMaxThe maximum scale value (you will need to set yaxisStrict to true if you want the maximum value to be exactly this value).null
xaxisMinThe minimum X value. As well as a numeric value you can also set this to mirror so that the X axis is put in the center.0
xaxisTextColorThe color of the X axis text (this overrides the textColor option)null
xaxisTextBoldWhether the X axis text is bold or not (this overrides the textColor option)null
xaxisTextItalicWhether the X axis text is italic or not (this overrides the textItalic option)null
xaxisTextFontThe font of the X axis text (this overrides the textFont option)null
xaxisTextSizeThe size of the X axis text (this overrides the textSize option)null

Y axis

PropertyDescriptionDefault
yaxisWhether the Y axis is shown or not.true
yaxisLinewidthThe linewidth thats used to draw the Y axis.1
yaxisTickmarksWhether the Y axis has tickmarks or not.true
yaxisTickmarksLengthThe size of the Y axis tickmarks3
yaxisLabelsThe labels for the Y axis.null
yaxisLabelsOffsetxThe X pixel offset thats added to the Y axis labels.0
yaxisLabelsOffsetyThe Y pixel offset thats added to the Y axis labels.0
yaxisColorThe color of the Y axis.black
yaxisTextColorThe color of the Y axis text (this overrides the textColor option)null
yaxisTextBoldWhether the Y axis text is bold or not (this overrides the textColor option)null
yaxisTextItalicWhether the Y axis text is italic or not (this overrides the textItalic option)null
yaxisTextFontThe font of the Y axis text (this overrides the textFont option)null
yaxisTextSizeThe size of the Y axis text (this overrides the textSize option)null
yaxisLabelsPositionSectionTickmarksCountNot something you'll use often, if at all. Determines how many tickmarks there are.null

Labels and text

PropertyDescriptionDefault
textColorThe color of the text.black
textFontThe font used for text.sans-serif
textSizeThe size of the text.12pt
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 seperator 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 to make the labelsAbove labels specific strings.null

Key

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
keyTextBoldWhether the key text is bold or not.false
keyTextFontThe font to use for the key text. If not specified it defaults to the textFont setting.null
keyTextSizeThe size to use for the key text. If not specified then the textSize is used.null
ketTextItalicWhether the key text is italic or not.false
keyTextOffsetxThe horizontal pixel offset of the key text (just the text).0
keyTextOffsetyThe 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, dotrect

Tooltips

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 thats 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

Shadow

PropertyDescriptionDefault
shadowWhether a drop shadow is applied to the lines.false
shadowOffsetxThe horizontal offset of the shadow2
shadowOffsetyThe vertical offset of the shadow2
shadowBlurThe extent of the blurring effect thats applied to the shadow2

Title

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
titleValignThe vertical alignment of the title.bottom
titleColorThe color of the title. It defaults to be the same as the textColor property.null
titleFontThe font used to render the title.null
titleSizeThe size of the font used to render the title. It defaults to be a little larger than the textSize propertynull
titleBoldWhether the title is bold or not.false
titleItalicWhether the title is italic or not.false
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 gutterTop value.(An empty string)
titleSubtitleXThe specific X coordinate of the subtitle. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.null
titleSubtitleYThe specific Y coordinate of the subtitle. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.null
titleSubtitleHalignThe horizontal alignment of the subtitle.center
titleSubtitleValignThe vertical alignment of the subtitle.top
titleSubtitleColorThe color of the subtitle.#aaa
titleSubtitleFontThe font used to render the subtitle.null
titleSubtitleSizeThe size of the font used to render the subtitle. It defaults to be the same as the textSize setting.null
titleBoldWhether the subtitle is bold or not.false
titleSubtitleItalicWhether the subtitle is italic or not.false

Other

PropertyDescriptionDefault
linewidthThe line width (around the bars) used. Remember to set the strokestyle to something other than transparent (the default).1
groupingWhether to show a grouped or stacked Bar chart. It can be stacked or grouped.grouped

 

Methods

 

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 coord can be retrieved by doing this:

<script>
    var x0 = obj.properties.gutterLeft + obj.graphWidth;
</script>

 

obj.getRightXCoord(value)

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

<script>
    var x0 = obj.properties.gutterLeft + obj.graphWidth + obj.properties.gutterCenter;
</script>

 

obj.on(event, func)

This function can be used to install an event listener for an RGraph event (eg ondraw).

 

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 some coordinate from when the chart is drawn and then call the redraw function. Because this function only runs once the redraw function would not cause a loop - which would happen if you used the ondraw event.

 

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)
    {
        // ...
    }

    var 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>