SVG Bar charts API reference

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

 

Example

The code above produces a chart like this:

<script>
    // Some data that is to be shown on the bar chart. To show a stacked or grouped chart
    // each number should be an array of further numbers instead (as below).
    var data = [280,45,133,152,278,221,56];
    
    // An example of the data used by stacked and grouped charts
    // var data = [[1,5,6], [4,5,3], [7,8,9], [4,7,7], [9,6,5], [5,2,3], [4,8,6]]

    var bar = new RGraph.SVG.Bar({
        id: 'chart-container',
        data: data,
        options: {
            xaxisLabels: ['Mon','Tues','Wed','Thur','Fri','Sat','Sun'],
            gutterLeft: 40
        }
    }).draw();
</script>

 

The coordinates properties

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

 

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
backgroundImageA URL of an image to render to the backgroundnull
backgroundImageAspectThe aspect ration setting of the SVG image tag, eg it could be XMinYMin meetnone
backgroundImageOpacityThe alpha/opacity value of the background image.0.5
backgroundImageStretchWhether the background image is stretched across the whole chart (except the gutters).true
backgroundImageXIf you're not using the stretch option you can specify the X coordinate of the image.null
backgroundImageYIf you're not using the stretch option you can specify the Y coordinate of the image.null
backgroundImageWIf you're not using the stretch option you can specify the width of the image.null
backgroundImageHIf you're not using the stretch option you can specify the height of the 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
hmarginThe horizontal margin (in pixels) of the chart. The horizontal margin is on the inside of the axes.3
hmarginGroupedOn a grouped bar chart this is the margin between bars that are in the same 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
xaxisLabelsThe labels for the X axis.null
xaxisLabelsOffsetxThe X pixel offset thats added to the X axis labels.0
xaxisLabelsOffsetyThe Y pixel offset thats added to the X axis labels.0
xaxisColorThe color of the X axis.black
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
xaxisLabelsPositionSectionTickmarksCountNot something you'll use often, if at all. Determines how many tickmarks there are.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
yaxisScaleWhether the the Y axis scale is shown.true
yaxisLabelsIf the yaxisScale option is false then this can be used to give an array of labels that are shown on the Y axis instead.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
yaxisLabelsHalignThe horizontal alignment of the labels.right
yaxisLabelsValignThe vertical alignment of the labels.center
yaxisLabelsCountThe number of Y labels.5
yaxisLabelsPositionEdgeTickmarksCountNot something you'll use often, if at all. Determines how many tickmarks there are.null
yaxisUnitsPreUnits that are prepended to the scale numbers. (An empty string
yaxisUnitsPostUnits that are appended to the scale numbers.(An empty string
yaxisDecimalsThe number of decimals that the scale will show.0
yaxisPointThe character(s) used as the decimal point..
yaxisThousandThe character(s) used as the thousand seperator.,
yaxisRoundIf set to true the max scale value will be rounded up.false
yaxisMaxThe maximum scale value (you will need to set yaxisStrict to true if you want the maximum value to be exactly this value).null
yaxisMinThe minimum Y 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
yaxisFormatterThis option should be a function. This function handles the entirety of the number formatting for the yaxis. Units are not added, decimals are not added - its all up to you. The function is passed two arguments - the chart object and the number. It should look like this:
yaxisFormatter: function (obj, num)
{
}
null
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

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
labelsAboveHalignThe horizontal alignment of the labelsAbove.center
labelsAboveValignThe vertical alignment of the labelsAbove.bottom
labelsAboveSpecificThis property allows to make the labelsAbove labels specific strings.null

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

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

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

Error bars

PropertyDescriptionDefault
errorbarsThis should be an array of either numbers or objects that represent the errorbars. If its an object you can specify information that's specific to the point. See the example to see an example.null
errorbarsColorThe default color of the errorbars. This can be overridden using the color setting if you give an object as the errorbar information.black
errorbarsLinewidthThe linewidth that is used to draw the errorbars. This can be overridden using the linewidth setting if you give an object as the errorbar information.1
errorbarsCapwidthThe width of the caps to the errorbars. This can be overridden using the capwidth setting if you give an object as the errorbar information.10

Other

PropertyDescriptionDefault
variantThis can be set to 3d and will give you a 3D effect (as seen on the RGraph homepage). The 3D effect does not support and X axis that isn't at the bottomnull
variant3dOffsetxThe horizontal offset used by the 3D effect.10
variant3dOffsetyThe vertical Offset used by the 3D effect.5
linewidthThe line width (around the bars) used.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.getYCoord(value)

This method can be used to get an appropriate Y coord for a value when you're doing custom drawing on the chart. It returns null if the value is out of range.

 

obj.on(event, handler)

This function adds an event listener (such as onbeforedraw or ondraw) to the chart object.

 

obj.exec(func)

This function simply executes the function that you give it (there and then - not on any particular 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.Bar({
        id: 'chart-container',
        data: [3,4,7,5,6,9,8],
        options: {
        }
    }).grow({frames: 60, callback: myCallback});
</script>