SVG Waterfall charts API reference

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

 

Example

<script>
    var data = [59,15,-50,-4,-8,null,15,-4];
    
    new RGraph.SVG.Waterfall({
        id: 'chart-container',
        data: data,
        options: {
            xaxisLabels: ['Monday','Tuesday','Wednesday','Thursday','Friday','Weekday total','Saturday','Sunday','Total'],
            tooltips: ['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday','Total'],
            colors: [
                'Gradient(black:#ddd)',
                'Gradient(red:#d00)',
                'Gradient(blue:#00d)'],
            backgroundGridVlines: false,
            backgroundGridBorder: false,
            xaxis: false,
            yaxis: false,
            yaxisMax: 100
        }
    }).draw();

    RGraph.SVG.tooltips.style.backgroundColor = 'black';
    RGraph.SVG.tooltips.style.color           = 'white';
    RGraph.SVG.tooltips.style.fontWeight      = 'bold';
</script>

The code above produces a chart like this:

 

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

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 either side of the bars.5

Colors

PropertyDescriptionDefault
colorsAn array of the colors of the bars.An array - ['red', '#0f0', '#00f', '#ff0', '#0ff', '#0f0','pink','orange','gray','black','red', '#0f0', '#00f', '#ff0', '#0ff', '#0f0','pink','orange','gray','black']
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.#aaa
strokestyleConnectorThe color of the connectors between the bars. By default the strokestyle color is used.null

X axis

PropertyDescriptionDefault
xaxisWhether the X axis is shown or not.true
xaxisTickmarksWhether the X axis has tickmarks or not.true
xaxisTickmarksLengthThe size of the X axis tickmarks5
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

Y axis

PropertyDescriptionDefault
yaxisWhether the Y axis is shown or not.true
yaxisColorThe color of the Y axis.black
yaxisTickmarksWhether the Y axis has tickmarks or not.true
yaxisTickmarksLengthThe size of the Y axis tickmarks5
yaxisScaleWhether the the Y axis scale is shown.true
yaxisLabelsOffsetxThe X pixel offset thats added to the Y axis labels.0
yaxisLabelsOffsetyThe Y pixel offset thats added to the Y axis labels.0
yaxisLabelsCountThe number of Y labels.5
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

Text

PropertyDescriptionDefault
textColorThe color of the text.black
textFontThe font used for text.sans-serif
textSizeThe size of the text.12
textBoldWhether the text is bold or not.false
textItalicWhether the text is italic or not.false

Other labels

PropertyDescriptionDefault
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.left
labelsAboveValignThe vertical alignment of the labelsAbove.center
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

Title

PropertyDescriptionDefault
titleThe title of the chart.(An empty string)
titleXThe specific X coordinate of the title.null
titleYThe specific Y coordinate of the title.null
titleHalignThe horizontal alignment of the title.center
titleValignThe vertical alignment of the title.bottom
titleColorThe color of the title.black
titleFontThe font used to render the title.null
titleSizeThe size of the font used to render the title.16
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.null
titleSubtitleYThe specific Y coordinate of the subtitle.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.10
titleBoldWhether the subtitle is bold or not.false
titleSubtitleItalicWhether the subtitle is italic or not.false

Attribution

PropertyDescriptionDefault
attributionWhether to show the attribution link or not. If you're going to link to the RGraph website elsewhere on your site then set this to false.true
attributionXThe X coordinate of the link. This can be a number (in which case it's treated as the absolute coordinate) or it can be a string starting with a + or - (in which case it's treated as an adjustment to the default value).(bottom right corner of the SVG tag)
attributionYThe Y coordinate of the link. This can be a number (in which case it's treated as the absolute coordinate) or it can be a string starting with a + or - (in which case it's treated as an adjustment to the default value).(bottom right corner of the SVG tag)
attributionHrefThe href of the link (ie the page to link to).http://www.rgraph.net/svg/index.html
attributionHalignThe horizontal alignment of the link.right
attributionValignThe vertical alignment of the linkbottom
attributionFontThe font used to render the link.sans-serif
attributionSizeThe point size of the link.7
attributionColorThe color of the link.gray
attributionItalicWhether the link is italic or not.false
attributionBoldWhether the link is bold or not.false

Other

PropertyDescriptionDefault
linewidthThe line width (around the bars) used.1
totalWhether to show the total at the end or not.true

 

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 X 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)

RGraph on social media