About
RGraph is a JavaScript charts library based on HTML5 SVG and canvas. RGraph is mature (over 15 years old) and has a wealth of features making it an ideal choice to show charts on your website.

More »

 

Download
Get the latest version of RGraph (version 6.17) from the download page. There's also older versions available, minified files and links to cdnjs.com hosted libraries.

More »

 

License
RGraph can be used for free under the GPL or if that doesn't suit your situation there's an inexpensive (£129) commercial license available.

More »

Line chart API reference

Example

<script>
    // Some data that is to be shown on the Bar chart. For multiple
    // lines it can also be an array of arrays
    // data = [280,45,133,152,278,221,56];
    
    // An example of the data used by multiple dataset Line charts
    data = [
        [1,9,8,4,6,5,3],
        [1,6,5,3,3,8,6]
    ];

    new RGraph.SVG.Line({
        id: 'chart-container',
        data: data,
        options: {
            backgroundGridVlines: false,
            backgroundGridBorder: false,
            xaxis: false,
            yaxis: false,
            xaxisLabels: ['Mon','Tue','Wed','Thu','Fri','Sat','Sun'],
            days: ['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'],
            tooltips: '<b>%{property:days[%{index}]}: %{value}%</b>',
            tooltipsCss: {
                backgroundColor: '#333',
                fontWeight: 'bold',
                fontSize: '14pt',
                opacity: 0.85
            },
            linewidth: 3,
            marginTop: 45,
            marginLeft: 25,
            spline: true,
            filled: true,
            filledOpacity: 0.5,
            filledAccumulative: true,
            linewidth: 0,
            title: 'A Line chart showing dual datasets',
            titleSubtitle: 'The datasets don\'t show anything particularly interesting'
        }
    }).draw();
</script>

Using errorbars on the Line chart

One of the features that the Line chart has is the ability to display errorbars. This is demonstrated by the chart that's shown here. The errorbars property should be an array of objects but each element can be the following:

An example of some code for a chart that has errorbars is shown below:

<script>
    new RGraph.SVG.Line({
        id: 'cc',
        data: [8,4,8,6,3,5,8],
        options: {
            marginLeft: 50,
            title: 'A Line chart with errorbars',
            textSize: 14,
            xaxisLabels: ['Mon','Tue','Wed','Thu','Fri','Sat','Sun'],
            errorbars: null,
            yaxis: false,
            backgroundGridBorder: false,
            backgroundGridVlines: false,
            spline: true,
            shadow: true,
            errorbars: [
                1,
                null,
                , // Undefined
                0,
                {min:1, max: 5},
                {min: 1},
                {max: 1}
            ]
        }
    }).draw();
</script>

The coordinates properties

The coordinates for the points on the Line chart are held in the following arrays:

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

Name: backgroundColor
Description: 
The color of the background.
Default: null
Name: backgroundImage
Description: 
A URL of an image to render to the background.
Default: null
Name: backgroundImageAspect
Description: 
The aspect ratio setting of the svg image tag, eg it could be XMinYMin meet.
Default: none
Name: backgroundImageOpacity
Description: 
The opacity value of the background image.
Default: 0.5
Name: backgroundImageStretch
Description: 
Whether the background image is stretched across the whole chart (except the margins).
Default: true
Name: backgroundImageX
Description: 
If you're not using the stretch option you can specify the x-axis coordinate of the image.
Default: null
Name: backgroundImageX
Description: 
If you're not using the stretch option you can specify the y-axis coordinate of the image.
Default: null
Name: backgroundImageW
Description: 
If you're not using the stretch option you can specify the width of the image.
Default: null
Name: backgroundImageH
Description: 
If you're not using the stretch option you can specify the height of the image.
Default: null
Name: backgroundGrid
Description: 
Whether to show the background grid or not.
Default: true
Name: backgroundGridColor
Description: 
The color of the background grid.
Default: #ddd
Name: backgroundGridLinewidth
Description: 
The linewidth that the background grid lines are. Decimals (eg 0.5) are permitted.
Default: 1
Name: backgroundGridBorder
Description: 
Determines whether a border is drawn around the grid.
Default: true
Name: backgroundGridHlines
Description: 
Determines whether to draw the horizontal grid lines.
Default: true
Name: backgroundGridHlinesCount
Description: 
Determines how many horizontal grid lines you have. The default is linked to how many scale labels that you have.
Default: null
Name: backgroundGridVlines
Description: 
Determines whether to draw the vertical grid lines.
Default: true
Name: backgroundGridVlinesCount
Description: 
Determines how many vertical grid lines you have. The default is to be linked to how many scale labels that you have.
Default: null
Name: backgroundGridDashed
Description: 
You can specify a dashed background grid by setting this to true. This option takes precedence over the dotted variant.
Default: false
Name: backgroundGridDotted
Description: 
You can specify a dotted background grid by setting this to true.
Default: false
Name: backgroundGridDashArray
Description: 
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
Name: backgroundBorder
Description: 
You can use this property to specify that the chart area has a border around it.
Default: false
Name: backgroundBorderLinewidth
Description: 
The linewidth of the border that goes around the chart area.
Default: 1
Name: backgroundBorderColor
Description: 
The color of the border that goes around the chart area.
Default: #aaa
Name: backgroundBorderDashed
Description: 
Whether the border around the chart area is dashed or not.
Default: false
Name: backgroundBorderDotted
Description: 
Whether the border around the chart area is dotted or not.
Default: false
Name: backgroundBorderDashArray
Description: 
If the default dot or dash style is not to your liking you can use this property to specify your own style. It should be an array of two or more elements that specify the dashes and spaces - for example: backgroundBorderDashArray: [5,10],
Default: null

Margin properties

Name: marginLeft
Description: 
The left margin of the chart, (the margin is where the labels and title are)).
Default: 35
Name: marginRight
Description: 
The right margin of the chart, (the margin is where the labels and title are).
Default: 35
Name: marginTop
Description: 
The top margin of the chart, (the margin is where the labels and title are).
Default: 35
Name: marginBottom
Description: 
The bottom margin of the chart, (the margin is where the labels and title are).
Default: 35
Name: marginInner
Description: 
The horizontal margin (in pixels) of the chart. The horizontal margin is on the inside of the axes.
Default: 15

Color properties

Name: colors
Description: 
An array of the colors of the bars.
Default: An array - ['red', '#0f0', 'blue', '#ff0', '#0ff', 'green']

Fill properties

Name: filled
Description: 
Whether the line is filled or not.
Default: false
Name: filledColors
Description: 
An array containing the fill colors to be used.
Default: []
Name: filledClick
Description: 
A function that is triggered by clicking on the fill part of the line. It can look like this:
filledClick: function (e, obj, index)
{
    // e:     The event object
    // obj:   The chart object
    // index: The index of the line that was clicked
},
Default: null
Name: filledOpacity
Description: 
The opacity of the fill color. This should be a number between 0 and 1.
Default: 1
Name: filledAccumulative
Description: 
This controls whether the values for the lines are displayed accumulatively (ie the filled lines are stacked)
Default: false

X-axis properties

Name: xaxis
Description: 
Whether the x-axis is shown or not.
Default: true
Name: xaxisLinewidth
Description: 
The linewidth that's used to draw the x-axis.
Default: 1
Name: xaxisTickmarks
Description: 
Whether the x-axis has tickmarks or not.
Default: true
Name: xaxisTickmarksLength
Description: 
The size of the x-axis tickmarks.
Default: 3
Name: xaxisLabels
Description: 
The labels for the x-axis.
Default: null
Name: xaxisLabelsOffsetx
Description: 
The x-axis pixel offset that's added to the x-axis labels.
Default:  0
Name: xaxisLabelsOffsety
Description: 
The y-axis pixel offset that's added to the x-axis labels.
Default:  0
Name: xaxisLabelsPosition
Description: 
This determines the positioning of the x-axis labels. You probably won't need to change this.
Default: edge
Name: xaxisColor
Description: 
The color of the x-axis.
Default: black
Name: xaxisLabelsColor
Description: 
The color of the x-axis text.
Default: null
Name: xaxisLabelsBold
Description: 
Whether the x-axis text is bold or not.
Default: null
Name: xaxisLabelsItalic
Description: 
Whether the x-axis text is italic or not.
Default: null
Name: xaxisLabelsFont
Description: 
The font of the x-axis text.
Default: null
Name: xaxisLabelsSize
Description: 
The size of the x-axis text.
Default: null
Name: xaxisLabelsPositionEdgeTickmarksCount
Description: 
Not something you'll use often, if at all. Determines how many tickmarks there are when the x-axis is in edge mode.
Default: null
Name: xaxisLabelsAngle
Description: 
If you have long labels you may want to set this to a number between 0 and 90 to enable angled labels.
Default: null
Name: xaxisLabelsFormattedDecimals
Description: 
When using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro.
Default:  0
Name: xaxisLabelsFormattedPoint
Description: 
When using formatted labels this is the decimal point character that's used with the %{value_formatted} macro.
Default: .
Name: xaxisLabelsFormattedThousand
Description: 
When using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro.
Default: ,
Name: xaxisLabelsFormattedUnitsPre
Description: 
When using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro.
Default: (an empty string)
Name: xaxisLabelsFormattedUnitsPost
Description: 
When using formatted labels these are the units that are appended to the number with the %{value_formatted} macro.
Default: (an empty string)
Name: xaxisTitle
Description: 
This allows you to specify a title for the x-axis.
Default: none
Name: xaxisTitleSize
Description: 
This allows you to specify a size for the x-axis title.
Default: null
Name: xaxisTitleFont
Description: 
This allows you to specify a font for the x-axis title.
Default: null
Name: xaxisTitleBold
Description: 
This controls whether the x-axis title is bold or not.
Default: null
Name: xaxisTitleItalic
Description: 
This controls whether the x-axis title is italic or not.
Default: null
Name: xaxisTitleColor
Description: 
This controls the color of the x-axis title.
Default: null
Name: xaxisTitleX
Description: 
By giving this you can specifically set the x-axis coordinate of the x-axis title.
Default: null
Name: xaxisTitleY
Description: 
By giving this you can specifically set the y-axis coordinate of the x-axis title.
Default: null
Name: xaxisTitleOffsetx
Description: 
The x-axis pixel offset that's applied to the x-axis title.
Default:  0
Name: xaxisTitleOffsety
Description: 
The y-axis pixel offset that's applied to the x-axis title.
Default:  0
Name: xaxisTitleHalign
Description: 
The horizontal alignment of the x-axis title.
Default: null
Name: xaxisTitleValign
Description: 
The vertical alignment of the x-axis title.
Default: null

Y-axis properties

Name: yaxis
Description: 
Whether the y-axis is shown or not.
Default: true
Name: yaxisPosition
Description: 
This controls whether the y-axis is positioned on the left or the right.
Default: left
Name: yaxisLinewidth
Description: 
The linewidth that's used to draw the y-axis.
Default: 1
Name: yaxisTickmarks
Description: 
Whether the y-axis has tickmarks or not.
Default: true
Name: yaxisTickmarksLength
Description: 
The size of the y-axis tickmarks.
Default: 3
Name: yaxisColor
Description: 
The color of the y-axis.
Default: black
Name: yaxisLabels
Description: 
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
Name: yaxisLabelsOffsetx
Description: 
The x-axis pixel offset that's added to the y-axis labels.
Default:  0
Name: yaxisLabelsOffsety
Description: 
The y-axis pixel offset that's added to the y-axis labels.
Default:  0
Name: yaxisLabelsHalign
Description: 
The horizontal alignment of the labels.
Default: right
Name: yaxisLabelsValign
Description: 
The vertical alignment of the labels.
Default: center
Name: yaxisLabelsCount
Description: 
The number of y-axis labels.
Default: 5
Name: yaxisLabelsPositionEdgeTickmarksCount
Description: 
Not something you'll use often, if at all. Determines how many tickmarks there are.
Default: null
Name: yaxisScale
Description: 
Whether the y-axis scale is shown.
Default: true
Name: yaxisScaleUnitsPre
Description: 
Units that are prepended to the scale numbers.
Default:  (An empty string
Name: yaxisScaleUnitsPost
Description: 
Units that are appended to the scale numbers.
Default: (An empty string
Name: yaxisScaleDecimals
Description: 
The number of decimals that the scale will show.
Default:  0
Name: yaxisScalePoint
Description: 
The character(s) used as the decimal point.
Default: .
Name: yaxisScaleThousand
Description: 
The character(s) used as the thousand separator.
Default: ,
Name: yaxisScaleRound
Description: 
If set to true the max scale value will be rounded up.
Default: false
Name: yaxisScaleMax
Description: 
The maximum scale value.
Default: null
Name: yaxisScaleMin
Description: 
The minimum y-axis 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
Name: yaxisScaleFormatter
Description: 
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
Name: yaxisLabelsColor
Description: 
The color of the y-axis text.
Default: null
Name: yaxisLabelsBold
Description: 
Whether the y-axis text is bold or not.
Default: null
Name: yaxisLabelsItalic
Description: 
Whether the y-axis text is italic or not.
Default: null
Name: yaxisLabelsFont
Description: 
The font of the y-axis text.
Default: null
Name: yaxisLabelsSize
Description: 
The size of the y-axis text.
Default: null
Name: yaxisTitle
Description: 
This allows you to specify a title for the y-axis.
Default: none
Name: yaxisTitleSize
Description: 
This allows you to specify a size for the y-axis title.
Default: null
Name: yaxisTitleFont
Description: 
This allows you to specify a font for the y-axis title.
Default: null
Name: yaxisTitleBold
Description: 
This controls whether the y-axis title is bold or not.
Default: null
Name: yaxisTitleItalic
Description: 
This controls whether the y-axis title is italic or not.
Default: null
Name: yaxisTitleColor
Description: 
This controls the color of the y-axis title.
Default: null
Name: yaxisTitleX
Description: 
By giving this you can specifically set the x-axis position of the y-axis title.
Default: null
Name: yaxisTitleY
Description: 
By giving this you can specifically set the y-axis position of the y-axis title.
Default: null
Name: yaxisTitleOffsetx
Description: 
The x-axis pixel offset that's applied to the y-axis title.
Default:  0
Name: yaxisTitleOffsety
Description: 
The y-axis pixel offset that's applied to the y-axis title.
Default:  0
Name: yaxisTitleHalign
Description: 
The horizontal alignment of the y-axis title.
Default: null
Name: yaxisTitleValign
Description: 
The vertical alignment of the y-axis title.
Default: null

Other text properties

Name: textColor
Description: 
The color of the text.
Default: black
Name: textFont
Description: 
The font used for text.
Default: Arial, Verdana, sans-serif
Name: textSize
Description: 
The size of the text.
Default: 12
Name: textBold
Description: 
Whether the text is bold or not.
Default: false
Name: textItalic
Description: 
Whether the text is italic or not.
Default: false
Name: text
Description: 
This allows you to add custom text to your chart if you want to. There's a dedicated page that describes this option here.
Default: null
Name: labelsAbove
Description: 
Whether to show the labelsAbove style labels.
Default: false
Name: labelsAbovePoint
Description: 
The decimal point character to use for the labelsAbove labels.
Default: null
Name: labelsAboveThousand
Description: 
The thousand separator character to use for the labelsAbove labels.
Default: null
Name: labelsAboveDecimals
Description: 
The number of decimals to use for the labelsAbove labels.
Default:  0
Name: labelsAbovePre
Description: 
A string to prepend to the labelsAbove labels.
Default: null
Name: labelsAbovePost
Description: 
A string to append to the labelsAbove labels.
Default: null
Name: labelsAboveFormatter
Description: 
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
Name: labelsAboveOffsetx
Description: 
The horizontal offset of the labelsAbove labels.
Default:  0
Name: labelsAboveOffsety
Description: 
The vertical offset of the labelsAbove labels.
Default:  0
Name: labelsAboveFont
Description: 
The font of the labelsAbove labels.
Default: null
Name: labelsAboveSize
Description: 
The size of the labelsAbove labels.
Default: null
Name: labelsAboveBold
Description: 
Whether the labelsAbove labels are bold or not.
Default: null
Name: labelsAboveItalic
Description: 
Whether the labelsAbove labels are italic or not.
Default: null
Name: labelsAboveColor
Description: 
The color of the labelsAbove labels.
Default: null
Name: labelsAboveBackground
Description: 
The background color of the labelsAbove labels.
Default: null
Name: labelsAboveBackgroundPadding
Description: 
The padding of the labelsAbove labels.
Default:  0
Name: labelsAboveHalign
Description: 
The horizontal alignment of the labelsAbove.
Default: center
Name: labelsAboveValign
Description: 
The vertical alignment of the labelsAbove.
Default: bottom
Name: labelsAboveSpecific
Description: 
This property allows you to make the labelsAbove labels specific strings.
Default: null

Tooltip properties

Name: tooltips
Description: 
An array of tooltips for the chart. This array should NOT be multidimensional. You can also check the canvas tooltips documentation for more information.
Default: null
Name: tooltipsOverride
Description: 
If required, this can be a function that 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).
Default: null
Name: tooltipsEvent
Description: 
The event used for tooltips (either click or mousemove.
Default: click
Name: tooltipsFormattedPoint
Description: 
When using formatted tooltip strings this is used as the point when using the %{value_formatted} option.
Default: .
Name: tooltipsFormattedThousand
Description: 
When using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.
Default: ,
Name: tooltipsFormattedDecimals
Description: 
When using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option.
Default:  0
Name: tooltipsFormattedUnitsPre
Description: 
When using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.
Default: (an empty string)
Name: tooltipsFormattedUnitsPost
Description: 
When using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.
Default: (an empty string)
Name: tooltipsFormattedKeyLabels
Description: 
The labels that are used in the formatted tooltip key.
Default: [] (an empty array)
Name: tooltipsFormattedKeyColors
Description: 
The colors that are used in the formatted tooltip key. Normally these are automatically taken from the colors on the chart but can be specified differently using this property.
Default: null
Name: tooltipsFormattedKeyColorsShape
Description: 
This is the shape that's used in the tooltip key. It can be square or circle
Default: square
Name: tooltipsFormattedKeyColorsCss
Description: 
By using this property you can add css values to the key color shape that appears in the tooltip key. Note the property name is "color" and not "colors" like previous properties. It should be an object of css properties like this:
tooltipsFormattedKeyColorsCss : {
    border: "1px solid #ddd";
}
Default: null
Name: tooltipsFormattedListType
Description: 
With this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol.
Default: ul
Name: tooltipsFormattedListItems
Description: 
This should be a two-dimension array of the list items that are to be shown for all of the tooltips. An example of this property is:
tooltipsFormattedListItems: [
    ['Bill','Jerry','Berty'], // First tooltip
    ['Gill','Carrie','Lucy'], // Second tooltip
    ['Pob','Nobby','Hilda']   // Third tooltip
]
You can use to style this list - for example:
.RGraph_tooltip ul#rgraph_formatted_tooltips_list li {
    text-align: left;
    color: yellow;
}
Default: null
Name: tooltipsFormattedTableHeaders
Description: 
When showing a table in the tooltips this can be an array of headers for the table. These are added to the tooltip using th tags.
Default: null
Name: tooltipsFormattedTableData
Description: 
This is the data that is added to the table. This is a 3-dimensional array so it's easy to make a mistake. See the example in the canvas documentation, copy the code from it and then modify it suit. You'll create fewer bugs this way.
Default: null)
Name: tooltipsPointer
Description: 
By default the tooltips have a small triangular pointer that points to the shape that was clicked on. You can turn this off with this property.
Default: true
Name: tooltipsPointerCss
Description: 
If you want any css values applied to the tooltips pointer (a css border, for example) then specify an object containing those values to this property. For example:
tooltips: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}
Default: null
Name: tooltipsPointerOffsetx
Description: 
This allows you to adjust the horizontal position of the tooltips pointer.
Default:  0
Name: tooltipsPointerOffsety
Description: 
This allows you to adjust the vertical position of the tooltips pointer.
Default:  0
Name: tooltipsPositionStatic
Description: 
The new default (as of August 2020) is for tooltips to be positioned statically and not be dependent on the mouse position. If you don't want this for whatever reason, you can disable it with this setting. When you set it to false tooltips are positioned next to the mouse pointer.
Default: true
Name: tooltipsCss
Description: 
If you want to specify some css that gets applied to all of the tooltips, but don't want to use the RGraph.SVG.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'
}
Default: null
Name: tooltipsCssClass
Description: 
The css class that's applied to the tooltip div.
Default: RGraph_tooltip
Name: tooltipsOffsetx
Description: 
This property allows you to shift the tooltips left or right.
Default:  0
Name: tooltipsOffsety
Description: 
This property allows you to shift the tooltips up or down.
Default:  0
Name: tooltipsDataset
Description: 
Instead of one tooltip for each point on the line this option allows you to specify one tooltip for each line on your chart.
Default:  null
Name: tooltipsHotspotSize
Description: 
This controls the size of the hotspots that trigger tooltips.
Default:  5

Tickmark properties

Name: tickmarksStyle
Description: 
The style of tickmarks for the line. This can be a string or an array of strings (if there are multiple lines). It can be:
  • circle
  • endcircle
  • filledcircle
  • filledendcircle
  • rect
  • endrect
  • filledrect
  • fillendendrect
Default: none
Name: tickmarksSize
Description: 
The size of the tickmarks. This can be a number or an array of numbers (if there are multiple lines).
Default: 5
Name: tickmarksFill
Description: 
The fill color used for the inner of tickmarks. This can be a string or an array of strings (if there are multiple lines).
Default: white

Shadow properties

Name: shadow
Description: 
Whether or not shadows or shown underneath the lines
Default: false
Name: shadowOffsetx
Description: 
The x-axis offset of the shadows.
Default: 2
Name: shadowOffsety
Description: 
The y-axis offset of the shadows.
Default: 2
Name: shadowBlur
Description: 
The magnitude of the blurring effect of the shadow.
Default: 2
Name: shadowColor
Description: 
The color of the shadow.
Default: rgba(0,0,0,0.25)

Title properties

Name: title
Description: 
The title of the chart.
Default: (An empty string)
Name: titleX
Description: 
The specific x-axis 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
Name: titleY
Description: 
The specific y-axis 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
Name: titleOffsetx
Description: 
An offset value that is added to the calculated x-axis coordinate.
Default:  0
Name: titleOffsety
Description: 
An offset value that is added to the calculated y-axis coordinate.
Default:  0
Name: titleHalign
Description: 
The horizontal alignment of the title.
Default: center
Name: titleColor
Description: 
The color of the title.
Default: null
Name: titleFont
Description: 
The font used to render the title.
Default: null
Name: titleSize
Description: 
The size of the font used to render the title.
Default: null
Name: titleBold
Description: 
Whether the title is bold or not.
Default: null
Name: titleItalic
Description: 
Whether the title is italic or not.
Default: null
Name: titleSubtitle
Description: 
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)
Name: titleSubtitleColor
Description: 
The color of the subtitle.
Default: #aaa
Name: titleSubtitleFont
Description: 
The font used to render the subtitle.
Default: null
Name: titleSubtitleSize
Description: 
The size of the font used to render the subtitle.
Default: null
Name: titleSubtitleBold
Description: 
Whether the subtitle is bold or not.
Default: null
Name: titleSubtitleItalic
Description: 
Whether the subtitle is italic or not.
Default: null

Key properties

Name: key
Description: 
An array of the labels that appear on the key.
Default: null
Name: keyColors
Description: 
An array of colors to be shown on the key. If not specified then the colors option will be used instead.
Default: null
Name: keyLabelsColor
Description: 
The color of the text in the key.
Default: null
Name: keyLabelsBold
Description: 
Whether the key text is bold or not.
Default: null
Name: keyLabelsFont
Description: 
The font to use for the key text.
Default: null
Name: keyLabelsSize
Description: 
The size to use for the key text.
Default: null
Name: ketLabelsItalic
Description: 
Whether the key text is italic or not.
Default: null
Name: keyLabelsOffsetx
Description: 
The horizontal pixel offset of the key text (just the text).
Default:  0
Name: keyLabelsOffsety
Description: 
The vertical pixel offset of the key text (just the text).
Default: -1
Name: keyOffsetx
Description: 
The horizontal pixel offset of the entire key.
Default:  0
Name: keyOffsety
Description: 
The horizontal pixel offset of the entire key.
Default:  0
Name: keyColorShape
Description: 
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

Error bar properties

Name: errorbars
Description: 
This should be an array of either numbers or objects that represent the errorbars. If it's an object you can specify information that's specific to the point.
Default: null
Name: errorbarsColor
Description: 
The default color of the errorbars. This can be overridden using the color setting if you give an object as the errorbar information.
Default: black
Name: errorbarsLinewidth
Description: 
The 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.
Default: 1
Name: errorbarsCapwidth
Description: 
The width of the caps to the errorbars. This can be overridden using the capwidth setting if you give an object as the errorbar information.
Default: 10

Trend line properties

Name: trendline
Description: 
If you want it to RGraph can generate a "best-fit" trend line for your data. This can be both a boolean or an array of boolean values for when you have multiple datasets.
Default: false
Name: trendlineColors
Description: 
Use this property to specify either a single color or an array of colors for the trend line(s).
Default: [#666]
Name: trendlineLinewidth
Description: 
Use this property to specify the linewidth of the trend line(s). It can be a single number or an array of numbers if you have multiple datasets.
Default: 1
Name: trendlineMargin
Description: 
Use this property to specify the margin of the trend line(s). It can be a single number or an array of numbers if you have multiple datasets.
Default: 25
Name: trendlineDashed
Description: 
If true then the trend lines on the chart will be dashed. It can be a single boolean or an array of booleans if you have multiple datasets.
Default: false
Name: trendlineDotted
Description: 
If true then the trend lines on the chart will be dotted. It can be a single boolean or an array of booleans if you have multiple datasets.
Default: false
Name: trendlineDashArray
Description: 
If you want to give your own style of dashes then you can do that with this property. It should be an array containing numbers - alternating between the length of the dash and the length of the gap after the dash. It can also be an array of these two value arrays for when you have multiple trend lines on your chart and you want them to have different styles of dots/dashes. For example, you could set this property to: [ [5,5], [2,2] ]
Default: null
Name: trendlineClip
Description: 
Defaulting to true, this clips the drawing region for the trendline to the graph area of the chart (the region of the canvas that doesn't include the margins and that is (by default) covered by the background grid.
Default: true

Null value properties

Name: nullBridge
Description: 
If you prefer, then RGraph can span the gaps in your line that are present due to there being null values in your data.
Default: false
Name: nullBridgeLinewidth
Description: 
To set the linewidth of the null value connector lines you can use this property. It should be a number. If left at the default null value it will use the same linewidth that the linewidth property sets.
Default: null
Name: nullBridgeColors
Description: 
To supply specific colors for the null bridges you can set this to a single color or an array of colors. By default, this is null, in which case the standard line colors are used.
Default: null
Name: nullBridgeDashArray
Description: 
By default, the lines that are drawn to span null values are dashed. Using this property you can give a two-element array that is used to describe the line-dash setting. To get a solid line you can use a setting such as [5,0]
Default: [5,5]

Other properties

Name: linewidth
Description: 
The linewidth used to render the line with.
Default: 1
Name: linecap
Description: 
This property allows you to set the style for the stroke-linecap attribute. It can be butt round or square This can also be an array of those strings for when you have multiple lines on your chart and you want different styles for each. NB When the linejoin property is set to bevel you'll need to set this to butt.
Default: round
Name: linejoin
Description: 
This property allows you to set the style for the stroke-linejoin attribute. It can be bevel round or miter This can also be an array of those strings for when you have multiple lines on your chart and you want different styles for each.
Default: round
Name: spline
Description: 
Whether a spline Line chart (curvy instead of angular) is used.
Default: false
Name: stepped
Description: 
If true then the line will be drawn in a stepped fashion. Obviously, this cannot be used with thespline option.
Default: false
Name: dotted
Description: 
Whether the line should be drawn as a dotted line.
Default: false
Name: dashed
Description: 
Whether the line should be drawn as a dashed line.
Default: false
Name: dasharray
Description: 
If you want to specify your own style of dash/gap for the line then this is the property to use. Give it an array consisting of two numbers - the size of the gap and then the size of the dash like this: [5,20]
Default: [1,0]
Name: highlightFill
Description: 
This can be used to override the inner color of the highlight that gets applied to points when tooltips are being used.
Default: null
Name: horizontalLines
Description: 
With this property you can add horizontal lines to your chart. This feature was initially designed with adding an average line indicator in mind but can be used to indicate any value with any label. The value of this property should be an array of objects and each object can consist of the following:
  • value: The value you want the line positioned at or the keyword average (default: average)
  • color: The color of the line (default: #666)
  • dashed: Whether the line is dashed or not (default: true)
  • dotted: Whether the line is dotted or not (default: false)
  • linewidth: The linewidth of the line (default: 1)
  • label: this is The label that appears above (by default) the line. If you don't want a label you can set this to an empty string. default: Average (%{value})
  • labelPosition: This can be a string that consists of the following keywords: left/center/right top/bottom (default: top right)
  • labelFont: The font that the label is drawn in (default: [the same as the textFont property])
  • labelColor: The color that the label is drawn in (default: #666)
  • labelSize: The size of the label (in points) (default: 4 points less than the textSize setting)
  • labelBold: Whether the label is bold or not (default: null [falls back to the textBold setting])
  • labelItalic: Whether the label is italic or not (default: null [falls back to the textItalic setting])
  • labelValueDecimals: How many decimals are shown on the number. (default: 2)
  • labelValuePoint: The character used as the decimal point. (default: .)
  • labelValueThousand: The character used as the thousand separator charactor.(default: ,)
  • labelValueUnitsPre: This string is prended to the number. (default: [an empty string])
  • labelValueUnitsPost: This string is appended to the number. (default: [an empty string])
  • labelOffsetx: The horizontal offset that's applied to the X coordinate. (default: 0)
  • labelOffsety: The vertical offset that's applied to the Y coordinate. (default: 0)
  • labelValueFormatter: This function handles ALL of the formatting of the number. (default: null)
Here's an example:
obj.set('horizontalLines', [
    {
        value: 'average',
        dashed: true,
        labelPosition:'left bottom'
    },
    {
        value: 10.48,
        label:'Value (%{value})',
        labelValueDecimals: 2,
        labelValueThousand: ',',
        labelValuePoint:'.',
        labelValueUnitsPre:'',
        labelValueUnitsPost:''
        //labelValueFormatter: function (opt)
        //{
        //    return opt.number;
        //}
    }
]);
Default: null
Name: responsive
Description: 
This option is new to the July 2023 release (v6.13) and allows you to inline the responsive configuration instead of appending it on to the end of the object it as a function. The documentation and demo pages have been updated to use this new option. You can read more about the responsive feature by reading the responsive configuration page.
Default: null

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-axis 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
});
obj.responsive(configuration)

The responsive function helps your charts respond to different browser window sizes and screen resolutions. For example, for smaller screens, you might want to have angled labels or show shorter versions of them completely.

Update: There is now the responsive configuration option available to you and this is now the preferred method of configuration.

The responsive function and configuration option are documented on their own page here.

Data properties that are used on the points

The svg circle or rect elements that represent the tickmark hotspots on the Line 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:

hotspot.getAttribute('data-index');

Note that for stacked and grouped charts the group can be retrieved by doing this:

sequentialIndex = obj.coords[0].element.getAttribute('data-sequential-index');
indexes         = RGraph.SVG.sequentailIndexToGrouped(sequentialIndex, obj.data);

Events

RGraph supports custom events that allow you to easily add interactivity to your charts if required. The following events are available:

For example:
new RGraph.SVG.Line({
    id: 'chart-container',
    data: [4,8,6,3,5,8,9],
    options: {
    }
}).on('tooltip', function (obj)
{
    console.log('The draw event has fired');
    
}).draw();

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.Line({
        id: 'mySVG',
        data: [3,4,7,5,6,9,8],
        options: {
        }
    }).trace({frames: 60}, myCallback);
</script>