SVG Waterfall chart API reference

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

 

Example

The code below produces a chart like this:

<script>
    data = [59,15,-50,-4,-8,null,15,-4];
    
    new RGraph.SVG.Waterfall({
        id: 'chart-container',
        data: data,
        options: {
            xaxisLabels: ['Monday','\r\nTuesday','Wednesday','\r\nThursday','Friday','\r\nWeekday total','Saturday','\r\nSunday','Total'],
            xaxisColor: 'gray',
            yaxis: false,
            labelsAbove: true,
            labelsAboveUnitsPost: '%',
            labelsAboveLastBold: true,
            tooltips: ['Monday','Tuesday','Wednesday','Thursday','Friday','Weekday total','Saturday','Sunday','Total'],
            colors: [
                'Gradient(black:#ddd)',
                'Gradient(red:#d00)',
                'Gradient(blue:#00d)'],
            //backgroundGridVlines: false,
            backgroundGridBorder: false,
            yaxisScaleMax: 100,
            marginBottom: 45,
            marginInner: 10,
            labelsAboveSize: 12,
            textSize: 12
        }
    }).draw();

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

 

The coordinates properties

The coordinates of the bars on the Waterfall chart are held in the obj.coords array. Each element in the array is an object that consists of these properties:

So you could, for example, use this to get the width of the first bar on the chart:

obj.coords[0].width

 

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 shown above.

Background properties

PropertyDescriptionDefault
backgroundColorThe color of the background.null
backgroundImageA URL of an image to render to the background.null
backgroundImageAspectThe aspect ratio setting of the SVG image tag, eg it could be XMinYMin meet.none
backgroundImageOpacityThe alpha/opacity value of the background image.0.5
backgroundImageStretchWhether the background image is stretched across the whole chart (except the margins).true
backgroundImageXIf you're not using the backgroundImageStretch option you can specify the X coordinate of the image.null
backgroundImageXIf you're not using the backgroundImageStretch option you can specify the Y coordinate of the image.null
backgroundImageWIf you're not using the backgroundImageStretch option you can specify the width of the image.null
backgroundImageHIf you're not using the backgroundImageStretch 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
backgroundColor
The color of the background.
Default: null

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

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

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

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

backgroundImageX
If you're not using the backgroundImageStretch option you can specify the X coordinate of the image.
Default: null

backgroundImageX
If you're not using the backgroundImageStretch option you can specify the Y coordinate of the image.
Default: null

backgroundImageW
If you're not using the backgroundImageStretch option you can specify the width of the image.
Default: null

backgroundImageH
If you're not using the backgroundImageStretch option you can specify the height of the 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
marginInnerThe horizontal margin (in pixels) of the chart. The horizontal margin is either side of the bars.5
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

marginInner
The horizontal margin (in pixels) of the chart. The horizontal margin is either side of the bars.
Default: 5

Color properties

PropertyDescriptionDefault
colorsAn array of the colors of the bars.You can specify four colors if you want and they are:
  1. The color used for positive bars (black).
  2. The color used for negative bars (red).
  3. The color used for total bars (blue).
  4. The color used for "mid-chart" total bars (blue, optional).
['black', 'red', 'blue']
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.#aaa
colorsConnectorThe color of the connectors between the bars. By default the colorsStroke color is used.null
colors
An array of the colors of the bars.You can specify four colors if you want and they are:
  1. The color used for positive bars (black).
  2. The color used for negative bars (red).
  3. The color used for total bars (blue).
  4. The color used for "mid-chart" total bars (blue, optional).

Default: ['black', 'red', 'blue']

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: #aaa

colorsConnector
The color of the connectors between the bars. By default the colorsStroke color is used.
Default: null

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.5
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
xaxisColorThe color of the X axis.black
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
xaxisLabelsAngleIf you have long labels you may want to set this to a number between 0 and 90 to enable angled labels.null
xaxisLabelsPositionSectionTickmarksCountNot something you'll use often, if at all. Determines how many tickmarks there are.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: 5

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

xaxisColor
The color of the X axis.
Default: black

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

xaxisLabelsAngle
If you have long labels you may want to set this to a number between 0 and 90 to enable angled labels.
Default: null

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

Y axis properties

PropertyDescriptionDefault
yaxisWhether the Y axis is shown or not.true
yaxisPositionThis controls whether the Y axis is positioned on the left or on the right.left
yaxisColorThe color of the Y axis.black
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.5
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 that's added to the Y axis labels.0
yaxisLabelsOffsetyThe Y pixel offset that's 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
yaxisScaleWhether the Y axis scale is shown.true
yaxisScaleUnitsPreUnits that are prepended to the scale numbers. (An empty string
yaxisScaleUnitsPostUnits that are appended to the scale numbers.(An empty string
yaxisScaleDecimalsThe number of decimals that the scale will show.0
yaxisScalePointThe character(s) used as the decimal point..
yaxisScaleThousandThe character(s) used as the thousand separator.,
yaxisScaleRoundIf set to true the max scale value will be rounded up.false
yaxisScaleMaxThe maximum scale value.null
yaxisScaleMinThe 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
yaxisScaleFormatterThis option should be a function. This function handles the entirety of the number formatting for the Y axis. Units are not added - decimals are not added - it's 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
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

yaxisPosition
This controls whether the Y axis is positioned on the left or on the right.
Default: left

yaxisColor
The color of the Y axis.
Default: black

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: 5

yaxisLabels
If the yaxisScale option is false then this can be used to give an array of labels that are shown on the Y axis instead.
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

yaxisLabelsHalign
The horizontal alignment of the labels.
Default: right

yaxisLabelsValign
The vertical alignment of the labels.
Default: center

yaxisLabelsCount
The number of Y labels.
Default: 5

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

yaxisScale
Whether the Y axis scale is shown.
Default: true

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

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

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

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

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

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

yaxisScaleMax
The maximum scale value.
Default: null

yaxisScaleMin
The 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.
Default: 0

yaxisScaleFormatter
This option should be a function. This function handles the entirety of the number formatting for the Y axis. Units are not added - decimals are not added - it's 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)
{
}

Default: null

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 text 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
labelsAboveHalignThe horizontal alignment of the labelsAbove.left
labelsAboveValignThe vertical alignment of the labelsAbove.center
labelsAboveSpecificThis property allows you to make the labelsAbove labels specific strings.null
labelsAboveLastFontThis allows you to specify the font for the last labelsAbove label.null
labelsAboveLastBoldThis allows you to specify whether the text is bold or not for the last labelsAbove label.null
labelsAboveLastItalicThis allows you to specify whether the text is italic or not for the last labelsAbove label.null
labelsAboveLastSizeThis allows you to specify the size for the last labelsAbove label.null
labelsAboveLastColorThis allows you to specify the color for the last labelsAbove label.null
labelsAboveLastBackgroundThis allows you to specify the background color for the last labelsAbove label.null
labelsAboveLastBackgroundPaddingThis allows you to specify the background padding for the last labelsAbove label.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

labelsAboveHalign
The horizontal alignment of the labelsAbove.
Default: left

labelsAboveValign
The vertical alignment of the labelsAbove.
Default: center

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

labelsAboveLastFont
This allows you to specify the font for the last labelsAbove label.
Default: null

labelsAboveLastBold
This allows you to specify whether the text is bold or not for the last labelsAbove label.
Default: null

labelsAboveLastItalic
This allows you to specify whether the text is italic or not for the last labelsAbove label.
Default: null

labelsAboveLastSize
This allows you to specify the size for the last labelsAbove label.
Default: null

labelsAboveLastColor
This allows you to specify the color for the last labelsAbove label.
Default: null

labelsAboveLastBackground
This allows you to specify the background color for the last labelsAbove label.
Default: null

labelsAboveLastBackgroundPadding
This allows you to specify the background padding for the last labelsAbove label.
Default: null

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 argument 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
tooltipsEventThe event used for tooltips (either click or mousemove.click
tooltipsFormattedPointWhen using formatted tooltip strings this is used as the point when using the %{value_formatted} option..
tooltipsFormattedThousandWhen using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.,
tooltipsFormattedDecimalsWhen using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option.0
tooltipsFormattedUnitsPreWhen using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.(an empty string)
tooltipsFormattedUnitsPostWhen using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.(an empty string)
tooltipsFormattedKeyLabelsThe labels that are used in the formatted tooltip key. These are (in order):
  1. Label for positive columns.
  2. Label for outgoing columns.
  3. Label for the total column.
  4. Labels for mid-data tital columns.
[] (an empty array)
tooltipsFormattedKeyColorsThe colors that are used in the formatted tooltip key. See the colors property for what colors you can specify.null
tooltipsFormattedKeyColorsShapeThis is the shape that's used in the tooltip key. It can be square or circlesquare
tooltipsCssIf you want to specify some CSS that gets applied to all of the tooltips, but don't want to use the RGraph.tooltips.style object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object CSS for the tooltips. These are CSS styles that get applied to all of the tooltips for the specific object only. It should look like this:
tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt',
    backgroundColor: 'black',
    color: 'white'
}
null
tooltipsCssClassThe CSS class that's applied to the tooltip DIV.RGraph_tooltip
tooltipsOffsetxThis property allows you to shift the tooltips left or right.0
tooltipsOffsetyThis property allows you to shift the tooltips up or down.0
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 argument contains these items:
Default: null

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

tooltipsFormattedPoint
When using formatted tooltip strings this is used as the point when using the %{value_formatted} option.
Default: .

tooltipsFormattedThousand
When using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.
Default: ,

tooltipsFormattedDecimals
When using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option.
Default: 0

tooltipsFormattedUnitsPre
When using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.
Default: (an empty string)

tooltipsFormattedUnitsPost
When using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.
Default: (an empty string)

tooltipsFormattedKeyLabels
The labels that are used in the formatted tooltip key. These are (in order):
  1. Label for positive columns.
  2. Label for outgoing columns.
  3. Label for the total column.
  4. Labels for mid-data tital columns.

Default: [] (an empty array)

tooltipsFormattedKeyColors
The colors that are used in the formatted tooltip key. See the colors property for what colors you can specify.
Default: null

tooltipsFormattedKeyColorsShape
This is the shape that's used in the tooltip key. It can be square or circle
Default: square

tooltipsCss
If you want to specify some CSS that gets applied to all of the tooltips, but don't want to use the RGraph.tooltips.style object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object CSS for the tooltips. These are CSS styles that get applied to all of the tooltips for the specific object only. It should look like this:
tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt',
    backgroundColor: 'black',
    color: 'white'
}

Default: null

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

tooltipsOffsetx
This property allows you to shift the tooltips left or right.
Default: 0

tooltipsOffsety
This property allows you to shift the tooltips up or down.
Default: 0

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
shadowOpacityThe opacity of the color that's used for the shadow.0.25
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

shadowOpacity
The opacity of the color that's used for the shadow.
Default: 0.25

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

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
titleOffsetxAn offset value which is added to the calculated X coordinate.0
titleOffsetyAn offset value which is added to the calculated Y coordinate.0
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. It defaults to be the same as the textSize setting.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

titleOffsetx
An offset value which is added to the calculated X coordinate.
Default: 0

titleOffsety
An offset value which is added to the calculated Y coordinate.
Default: 0

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. It defaults to be the same as the textSize setting.
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.1
totalWhether to show the total at the end or not.true
linewidth
The linewidth (around the bars) used.
Default: 1

total
Whether to show the total at the end or not.
Default: true

 

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.getYCoord(value)

This method can be used to get an appropriate Y coordinate 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 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 elements that represent the bars on the Waterfall 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-index');