The width that the background grid lines are. Decimals (eg 0.5) are permitted.
Determines whether a border line is drawn around the grid.
Determines whether to draw the horizontal grid lines.
Determines whether to draw the vertical grid lines.
Instead of specifying a pixel width/height for the background grid, you can use autofit and specify how many horizontal and vertical lines you want.
When using autofit this allows you to specify how many horizontal grid lines you want.
When using autofit this allows you to specify how many vertical grid lines you want.
If you want to have your grid lines line up with the labels (both X and Y axis), you can set this to true and RGraph will attempt to make the grid lines line up. If you have a hmargin set then the alignment will be thrown out.
If you want to have your background grid dashed then set this to true.
If you want to have your background grid dotted then set this to true. This takes precedence over dashed lines.
An array of information stipulating horizontal coloured bars. You can use these to indicate limits. Eg: myBar.set('hbars', [[75, 10, 'yellow'], [85, 15, 'red']]); This would give you two bars, one red and a lower yellow bar. The units correspond to your scale, and are the starting point and the height.
If you want to specify a background image to use on your chart, specify it with this property.
If you want to specify a background image to use on your chart, specify it with this property.
The alignment of the background image. This is a string that can contain the words: top bottom left right.
If you want to you can specify the X coordinate of the image.
If you want to you can specify the Y coordinate of the image.
If you want to you can specify the width of the image.
If you want to you can specify the height of the image.
If you want to have a single background color for your chart you can use this. It doesn't cover the gutters. If you want that then you can simply apply a CSS background color to the canvas tag.
The color of the axis.
The linewidth of the axes.
Whether the axes are drawn
false (the axes ARE drawn)
Set this to true if you don't want a X axis.
Set this to true if you don't want a Y axis.
This determines where the X axis is positioned. If you wish to show negative values then you should set this to center OR you can now (Jul 2016) use an offset X axis by leaving this property at the default bottom and using the ymax and ymin properties.
The color of the outline of the bars.
An array of the colors of the actual bars.
['green', 'red', 'blue']
The horizontal margin (in pixels) of the chart.
The left gutter of the chart, (the gutter is where the labels and title are)).
The right gutter of the chart, (the gutter is where the labels and title are).
The top gutter of the chart, (the gutter is where the labels and title are).
The bottom gutter of the chart, (the gutter is where the labels and title are).
Labels and text
A new feature in 2016 that allows you to use DOM text in place of canvas text. It makes for much higher quality text that you can also select if desired (for copy/paste operations). It won't fit all situations and you can read more about the DOM text feature here. A good way to control borders/margins/padding etc is not to set them on the canvas but to wrap the canvas in a div and set them on that like this:
This can be visible or hidden and it controls whether the text is clipped to the edges of the canvas. It defaults to be visible and means you can set small gutters if you wish.
This controls whether the DOM text responds to mouse based events or not (it sets the pointer-events CSS property to none).
The color of the labels.
The size (in points) of the labels.
The angle of the horizontal text labels (at the bottom of the chart). This can be one of three values - 0, 45 or 90.
The font used to render the text.
An array of the labels to be used on the chart.
An empty array
The color of the labels
null (same as textColor)
Whether the labels are bold or not
This allows you finer grained control in the horizontal direction over the X label positioning if you need it.
This allows you finer grained control in the vertical direction over the X label positioning if you need it.
Can be true or false and determines whether the chart has Y axis labels.
This determines how many Y scale labels are shown.
This allows you finer grained control in the horizontal direction over the Y label positioning if you need it.
This allows you finer grained control in the vertical direction over the Y label positioning if you need it.
The number of Y tickmarks. If you have changed the number of Y labels, you may also want to change this to match.
The title of the chart, if any.
The font that the title is rendered in. If not specified the text.font setting is used (usually Arial)
The size of the title. If not specified the size is usually 2pt bigger than the text.size setting.
Whether the title is bold or not.
Whether the title is italic or not.
The background color (if any) for the title.
The color of the title.
To give the exact X coordinate for the title - use this
To give the exact Y coordinate for the title - use this
This allows to specify a title for the X axis.
This allows you to specify a size for the X axis title.
This allows to specify a font for the X axis title.
This controls whether the X axis title is bold or not.
This controls the color of the X axis title.
By giving this you can specifically set the X position of the X axis title
By giving this you can specifically set the Y position of the X axis title
By giving this you can specifically set the X position of the Y axis title
By giving this you can specifically set the Y position of the Y axis title
This allows to specify a title for the Y axis.
This allows you to specify a size for the Y axis title.
This allows to specify a font for the Y axis title.
This controls whether the Y axis title is bold or not.
This controls what color the Y axis is.
This is multiplied with the gutter to give the position of the X axis title.
This is multiplied with the gutter to give the position of the Y axis title.
Instead of using the option above you can instead use this option, specifying left or right.
Whether a drop shadow is applied.
The color of the shadow.
The X offset of the shadow.
The Y offset of the shadow.
The severity of the shadow blurring effect.
The number of decimal places to display for the Y scale.
The character used as the decimal point.
The character used as the thousand separator
To allow custom formats of numbers in the scale, you can use this option to specify a function that is used by RGraph to format numbers. This function should handle ALL of the formatting. Eg:
function myFormatter(obj, num)
return num + 'F'; // An example of formatting
Whether to start the scale at zero or not
The units that the Y axis is measured in. This string is displayed BEFORE the actual number, allowing you to specify values such as "$50".
The units that the Y axis is measured in. This string is displayed AFTER the actual number, allowing you to specify values such as "50ms".
The optional maximum Y scale value. If not specified then it will be calculated.
null (It's calculated)
This can be used when using an offset Y axis to specify the minimum value. Leave the xaxispos at the default bottom setting when you want an offset Y axis
An array of context menu items. More information on context menus is here.
 (An empty array)
A numerically indexed array of tooltips that are shown when a bar is clicked. These can contain HTML.
The effect used for showing tooltips. Can be either fade or none.
This is the event that triggers the tooltips. It can be either onclick or onmousemove.
This is the name of the CSS class the chart uses.
If you wish to handle showing tooltips yourself, this should be a function object which does just that. There's more information on the tooltips documentation page
Not an option that you'll need particularly often if at all. Setting this to true means that when you call the RGraph.clear() API function tooltip DO NOT get hidden.
If true, you will get a crosshair centering on the current mouse position.
This controls the linewidth of the crosshairs.
The color of the crosshairs.
This determines whether the horizontal crosshair is shown.
This determines whether the vertical crosshair is shown.
Whether annotations are enabled for the chart (ie you can draw on the chart interactively.
If you do not allow the use of the palette, then this will be the only colour allowed for annotations.
This is the line width of the annotations.
Defaulting to false, this determines whether your chart will be resizable. Because of the numerous event handlers this has to install code on, This feature is unlikely to work with other dynamic features (the context menu is fine however).
With this you can specify the background color for the resize handle. If you're adjusting the position of the handle then you may need this to make the handle stand out more.
This allows you to set a maximum width that the chart can be resized to.
This allows you to set a maximum height that the chart can be resized to.
This is the factor that the chart will be zoomed by (bigger values means more zoom)
Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.
Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.
The horizontal direction of the zoom. Possible values are: left, center, right
The vertical direction of the zoom. Possible values are: up, center, down
The delay (in milliseconds) between frames.
The number of frames in the zoom animation.
Whether or not the zoomed canvas has a shadow or not.
If you want to add your own onclick function you can do so by assigning it to this property. See here for details.
If you want to add your own onmousemove function you can do so by assigning it to this property. See here for details.
If you want to add your own onmouseover function you can do so by assigning it to this property. See here for details.
If you want to add your own onmouseout function you can do so by assigning it to this property. See here for details.
By default this is null but you can set it to a function if you wish so that function is called to do the chart highlighting. Its passed the shape object as an argument.
If you use tooltips, this controls the colour of the highlight stroke.
If you use tooltips, this controls the colour of the highlight fill.
The color of the axis.
This is used in animations and effects as the default color to use when clearing the canvas.
An accessor that you can use to retrieve the value of properties.
An accessor that you can use to set the value of properties.
This method returns details of the focused bar (if any). It provides:
The chart object
The X coordinate
The Y coordinate
The width of the bar
The height of the bar
The index of the pertinent bar (starting from zero).
The shape also includes textual indexes like this: shape['object'] And they are:
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.
This method can be used to set an event listener on an object. It operates in a similar way to the jQuery .on() function -
the first argument is the event you wish to attach to and the second is the handler function. For example:
.on('draw', function (obj)
// Put event code here
The function is useful if you use method chaining when creating your charts:
var obj = new RGraph.Waterfall('cvs', [5,8,6,4,3,5])
.on('mousemove', function (e, shape)
e.target.style.cursor = 'pointer';
.on('click', function (e, shape)
// Handle click event