Line chart

Note: With the Line chart, there isn't an option to have a scale on the x-axis. For this, you'll need a Scatter chart with the line option set to true. You can either use labels across the x-axis, an x-scale or you can also use the X-axis drawing object.

Example

View example on CodePen
<script>
    data = [
        [8,7,6,4,9,5,6,7,9],
        [1,3,4,2,5,0,3,1,1]
    ];

    xaxisLabels = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep'];

    //
    // Configure and make the first draw of the Line chart
    //
    myLine = new RGraph.Line({
        id: 'cvs',
        data: data,
        options: {
            tooltips: '%{key}',
            tooltipsFormattedUnitsPost: '%',
            tooltipsFormattedKeyColors: ['red','blue','#0f0'],
            tooltipsFormattedKeyLabels: ['John','Richard','Luis'],
            tooltipsCss: {
                fontSize: '16pt',
                textAlign: 'left'
            },
            backgroundGridVlines: false,
            backgroundGridBorder: false,
            colors: ['red','blue','green'],
            linewidth: 2,
            spline: true,
            tickmarksStyle: 'dot',
            tickmarksSize: 6,
            xaxisLabels: xaxisLabels,
            xaxis: false,
            yaxis: false,
            marginLeft: 40,
            marginInner: 15,
            shadow: false,
            labelsAbove: true,
            labelsAboveSize: 10,
                labelsAboveUnitsPost: '%',
            labelsAboveOffsety: -5,
            textSize: 16
        }
    }).draw();




    //
    // This function switches the dataset. It uses the reverse:
    // option of the trace() and wave() effects to hide the
    // lines, switches the data and then animates the lines
    // back in
    //
    function change ()
    {
        butChange = document.getElementById('changeData');
        
        // Because this is a composite animation - turn
        // off the labelsAbove option ourselves
        myLine.set('labelsAbove', false);

        // If the chart is currently animating - don't do
        // anything
        if (!myLine.animating) {
            
            myLine.animating       = true;
            butChange.disabled     = true;
            butChange.style.cursor = 'default';
            
            // Call the reverse wave() function
            myLine.trace({frames: 75, reverse: true})
                 .wave({frames: 90, reverse: true}, function ()
                 {

                     // Change the data
                     myLine.original_data =
                     [
                         RGraph.arrayRandom(9, 0, 10),
                         RGraph.arrayRandom(9, 0, 10)
                     ];
                    
                     // Show the new data by animating with the
                     // wave() effect
                     setTimeout(function ()
                     {
                        myLine.trace({frames: 90})
                         myLine.wave({frames: 150}, function ()
                         {
                             myLine.animating       = false;
                             butChange.disabled     = false;
                             butChange.style.cursor = 'pointer';
                            
                             // Re-enable labelsAbove
                             myLine.set('labelsAbove', true);
                            
                             RGraph.redraw();
                         });
                     }, 500);
                });
        }
    }
</script>

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
backgroundBarsCountThe number of background bars.5
backgroundBarsColor1The color of the background bars (1 of 2).rgba(0,0,0,0)
backgroundBarsColor2The color of the background bars (2 of 2).rgba(0,0,0,0)
backgroundGridWhether to show the background grid or not.true
backgroundGridColorThe color of the background grid.#eee
backgroundHbarsAn array of information stipulating horizontal colored bars. You can use these to indicate limits. Eg: obj.set('backgroundHbars', [[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.null
backgroundGridLinewidthThe width of the background grid.1
backgroundGridBorderDetermines whether a border is drawn around the grid.true
backgroundGridHlinesDetermines whether to draw the horizontal gridlines.true
backgroundGridVlinesDetermines whether to draw the vertical gridlines.true
backgroundGridAutofitInstead of specifying a pixel width/height for the background grid, you can use autofit and specify how many horizontal and vertical lines you want.true
backgroundGridHlinesCountWhen using autofit this allows you to specify how many horizontal gridlines you want.5
backgroundGridVlinesCountWhen using autofit this allows you to specify how many vertical gridlines you want.20
backgroundGridAlignIf you want to have your gridlines line up with the labels (both X and Y axes), you can set this to true and RGraph will attempt to make the gridlines line up. If you have a marginInner set then the alignment will be thrown out.true
backgroundGridDottedIf you want to have your background grid dashed then set this to true.false
backgroundGridDashedIf you want to have your background grid dotted then set this to true. This takes precedence over dashed lines.false
backgroundImageIf you want to specify a background image to use on your chart, specify it with this property. If you use effects with a background image on your chart it may make the effect flicker. Using a background image with the draw event may mean that the event fires twice. There is a property that you can check though that is set when the image has loaded: obj.__rgraph_background_image_loaded__ Simply check this flag in your draw event. If it's true then the background image has loaded.null
backgroundImageStretchBy default your background image is stretched (if necessary) to cover the whole chart area (margins not included). If this is not what you want then set this property to false.true
backgroundImageXThe X coordinate of the image. The coordinates are the top left corner of the image.null
backgroundImageYThe Y coordinate of the image. The coordinates are the top left corner of the image.null
backgroundImageWThe width of the image. If you have a large canvas with many charts - you may need to specify this.null
backgroundImageHThe height of the image. If you have a large canvas with many charts - you may need to specify this.null
backgroundImageAlignInstead of specifying the coordinates of the image, you can instead simply align it top, bottom, left or right. Examples are:
  • top left
  • bottom right
  • bottom
  • right
null
backgroundImageAlphaThe alpha value (the opacity) of the image.1
backdropWhen enabled this specifies that the line(s) will have a backdrop effect. You can control the transparency with the other backdrop settings).false
backdropSizeThis controls the size/extent of the backdrop effect.30
backdropAlphaThis controls how much transparency the backdrop effect has. It can go from 0 - 1.0.2
backgroundBarsCount
The number of background bars.
Default: 5

backgroundBarsColor1
The color of the background bars (1 of 2).
Default: rgba(0,0,0,0)

backgroundBarsColor2
The color of the background bars (2 of 2).
Default: rgba(0,0,0,0)

backgroundGrid
Whether to show the background grid or not.
Default: true

backgroundGridColor
The color of the background grid.
Default: #eee

backgroundHbars
An array of information stipulating horizontal colored bars. You can use these to indicate limits. Eg: obj.set('backgroundHbars', [[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.
Default: null

backgroundGridLinewidth
The width of the background grid.
Default: 1

backgroundGridBorder
Determines whether a border is drawn around the grid.
Default: true

backgroundGridHlines
Determines whether to draw the horizontal gridlines.
Default: true

backgroundGridVlines
Determines whether to draw the vertical gridlines.
Default: true

backgroundGridAutofit
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.
Default: true

backgroundGridHlinesCount
When using autofit this allows you to specify how many horizontal gridlines you want.
Default: 5

backgroundGridVlinesCount
When using autofit this allows you to specify how many vertical gridlines you want.
Default: 20

backgroundGridAlign
If you want to have your gridlines line up with the labels (both X and Y axes), you can set this to true and RGraph will attempt to make the gridlines line up. If you have a marginInner set then the alignment will be thrown out.
Default: true

backgroundGridDotted
If you want to have your background grid dashed then set this to true.
Default: false

backgroundGridDashed
If you want to have your background grid dotted then set this to true. This takes precedence over dashed lines.
Default: false

backgroundImage
If you want to specify a background image to use on your chart, specify it with this property. If you use effects with a background image on your chart it may make the effect flicker. Using a background image with the draw event may mean that the event fires twice. There is a property that you can check though that is set when the image has loaded: obj.__rgraph_background_image_loaded__ Simply check this flag in your draw event. If it's true then the background image has loaded.
Default: null

backgroundImageStretch
By default your background image is stretched (if necessary) to cover the whole chart area (margins not included). If this is not what you want then set this property to false.
Default: true

backgroundImageX
The X coordinate of the image. The coordinates are the top left corner of the image.
Default: null

backgroundImageY
The Y coordinate of the image. The coordinates are the top left corner of the image.
Default: null

backgroundImageW
The width of the image. If you have a large canvas with many charts - you may need to specify this.
Default: null

backgroundImageH
The height of the image. If you have a large canvas with many charts - you may need to specify this.
Default: null

backgroundImageAlign
Instead of specifying the coordinates of the image, you can instead simply align it top, bottom, left or right. Examples are:
  • top left
  • bottom right
  • bottom
  • right

Default: null

backgroundImageAlpha
The alpha value (the opacity) of the image.
Default: 1

backdrop
When enabled this specifies that the line(s) will have a backdrop effect. You can control the transparency with the other backdrop settings).
Default: false

backdropSize
This controls the size/extent of the backdrop effect.
Default: 30

backdropAlpha
This controls how much transparency the backdrop effect has. It can go from 0 - 1.
Default: 0.2

X-axis properties

PropertyDescriptionDefault
xaxisSet this to true if you don't want an x-axis.true
xaxisPositionThis 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 yaxisScaleMax and yaxisScaleMin properties.bottom
xaxisLinewidthThe linewidth used for the x-axis and the x-axis tickmarks.1
xaxisColorThe color of the x-axis (and its tickmarks.black
xaxisTickmarksWhether the x-axis tickmarks are shown.true
xaxisTickmarksLastLeftWhether the last tickmark on the left is displayed.null
xaxisTickmarksLastRightWhether the last tickmark on the right is displayed.null
xaxisTickmarksLengthThe length of the tickmarks.3
xaxisTickmarksCountThe number of tickmarks that are shown on the x-axis.null
xaxisLabelsAn array of the labels to be used on the chart. You can also give this option a string if you prefer and use formatted labels.An empty array
xaxisLabelsFontThe font used to render the labels.null
xaxisLabelsSizeThe size of the labels.null
xaxisLabelsColorThe color of the labels.null
xaxisLabelsBoldWhether the labels are bold or not.null
xaxisLabelsItalicWhether the labels are italic or not.null
xaxisLabelsOffsetxThis allows you finer-grained control in the horizontal direction over the X label positioning if you need it. 0
xaxisLabelsOffsetyThis allows you finer-grained control in the vertical direction over the X label positioning if you need it. 0
xaxisLabelsFormattedDecimalsWhen using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro. 0
xaxisLabelsFormattedPointWhen using formatted labels this is the decimal point character that's used with the %{value_formatted} macro..
xaxisLabelsFormattedThousandWhen using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro.,
xaxisLabelsFormattedUnitsPreWhen using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro.(an empty string)
xaxisLabelsFormattedUnitsPostWhen using formatted labels these are the units that are appended to the number with the %{value_formatted} macro.(an empty string)
xaxisLabelsHalignThe horizontal alignment of the labels.center
xaxisLabelsValignThe vertical alignment of the labels.top
xaxisLabelsAngleThe angle of the x-axis labels. For example, you could set this to 45 to get angled labels.0 (Horizontal)
xaxisLabelsPositionThis property controls how the labels are arranged - section for most chart types and edge for Line charts. You probably won't need to change this.section
xaxisLabelsClassThis property allows you to add your own css class to the x-axis labels which you can then use for styling purposes or to make retrieving the span tags easier (the dom elements). If you inspect the labels in your browser's javascript console (you will first need to enable the textAccessiblePointerevents property) you will be able to see the other css classes that are assigned to the labels.[none]
xaxisLabelsSpecificAlignThis determines the alignment of the specific labels. You probably won't need this.left
xaxisTitleThis allows you to specify a title for the x-axis.none
xaxisTitleSizeThis allows you to specify a size for the x-axis title.null
xaxisTitleFontThis allows you to specify a font for the x-axis title.null
xaxisTitleBoldThis controls whether the x-axis title is bold or not.null
xaxisTitleItalicThis controls whether the x-axis title is italic or not.null
xaxisTitleColorThis controls the color of the x-axis title.null
xaxisTitleXBy giving this you can specifically set the X coordinate of the x-axis title.null
xaxisTitleYBy giving this you can specifically set the Y coordinate of the x-axis title.null
xaxisTitleOffsetxThe horizontal offset that's applied to the title. 0
xaxisTitleOffsetyThe vertical offset that's applied to the title. 0
xaxisTitleHalignThe horizontal alignment of the title.center
xaxisTitleValignThe vertical alignment of the title.top
xaxisTitlePosThis is a multiplier (ie a digit usually between 0 and 1) that gets multiplied with the margin to get the Y position of the title.null
xaxis
Set this to true if you don't want an x-axis.
Default: true

xaxisPosition
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 yaxisScaleMax and yaxisScaleMin properties.
Default: bottom

xaxisLinewidth
The linewidth used for the x-axis and the x-axis tickmarks.
Default: 1

xaxisColor
The color of the x-axis (and its tickmarks.
Default: black

xaxisTickmarks
Whether the x-axis tickmarks are shown.
Default: true

xaxisTickmarksLastLeft
Whether the last tickmark on the left is displayed.
Default: null

xaxisTickmarksLastRight
Whether the last tickmark on the right is displayed.
Default: null

xaxisTickmarksLength
The length of the tickmarks.
Default: 3

xaxisTickmarksCount
The number of tickmarks that are shown on the x-axis.
Default: null

xaxisLabels
An array of the labels to be used on the chart. You can also give this option a string if you prefer and use formatted labels.
Default: An empty array

xaxisLabelsFont
The font used to render the labels.
Default: null

xaxisLabelsSize
The size of the labels.
Default: null

xaxisLabelsColor
The color of the labels.
Default: null

xaxisLabelsBold
Whether the labels are bold or not.
Default: null

xaxisLabelsItalic
Whether the labels are italic or not.
Default: null

xaxisLabelsOffsetx
This allows you finer-grained control in the horizontal direction over the X label positioning if you need it.
Default: 0

xaxisLabelsOffsety
This allows you finer-grained control in the vertical direction over the X label positioning if you need it.
Default: 0

xaxisLabelsFormattedDecimals
When using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro.
Default: 0

xaxisLabelsFormattedPoint
When using formatted labels this is the decimal point character that's used with the %{value_formatted} macro.
Default: .

xaxisLabelsFormattedThousand
When using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro.
Default: ,

xaxisLabelsFormattedUnitsPre
When using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro.
Default: (an empty string)

xaxisLabelsFormattedUnitsPost
When using formatted labels these are the units that are appended to the number with the %{value_formatted} macro.
Default: (an empty string)

xaxisLabelsHalign
The horizontal alignment of the labels.
Default: center

xaxisLabelsValign
The vertical alignment of the labels.
Default: top

xaxisLabelsAngle
The angle of the x-axis labels. For example, you could set this to 45 to get angled labels.
Default: 0 (Horizontal)

xaxisLabelsPosition
This property controls how the labels are arranged - section for most chart types and edge for Line charts. You probably won't need to change this.
Default: section

xaxisLabelsClass
This property allows you to add your own css class to the x-axis labels which you can then use for styling purposes or to make retrieving the span tags easier (the dom elements). If you inspect the labels in your browser's javascript console (you will first need to enable the textAccessiblePointerevents property) you will be able to see the other css classes that are assigned to the labels.
Default: [none]

xaxisLabelsSpecificAlign
This determines the alignment of the specific labels. You probably won't need this.
Default: left

xaxisTitle
This allows you to specify a title for the x-axis.
Default: none

xaxisTitleSize
This allows you to specify a size for the x-axis title.
Default: null

xaxisTitleFont
This allows you to specify a font for the x-axis title.
Default: null

xaxisTitleBold
This controls whether the x-axis title is bold or not.
Default: null

xaxisTitleItalic
This controls whether the x-axis title is italic or not.
Default: null

xaxisTitleColor
This controls the color of the x-axis title.
Default: null

xaxisTitleX
By giving this you can specifically set the X coordinate of the x-axis title.
Default: null

xaxisTitleY
By giving this you can specifically set the Y coordinate of the x-axis title.
Default: null

xaxisTitleOffsetx
The horizontal offset that's applied to the title.
Default: 0

xaxisTitleOffsety
The vertical offset that's applied to the title.
Default: 0

xaxisTitleHalign
The horizontal alignment of the title.
Default: center

xaxisTitleValign
The vertical alignment of the title.
Default: top

xaxisTitlePos
This is a multiplier (ie a digit usually between 0 and 1) that gets multiplied with the margin to get the Y position of the title.
Default: null

Y-axis properties

PropertyDescriptionDefault
yaxisWhether the y-axis is drawn.true
yaxisPositionSpecifies the y-axis position. Can be left or right.left
yaxisLinewidthThe linewidth of the y-axis.1
yaxisColorThe color of the y-axis.black
yaxisTickmarks.Whether the y-axis tickmarks are drawn.true
yaxisTickmarksLengthThe length of the y-axis tickmarks.3
yaxisTickmarksCountThis allows you to stipulate how many y-axis tickmarks there are.null (related to how many labels there are)
yaxisTickmarksLastTopWhether the top-most tickmark is drawn.null (displayed if the x-axis position warrants it)
yaxisTickmarksLastBottomWhether the bottom-most tickmark is drawn.null (displayed if the x-axis position warrants it)
yaxisLabelsCountA value that controls how many Y labels there are. This value could formerly be either 1/3/5/10 however now it can be any number.5
yaxisLabelsSpecificYou can use this option to give your own y-axis labels (eg ['Low', 'Medium', 'High']. Note: Since March 2013 you may now need to add an extra (optionally) empty element to the array of labels to achieve your desired result.null
yaxisLabelsPositionThis controls how the specific labels are positioned on the y-axis. It does not affect a scale.edge
yaxisLabelsOffsetxThis allows you finer-grained control in the horizontal direction over the Y label positioning if you need it. 0
yaxisLabelsOffsetyThis allows you finer-grained control in the vertical direction over the Y label positioning if you need it. 0
yaxisLabelsFontThe font that's used by the y-axis labels.null
yaxisLabelsSizeThe size of the y-axis labels.null
yaxisLabelsColorThe color of the y-axis labels.null
yaxisLabelsBoldWhether the y-axis labels are bold or not.null
yaxisLabelsItalicWhether the y-axis labels are italic or not.null
yaxisLabelsHalignThe horizontal alignment of the y-axis labels.null
yaxisLabelsValignThe vertical alignment of the y-axis labels.null
yaxisTitleThis allows you to specify a title for the y-axis.none
yaxisTitleSizeThis allows you to specify a size for the y-axis title.null
yaxisTitleFontThis allows you to specify a font for the y-axis title.null
yaxisTitleBoldThis controls whether the y-axis title is bold or not.null
yaxisTitleColorThis controls what color the y-axis title is.null
yaxisTitleItalicThis controls whether the y-axis title is italic or not.null
yaxisTitlePosThis is multiplied with the margin to give the position of the y-axis title.0.25
yaxisTitleOffsetxThe pixel offset that's added to the y-axis titles X coordinate. 0
yaxisTitleOffsetyThe pixel offset that's added to the y-axis titles Y coordinate. 0
yaxisTitleXBy giving this you can specifically set the X coordinate of the y-axis title.null
yaxisTitleYBy giving this you can specifically set the Y coordinate of the y-axis title.null
yaxisTitleHalignThe horizontal alignment of the y-axis title. 0
yaxisTitleValignThe vertical alignment of the y-axis title. 0
yaxisTitleAccessibleWith this property you can control whether the y-axis title is accessible or not.true
yaxisScaleWhether the y-axis scale is displayed or not.true
yaxisScaleRoundWhether the y-axis scale is rounded up or not.false
yaxisScaleUnitsPreThe units that the y-axis is measured in. This string is displayed before the actual number, allowing you to specify values such as $50.none
yaxisScaleUnitsPostThe units that the y-axis is measured in. This string is displayed after the actual number, allowing you to specify values such as 50ms.none
yaxisScaleMaxThe optional maximum Y scale value. If not specified then it will be calculated.null (It's calculated)
yaxisScaleMinThe optional minimum Y scale value. If not specified then it will be 0. 0
yaxisScaleFormatterTo allow thoroughly 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(opt)
{
    var num = Number(opt.number) * 5;

    return String(num)
}
obj.set('yaxisScaleFormatter', myFormatter);
null
yaxisScaleRoundWhether to round the scale up. eg A maximum value of 59 results in scale to 100.false
yaxisScaleDecimalsThe number of decimal places to display for the Y scale. 0
yaxisScalePointThe character that's used as the decimal point..
yaxisScaleThousandThe character that's used as the thousand separator.,
yaxisScaleInvertWhether the y-axis scale is inverted or not.false
yaxis
Whether the y-axis is drawn.
Default: true

yaxisPosition
Specifies the y-axis position. Can be left or right.
Default: left

yaxisLinewidth
The linewidth of the y-axis.
Default: 1

yaxisColor
The color of the y-axis.
Default: black

yaxisTickmarks.
Whether the y-axis tickmarks are drawn.
Default: true

yaxisTickmarksLength
The length of the y-axis tickmarks.
Default: 3

yaxisTickmarksCount
This allows you to stipulate how many y-axis tickmarks there are.
Default: null (related to how many labels there are)

yaxisTickmarksLastTop
Whether the top-most tickmark is drawn.
Default: null (displayed if the x-axis position warrants it)

yaxisTickmarksLastBottom
Whether the bottom-most tickmark is drawn.
Default: null (displayed if the x-axis position warrants it)

yaxisLabelsCount
A value that controls how many Y labels there are. This value could formerly be either 1/3/5/10 however now it can be any number.
Default: 5

yaxisLabelsSpecific
You can use this option to give your own y-axis labels (eg ['Low', 'Medium', 'High']. Note: Since March 2013 you may now need to add an extra (optionally) empty element to the array of labels to achieve your desired result.
Default: null

yaxisLabelsPosition
This controls how the specific labels are positioned on the y-axis. It does not affect a scale.
Default: edge

yaxisLabelsOffsetx
This allows you finer-grained control in the horizontal direction over the Y label positioning if you need it.
Default: 0

yaxisLabelsOffsety
This allows you finer-grained control in the vertical direction over the Y label positioning if you need it.
Default: 0

yaxisLabelsFont
The font that's used by the y-axis labels.
Default: null

yaxisLabelsSize
The size of the y-axis labels.
Default: null

yaxisLabelsColor
The color of the y-axis labels.
Default: null

yaxisLabelsBold
Whether the y-axis labels are bold or not.
Default: null

yaxisLabelsItalic
Whether the y-axis labels are italic or not.
Default: null

yaxisLabelsHalign
The horizontal alignment of the y-axis labels.
Default: null

yaxisLabelsValign
The vertical alignment of the y-axis labels.
Default: null

yaxisTitle
This allows you to specify a title for the y-axis.
Default: none

yaxisTitleSize
This allows you to specify a size for the y-axis title.
Default: null

yaxisTitleFont
This allows you to specify a font for the y-axis title.
Default: null

yaxisTitleBold
This controls whether the y-axis title is bold or not.
Default: null

yaxisTitleColor
This controls what color the y-axis title is.
Default: null

yaxisTitleItalic
This controls whether the y-axis title is italic or not.
Default: null

yaxisTitlePos
This is multiplied with the margin to give the position of the y-axis title.
Default: 0.25

yaxisTitleOffsetx
The pixel offset that's added to the y-axis titles X coordinate.
Default: 0

yaxisTitleOffsety
The pixel offset that's added to the y-axis titles Y coordinate.
Default: 0

yaxisTitleX
By giving this you can specifically set the X coordinate of the y-axis title.
Default: null

yaxisTitleY
By giving this you can specifically set the Y coordinate of the y-axis title.
Default: null

yaxisTitleHalign
The horizontal alignment of the y-axis title.
Default: 0

yaxisTitleValign
The vertical alignment of the y-axis title.
Default: 0

yaxisTitleAccessible
With this property you can control whether the y-axis title is accessible or not.
Default: true

yaxisScale
Whether the y-axis scale is displayed or not.
Default: true

yaxisScaleRound
Whether the y-axis scale is rounded up or not.
Default: false

yaxisScaleUnitsPre
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.
Default: none

yaxisScaleUnitsPost
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.
Default: none

yaxisScaleMax
The optional maximum Y scale value. If not specified then it will be calculated.
Default: null (It's calculated)

yaxisScaleMin
The optional minimum Y scale value. If not specified then it will be 0.
Default: 0

yaxisScaleFormatter
To allow thoroughly 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(opt)
{
    var num = Number(opt.number) * 5;

    return String(num)
}
obj.set('yaxisScaleFormatter', myFormatter);

Default: null

yaxisScaleRound
Whether to round the scale up. eg A maximum value of 59 results in scale to 100.
Default: false

yaxisScaleDecimals
The number of decimal places to display for the Y scale.
Default: 0

yaxisScalePoint
The character that's used as the decimal point.
Default: .

yaxisScaleThousand
The character that's used as the thousand separator.
Default: ,

yaxisScaleInvert
Whether the y-axis scale is inverted or not.
Default: false

Labels and text properties

PropertyDescriptionDefault
labelsAboveWhether the values are shown in labels drawn above the line.false
labelsAboveBoldWhether the labelsAbove labels are bold or not.null (defaults to the textBold setting)
labelsAboveItalicWhether the labelsAbove labels are italic or not.null (defaults to the textItalic setting)
labelsAboveSizeThe size of the labels that are drawn above the line.8
labelsAboveColorThe text color of the labels.Same as the textColor setting
labelsAboveFontThe font used to render the labels.Same as textFont
labelsAboveDecimalsThe number of decimals to fit the numbers to. If left unset decimals may still be shown (depending on your data) - but some numbers may have lots of decimals, some not so many and some none at all. It all depends on your data.null
labelsAbovePointThe decimal point character for the labels above labels..
labelsAboveThousandThe thousand separator character for the labels above labels.,
labelsAboveBackgroundThe background color of the labels.rgba(255,255,255,0.7)
labelsAboveBorderWhether the labels have a border or not.false
labelsAboveOffsetxThis allows you finer-grained control in the horizontal direction over the text positioning if you need it. 0
labelsAboveOffsetyThe vertical offset of the label from the point on the line.5
labelsAboveUnitsPreThe units that appear before the label.none
labelsAboveUnitsPostThe units that appear after the label.none
labelsAboveSpecificThis can be an array of (text) labels that you want to appear above the line instead of the values.null
labelsAboveFormatterThis can be a function that handles the formatting of the numbers. eg:
labelsAboveFormatter: function (opt)
{
    var obj     = opt.object,
        value   = opt.value,
        index   = opt.index,
        dataset = opt.dataset;

    return value;
}
null
labelsIngraphAn array of labels for the chart that are drawn "inside" the chart. If you have 5 data points then this should have a corresponding number of elements, though there is a shorthand available.null
labelsIngraphFontThe font that the ingraph labels are rendered in.null
labelsIngraphSizeThe size of the ingraph labels.null
labelsIngraphColorThe color of the ingraph labels.null
labelsIngraphBoldWhether the ingraph labels are bold or not.null
labelsIngraphItalicWhether the ingraph labels are italic or not.null
labelsIngraphOffsetxThis allows you finer-grained control in the horizontal direction over the text positioning if you need it. 0
labelsIngraphOffsetyThis allows you finer-grained control in the vertical direction over the text positioning if you need it. 0
textSizeThe size of the text (in points).12
textFontThe font used to render the text.Arial
textColorThe color of the labels.black
textBoldThe color of the labels.black
textItalicThe color of the labels.black
textAccessibleA new feature in 2016 that allows you to use dom text in place of canvas text. It makes for a 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:
<div style="margin-left: 50px; display: inline-block">
    <canvas id="cvs" width="650" height="250"></canvas>
</div>
false
textAccessibleOverflowThis 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 margins if you wish.visible
textAccessiblePointereventsThis controls whether the dom text responds to mouse-based events or not (it sets the pointer-events css property to none).true
labelsAngledWhether angled labels are enabled or not. These labels are drawn above the line, not the points that the line connects. You can have different text styles for up, down and level labels. All of the text configuration properties eventually fall back to the text* text styles. The property should be an array that contains three strings - the label for up, the label for down and the label for level, like this: labelsAngled: ["Up label", "Down label", "Level label"] However, if you're also setting the labelsAngledSpecific property then this can simply be set to true.false
labelsAngledSpecificUse this property to specify the exact labels that are spread across the line. This should be one less label than the number of points on your line. If you set this the labelsAngled property can be just set to true.null
labelsAngledAccessibleUse this to set whether the labelsAbove labels should be drawn using accessible text (the default) or by using native canvas text. When the chart has the adjustable property enabled the labelsAngled labels are always drawn using native canvas text.null
labelsAngledFontThe font used by the labelsAngled labels. If not specified this falls back to the textFont property. null
labelsAngledColorThe color used by the labelsAngled labels. If not specified this falls back to the textColor property. null
labelsAngledSizeThe size used by the labelsAngled labels. If not specified this falls back to the textSize property. null
labelsAngledBoldWhether the labelsAbove labels are bold or not. If not specified this falls back to the textBold property. null
labelsAngledItalicWhether the labelsAbove labels are italic or not. If not specified this falls back to the textItalic property.null
labelsAngledUpFontThe font used by the labelsAngled labels that have an upward direction. If not specified this falls back to the labelsAngledFont property. null
labelsAngledUpColorThe color used by the labelsAngled labels that have an upward direction. If not specified this falls back to the labelsAngledColor property. null
labelsAngledUpSizeThe size used by the labelsAngled labels that have an upward direction. If not specified this falls back to the labelsAngledSize property. null
labelsAngledUpBoldWhether the labelsAbove labels are bold or not when the labels have an upward direction. If not specified this falls back to the labelsAngledBold property. null
labelsAngledUpItalicWhether the labelsAbove labels are italic or not when the labels have an upward direction. If not specified this falls back to the labelsAngledItalic property. null
labelsAngledDownFontThe font used by the labelsAngled labels that have a downward direction. If not specified this falls back to the labelsAngledFont property. null
labelsAngledDownColorThe color used by the labelsAngled labels that have a downward direction. If not specified this falls back to the labelsAngledColor property. null
labelsAngledDownSizeThe size used by the labelsAngled labels that have a downward direction. If not specified this falls back to the labelsAngledSize property. null
labelsAngledDownBoldWhether the labelsAbove labels are bold or not when the labels have a downward direction. If not specified this falls back to the labelsAngledBold property. null
labelsAngledDownItalicWhether the labelsAbove labels are italic or not when the labels have a downward direction. If not specified this falls back to the labelsAngledItalic property. null
labelsAngledLevelFontThe font used by the labelsAngled labels that are level (not upward and not downward). If not specified this falls back to the labelsAngledFont property. null
labelsAngledLevelColorThe color used by the labelsAngled labels that are level (not upward and not downward). If not specified this falls back to the labelsAngledColor property. null
labelsAngledLevelSizeThe size used by the labelsAngled labels that are level (not upward and not downward). If not specified this falls back to the labelsAngledSize property. null
labelsAngledLevelBoldWhether the labelsAbove labels are bold or not when the labels are level (not upward and not downward). If not specified this falls back to the labelsAngledBold property. null
labelsAngledLevelItalicWhether the labelsAbove labels are italic or not when the labels are level (not upward and not downward). If not specified this falls back to the labelsAngledItalic property. null
textThis allows you to add custom text to your chart if you want to. There's a dedicated page that describes this option here.null
labelsAbove
Whether the values are shown in labels drawn above the line.
Default: false

labelsAboveBold
Whether the labelsAbove labels are bold or not.
Default: null (defaults to the textBold setting)

labelsAboveItalic
Whether the labelsAbove labels are italic or not.
Default: null (defaults to the textItalic setting)

labelsAboveSize
The size of the labels that are drawn above the line.
Default: 8

labelsAboveColor
The text color of the labels.
Default: Same as the textColor setting

labelsAboveFont
The font used to render the labels.
Default: Same as textFont

labelsAboveDecimals
The number of decimals to fit the numbers to. If left unset decimals may still be shown (depending on your data) - but some numbers may have lots of decimals, some not so many and some none at all. It all depends on your data.
Default: null

labelsAbovePoint
The decimal point character for the labels above labels.
Default: .

labelsAboveThousand
The thousand separator character for the labels above labels.
Default: ,

labelsAboveBackground
The background color of the labels.
Default: rgba(255,255,255,0.7)

labelsAboveBorder
Whether the labels have a border or not.
Default: false

labelsAboveOffsetx
This allows you finer-grained control in the horizontal direction over the text positioning if you need it.
Default: 0

labelsAboveOffsety
The vertical offset of the label from the point on the line.
Default: 5

labelsAboveUnitsPre
The units that appear before the label.
Default: none

labelsAboveUnitsPost
The units that appear after the label.
Default: none

labelsAboveSpecific
This can be an array of (text) labels that you want to appear above the line instead of the values.
Default: null

labelsAboveFormatter
This can be a function that handles the formatting of the numbers. eg:
labelsAboveFormatter: function (opt)
{
    var obj     = opt.object,
        value   = opt.value,
        index   = opt.index,
        dataset = opt.dataset;

    return value;
}

Default: null

labelsIngraph
An array of labels for the chart that are drawn "inside" the chart. If you have 5 data points then this should have a corresponding number of elements, though there is a shorthand available.
Default: null

labelsIngraphFont
The font that the ingraph labels are rendered in.
Default: null

labelsIngraphSize
The size of the ingraph labels.
Default: null

labelsIngraphColor
The color of the ingraph labels.
Default: null

labelsIngraphBold
Whether the ingraph labels are bold or not.
Default: null

labelsIngraphItalic
Whether the ingraph labels are italic or not.
Default: null

labelsIngraphOffsetx
This allows you finer-grained control in the horizontal direction over the text positioning if you need it.
Default: 0

labelsIngraphOffsety
This allows you finer-grained control in the vertical direction over the text positioning if you need it.
Default: 0

textSize
The size of the text (in points).
Default: 12

textFont
The font used to render the text.
Default: Arial

textColor
The color of the labels.
Default: black

textBold
The color of the labels.
Default: black

textItalic
The color of the labels.
Default: black

textAccessible
A new feature in 2016 that allows you to use dom text in place of canvas text. It makes for a 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:
<div style="margin-left: 50px; display: inline-block">
    <canvas id="cvs" width="650" height="250"></canvas>
</div>

Default: false

textAccessibleOverflow
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 margins if you wish.
Default: visible

textAccessiblePointerevents
This controls whether the dom text responds to mouse-based events or not (it sets the pointer-events css property to none).
Default: true

labelsAngled
Whether angled labels are enabled or not. These labels are drawn above the line, not the points that the line connects. You can have different text styles for up, down and level labels. All of the text configuration properties eventually fall back to the text* text styles. The property should be an array that contains three strings - the label for up, the label for down and the label for level, like this: labelsAngled: ["Up label", "Down label", "Level label"] However, if you're also setting the labelsAngledSpecific property then this can simply be set to true.
Default: false

labelsAngledSpecific
Use this property to specify the exact labels that are spread across the line. This should be one less label than the number of points on your line. If you set this the labelsAngled property can be just set to true.
Default: null

labelsAngledAccessible
Use this to set whether the labelsAbove labels should be drawn using accessible text (the default) or by using native canvas text. When the chart has the adjustable property enabled the labelsAngled labels are always drawn using native canvas text.
Default: null

labelsAngledFont
The font used by the labelsAngled labels. If not specified this falls back to the textFont property.
Default: null

labelsAngledColor
The color used by the labelsAngled labels. If not specified this falls back to the textColor property.
Default: null

labelsAngledSize
The size used by the labelsAngled labels. If not specified this falls back to the textSize property.
Default: null

labelsAngledBold
Whether the labelsAbove labels are bold or not. If not specified this falls back to the textBold property.
Default: null

labelsAngledItalic
Whether the labelsAbove labels are italic or not. If not specified this falls back to the textItalic property.
Default: null

labelsAngledUpFont
The font used by the labelsAngled labels that have an upward direction. If not specified this falls back to the labelsAngledFont property.
Default: null

labelsAngledUpColor
The color used by the labelsAngled labels that have an upward direction. If not specified this falls back to the labelsAngledColor property.
Default: null

labelsAngledUpSize
The size used by the labelsAngled labels that have an upward direction. If not specified this falls back to the labelsAngledSize property.
Default: null

labelsAngledUpBold
Whether the labelsAbove labels are bold or not when the labels have an upward direction. If not specified this falls back to the labelsAngledBold property.
Default: null

labelsAngledUpItalic
Whether the labelsAbove labels are italic or not when the labels have an upward direction. If not specified this falls back to the labelsAngledItalic property.
Default: null

labelsAngledDownFont
The font used by the labelsAngled labels that have a downward direction. If not specified this falls back to the labelsAngledFont property.
Default: null

labelsAngledDownColor
The color used by the labelsAngled labels that have a downward direction. If not specified this falls back to the labelsAngledColor property.
Default: null

labelsAngledDownSize
The size used by the labelsAngled labels that have a downward direction. If not specified this falls back to the labelsAngledSize property.
Default: null

labelsAngledDownBold
Whether the labelsAbove labels are bold or not when the labels have a downward direction. If not specified this falls back to the labelsAngledBold property.
Default: null

labelsAngledDownItalic
Whether the labelsAbove labels are italic or not when the labels have a downward direction. If not specified this falls back to the labelsAngledItalic property.
Default: null

labelsAngledLevelFont
The font used by the labelsAngled labels that are level (not upward and not downward). If not specified this falls back to the labelsAngledFont property.
Default: null

labelsAngledLevelColor
The color used by the labelsAngled labels that are level (not upward and not downward). If not specified this falls back to the labelsAngledColor property.
Default: null

labelsAngledLevelSize
The size used by the labelsAngled labels that are level (not upward and not downward). If not specified this falls back to the labelsAngledSize property.
Default: null

labelsAngledLevelBold
Whether the labelsAbove labels are bold or not when the labels are level (not upward and not downward). If not specified this falls back to the labelsAngledBold property.
Default: null

labelsAngledLevelItalic
Whether the labelsAbove labels are italic or not when the labels are level (not upward and not downward). If not specified this falls back to the labelsAngledItalic property.
Default: null

text
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

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 size of the horizontal margin. This is on the inside of the axes. 0
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 size of the horizontal margin. This is on the inside of the axes.
Default: 0

Color properties

PropertyDescriptionDefault
colorsAn array of line colors.['#f00', '#0f0', '', '#00f', '#f0f', '#ff0', '#0ff']
colorsAlternateSet this to true if you want your line color(s) to be alternated.false
filledWhether the area under the line is filled or not. This looks best when there is no horizontal margin.

Note: When showing multiple lines the values are additive by default. This means that if you have two lines they will be "stacked" on top of each other. If this is not the desired behaviour then you can set the option below to false.
false
filledColorsA single color or an array of colors that filled Line charts will use.

Important: This used to be a string, and still can be, but can now also be an array.
null
filledAccumulativeWhen showing multiple filled lines the values are by default accumulative (ie added to each other). If this is not the desired behaviour, then you can set this property to false to have them drawn "non-accumulatively".

Note: If you use fully opaque colors in conjunction with this option set to false it's feasible that you might not see one or more of the lines or parts of the line. If you want to see all of the lines you should leave this option set to its default true setting. You can see an example of this setting here.

true
filledRangeThis is useful for indicating a range. Exactly two datasets are required, with the space between them filled. This is useful for indicating a range.false
filledRangeThresholdWhen drawing a filled range chart you set a threshold in the case where you want the range to be one color above the threshold and another below.null
filledRangeThresholdColorsThis is a two-element array that defines the colors when using a dual-color range chart. There's an example of the dual-color range chart in the download archive (line-dual-color-range.html).['red', 'green']
colors
An array of line colors.
Default: ['#f00', '#0f0', '', '#00f', '#f0f', '#ff0', '#0ff']

colorsAlternate
Set this to true if you want your line color(s) to be alternated.
Default: false

filled
Whether the area under the line is filled or not. This looks best when there is no horizontal margin.

Note: When showing multiple lines the values are additive by default. This means that if you have two lines they will be "stacked" on top of each other. If this is not the desired behaviour then you can set the option below to false.
Default: false

filledColors
A single color or an array of colors that filled Line charts will use.

Important: This used to be a string, and still can be, but can now also be an array.
Default: null

filledAccumulative
When showing multiple filled lines the values are by default accumulative (ie added to each other). If this is not the desired behaviour, then you can set this property to false to have them drawn "non-accumulatively".

Note: If you use fully opaque colors in conjunction with this option set to false it's feasible that you might not see one or more of the lines or parts of the line. If you want to see all of the lines you should leave this option set to its default true setting. You can see an example of this setting here.


Default: true

filledRange
This is useful for indicating a range. Exactly two datasets are required, with the space between them filled. This is useful for indicating a range.
Default: false

filledRangeThreshold
When drawing a filled range chart you set a threshold in the case where you want the range to be one color above the threshold and another below.
Default: null

filledRangeThresholdColors
This is a two-element array that defines the colors when using a dual-color range chart. There's an example of the dual-color range chart in the download archive (line-dual-color-range.html).
Default: ['red', 'green']

Shadow properties

PropertyDescriptionDefault
shadowWhether a drop shadow is applied.false
shadowColorThe color of the shadow.rgba(0,0,0,0.5)
shadowOffsetxThe horizontal offset of the shadow.2
shadowOffsetyThe vertical offset of the shadow.2
shadowBlurThe severity of the shadow blurring effect.3
shadow
Whether a drop shadow is applied.
Default: false

shadowColor
The color of the shadow.
Default: rgba(0,0,0,0.5)

shadowOffsetx
The horizontal offset of the shadow.
Default: 2

shadowOffsety
The vertical offset of the shadow.
Default: 2

shadowBlur
The severity of the shadow blurring effect.
Default: 3

Interactive features properties

PropertyDescriptionDefault
tooltipsA numerically indexed array of tooltips that are shown when a bar is clicked. These can contain html.An empty array
tooltipsEffectThe effect used for showing tooltips. Possible values are slide fade or none.slide
tooltipsOverrideIf 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.null
tooltipsHighlightSet this to false if you don't want your charts to be highlighted.true
tooltipsHotspotXonlySet this to true if you want the tooltips to be triggered by the mouse X position only.false
tooltipsHotspotSizeThe size of the hotspot area for tooltips.5
tooltipsHotspotIgnoreThis can be a number of things and can be used to ignore certain tooltip hotspots - which can allow charts to the rear to be clickable. There's an example of this in the download archive called pie-tooltipshotspotignore.html. You can use the transparent color to allow the rear chart to be seen in such a case. It can be:
  • A single boolean value (ie true or false) to enable or disable all of the hotspots - true means the hotspot will be ignored
  • A single number (the zero-indexed number corresponding to the hotspot to ignore)
  • An array of numbers (the numbers are the indexes of hotspots to ignore)
  • An array of boolean true or false values - the position of these values correspond to the index(es) of the segments to ignore (for example [false, false, true, false, false] - true means the corresponding hotspot will be ignored)
null
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)
tooltipsFormattedKeyColorsWhen using formatted tooltip strings you can give specific colors for the %{key} option to use.null
tooltipsFormattedKeyColorsShapeThis is the shape that's used in the tooltip key. It can be square or circlesquare
tooltipsFormattedKeyColorsCss 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";
}
null
tooltipsFormattedKeyLabelsWhen using formatted tooltip strings these are the labels that are displayed.[] (an empty array)
tooltipsFormattedListTypeWith this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol.ul
tooltipsFormattedListItemsThis 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 css to style this list - for example:
.RGraph_tooltip ul#rgraph_formatted_tooltips_list li {
    text-align: left;
    color: yellow;
}
null
tooltipsFormattedTableHeadersWhen 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.null
tooltipsFormattedTableDataThis 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, copy the code from it and then modify it suit. You'll create fewer bugs this way.null)
tooltipsPointerBy 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.true
tooltipsPointerCssIf 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:
tooltipsPointerCss: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}
null
tooltipsPointerOffsetxThis allows you to adjust the vertical position of the tooltips pointer. 0
tooltipsPointerOffsetyThis allows you to adjust the vertical position of the tooltips pointer (for example, if you add a border you may need to move it down slightly). 0
tooltipsPositionStaticThe 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.true
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'
}
null
tooltipsCssClassThis is the name of the css class the chart uses.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
tooltipsDatasetInstead of having one tooltip for each point on your chart you can use this property to have an array of one tooltip per line (you can also set this to a string and use tooltip templates - the demo in the download archive shows this). So if you have four lines you can set this to an array of four strings - one for each line. You can click anywhere on the line to see it. There's a demo in the download archive called line-tooltips-dataset.html If you have multiple lines on your chart and want to get the index of the dataset that has been clicked, you can do so with the property obj.tooltipsDatasetIndex - this is also shown in the demo in the download archive.null
tooltipsDatasetEventThis can be set to click or mousemove and determines which event causes the tooltip to be shown.click
crosshairsIf true, you will get crosshairs centered on the current mouse position.false
crosshairsLinewidthThis controls the linewidth of the crosshairs.1
crosshairsColorThe color of the crosshairs.#333
crosshairsHlineThis determines whether the horizontal crosshair is shown.true
crosshairsVlineThis determines whether the vertical crosshair is shown.true
contextmenuAn array of context menu items. More information about context menus is here.[] (An empty array)
annotatableWhether annotations are enabled for the chart (ie you can draw on the chart interactively.false
annotatableColorIf you do not allow the use of the palette, then this will be the only color allowed for annotations.black
annotatableLinewidthThis is the linewidth of the annotations.1
adjustableDefaulting to false, this determines whether your Line chart will be adjustable.false
adjustableOnlyThis should be an array of values that determine whether a point is adjustable or not. A truthy value for when it is, a falsey value for when it's not.null
adjustableXonlyIf you set this to true then only the X coordinate will be taken into account when determining whether an adjusting hotspot was clicked. This option can be useful when you're using the adjusting feature on a touch device. The tooltipsHotspotSize is used to determine the size of the touch hotspot. Due to how things work - only a single dataset is supported with one-touch adjusting.false
tooltips
A numerically indexed array of tooltips that are shown when a bar is clicked. These can contain html.
Default: An empty array

tooltipsEffect
The effect used for showing tooltips. Possible values are slide fade or none.
Default: slide

tooltipsOverride
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.
Default: null

tooltipsHighlight
Set this to false if you don't want your charts to be highlighted.
Default: true

tooltipsHotspotXonly
Set this to true if you want the tooltips to be triggered by the mouse X position only.
Default: false

tooltipsHotspotSize
The size of the hotspot area for tooltips.
Default: 5

tooltipsHotspotIgnore
This can be a number of things and can be used to ignore certain tooltip hotspots - which can allow charts to the rear to be clickable. There's an example of this in the download archive called pie-tooltipshotspotignore.html. You can use the transparent color to allow the rear chart to be seen in such a case. It can be:
  • A single boolean value (ie true or false) to enable or disable all of the hotspots - true means the hotspot will be ignored
  • A single number (the zero-indexed number corresponding to the hotspot to ignore)
  • An array of numbers (the numbers are the indexes of hotspots to ignore)
  • An array of boolean true or false values - the position of these values correspond to the index(es) of the segments to ignore (for example [false, false, true, false, false] - true means the corresponding hotspot will be ignored)

Default: null

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)

tooltipsFormattedKeyColors
When using formatted tooltip strings you can give specific colors for the %{key} option to use.
Default: null

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

tooltipsFormattedKeyColorsCss
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

tooltipsFormattedKeyLabels
When using formatted tooltip strings these are the labels that are displayed.
Default: [] (an empty array)

tooltipsFormattedListType
With this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol.
Default: ul

tooltipsFormattedListItems
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 css to style this list - for example:
.RGraph_tooltip ul#rgraph_formatted_tooltips_list li {
    text-align: left;
    color: yellow;
}

Default: null

tooltipsFormattedTableHeaders
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

tooltipsFormattedTableData
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, copy the code from it and then modify it suit. You'll create fewer bugs this way.
Default: null)

tooltipsPointer
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

tooltipsPointerCss
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:
tooltipsPointerCss: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}

Default: null

tooltipsPointerOffsetx
This allows you to adjust the vertical position of the tooltips pointer.
Default: 0

tooltipsPointerOffsety
This allows you to adjust the vertical position of the tooltips pointer (for example, if you add a border you may need to move it down slightly).
Default: 0

tooltipsPositionStatic
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

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'
}

Default: null

tooltipsCssClass
This is the name of the css class the chart uses.
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

tooltipsDataset
Instead of having one tooltip for each point on your chart you can use this property to have an array of one tooltip per line (you can also set this to a string and use tooltip templates - the demo in the download archive shows this). So if you have four lines you can set this to an array of four strings - one for each line. You can click anywhere on the line to see it. There's a demo in the download archive called line-tooltips-dataset.html If you have multiple lines on your chart and want to get the index of the dataset that has been clicked, you can do so with the property obj.tooltipsDatasetIndex - this is also shown in the demo in the download archive.
Default: null

tooltipsDatasetEvent
This can be set to click or mousemove and determines which event causes the tooltip to be shown.
Default: click

crosshairs
If true, you will get crosshairs centered on the current mouse position.
Default: false

crosshairsLinewidth
This controls the linewidth of the crosshairs.
Default: 1

crosshairsColor
The color of the crosshairs.
Default: #333

crosshairsHline
This determines whether the horizontal crosshair is shown.
Default: true

crosshairsVline
This determines whether the vertical crosshair is shown.
Default: true

contextmenu
An array of context menu items. More information about context menus is here.
Default: [] (An empty array)

annotatable
Whether annotations are enabled for the chart (ie you can draw on the chart interactively.
Default: false

annotatableColor
If you do not allow the use of the palette, then this will be the only color allowed for annotations.
Default: black

annotatableLinewidth
This is the linewidth of the annotations.
Default: 1

adjustable
Defaulting to false, this determines whether your Line chart will be adjustable.
Default: false

adjustableOnly
This should be an array of values that determine whether a point is adjustable or not. A truthy value for when it is, a falsey value for when it's not.
Default: null

adjustableXonly
If you set this to true then only the X coordinate will be taken into account when determining whether an adjusting hotspot was clicked. This option can be useful when you're using the adjusting feature on a touch device. The tooltipsHotspotSize is used to determine the size of the touch hotspot. Due to how things work - only a single dataset is supported with one-touch adjusting.
Default: false

Title properties

PropertyDescriptionDefault
titleThe title of the chart, if any.null
titleFontThe font that the title is rendered in. If not specified the textFont setting is used (usually Arial).null
titleSizeThe size of the title. If not specified the size is usually 4pt bigger than the textSize setting.null
titleBoldWhether the title is bold or not.null
titleItalicWhether the title is italic or not.null
titleColorThe color of the title.null
titleXTo give the exact X coordinate for the title - use this. This can also be a string like this: "-5" - in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.null
titleYTo give the exact Y coordinate for the title - use this. This can also be a string like this: "-5" - in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.null
titleHalignThe horizontal alignment of the title.center (can change depending on other options)
titleValignThe vertical alignment of the title.center (can change depending on other options)
titleOffsetxYou can use this property to adjust the positioning of the title in the horizontal direction (positive values adjust the title to the right and negative values adjust it to the left). 0
titleOffsetyYou can use this property to adjust the positioning of the title in the vertical direction (positive values adjust the title downwards and negative values adjust it upwards). 0
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.null
titleSubtitleSizeThe size of the font used to render the subtitle.null
titleSubtitleColorThe color of the subtitle.#aaa
titleSubtitleFontThe font used to render the subtitle.null
titleSubtitleBoldWhether the subtitle is bold or not.null
titleSubtitleItalicWhether the subtitle is italic or not.null
titleSubtitleOffsetxUse this property to adjust the horizontal position of the subtitle. 0
titleSubtitleOffsetyUse this property to adjust the vertical position of the subtitle. 0
title
The title of the chart, if any.
Default: null

titleFont
The font that the title is rendered in. If not specified the textFont setting is used (usually Arial).
Default: null

titleSize
The size of the title. If not specified the size is usually 4pt bigger than the textSize setting.
Default: null

titleBold
Whether the title is bold or not.
Default: null

titleItalic
Whether the title is italic or not.
Default: null

titleColor
The color of the title.
Default: null

titleX
To give the exact X coordinate for the title - use this. This can also be a string like this: "-5" - in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.
Default: null

titleY
To give the exact Y coordinate for the title - use this. This can also be a string like this: "-5" - in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.
Default: null

titleHalign
The horizontal alignment of the title.
Default: center (can change depending on other options)

titleValign
The vertical alignment of the title.
Default: center (can change depending on other options)

titleOffsetx
You can use this property to adjust the positioning of the title in the horizontal direction (positive values adjust the title to the right and negative values adjust it to the left).
Default: 0

titleOffsety
You can use this property to adjust the positioning of the title in the vertical direction (positive values adjust the title downwards and negative values adjust it upwards).
Default: 0

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

titleSubtitleSize
The size of the font used to render the subtitle.
Default: null

titleSubtitleColor
The color of the subtitle.
Default: #aaa

titleSubtitleFont
The font used to render the subtitle.
Default: null

titleSubtitleBold
Whether the subtitle is bold or not.
Default: null

titleSubtitleItalic
Whether the subtitle is italic or not.
Default: null

titleSubtitleOffsetx
Use this property to adjust the horizontal position of the subtitle.
Default: 0

titleSubtitleOffsety
Use this property to adjust the vertical position of the subtitle.
Default: 0

Trend line properties

PropertyDescriptionDefault
trendlineIf 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.false
trendlineColorsUse this property to specify either a single color or an array of colors for the trend line(s).[#666]
trendlineLinewidthUse 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.1
trendlineMarginUse 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.25
trendlineDashedIf 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.false
trendlineDottedIf 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.false
trendlineDashArrayIf 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] ]null
trendlineClipDefaulting 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 which is (by default) covered by the background grid.true
trendline
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

trendlineColors
Use this property to specify either a single color or an array of colors for the trend line(s).
Default: [#666]

trendlineLinewidth
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

trendlineMargin
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

trendlineDashed
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

trendlineDotted
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

trendlineDashArray
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

trendlineClip
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 which is (by default) covered by the background grid.
Default: true

Null value properties

PropertyDescriptionDefault
nullBridgeIf you prefer, then RGraph can span the gaps in your line that are present due to there being null values in your data.false
nullBridgeLinewidthTo 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.null
nullBridgeColorsTo 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.null
nullBridgeDashArrayBy 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][5,5]
nullBridge
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

nullBridgeLinewidth
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

nullBridgeColors
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

nullBridgeDashArray
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]

Key properties

key properties are documented on the key documentation page.

Miscellaneous properties

PropertyDescriptionDefault
tickmarksStyleWhat kind of tickmarks to use on the chart. This can be:
  • circle
  • filledcircle
  • endcircle
  • filledendcircle
  • square
  • endsquare
  • filledsquare
  • filledendsquare
  • diamond
  • enddiamond
  • filleddiamond
  • filledenddiamond
  • tick
  • halftick
  • endtick
  • cross
  • dot
  • borderedcircle (same as dot)
  • arrow
  • filledarrow
  • triangle
  • filledtriangle

Note that arrow and filledarrow look better with a thinner (1 or 2) linewidth setting.

Also note that as well as a string, this can be an array of different tickmark styles.

This can be a function in case you want to draw your own style of tickmark or, as in the example shown here, to only draw certain tickmarks. The function shown below only draws every other tickmark (which may be useful on smaller displays).

// Add a custom tickmark - just a regular circle
// but only drawn on every second point
tickmarksStyle: function (obj, dataset, value, index, x, y, color, prevX, prevY)
{
    if (index % 2 === 0) {
        obj.path(
            "b a % % % % % false f red",
            x, y, 7, 0, 6.29
        );
    }
}


As of August 2014, this can be a location/URL of an image file to use as the tickmarks or a data: URL. See below for details.
null
tickmarksSizeThe size of the tickmarks.3
tickmarksColorThe color of the tickmarks. If null then it will default to the same color as the line.null
tickmarksStyleDotStrokeThis is the color of the filled part of the dot/borderedcircle style tickmarks.null (defaults to the line color)
tickmarksStyleDotFillThis is the color of the stroked part of the dot/borderedcircle style tickmarks.null (defaults to the line color)
tickmarksStyleDotLinewidthThis is the width of the line used when drawing the tickmarks. 0
tickmarksStyleImageHalignThis can be left right or center and determines the horizontal alignment of the tickmark.center
tickmarksStyleImageValignThis can be top bottom or center and determines the vertical alignment of the tickmark.center
tickmarksStyleImageOffsetxAfter the alignment has been applied, this is added to the X coordinate of the tickmark. 0
tickmarksStyleImageOffsetyAfter the alignment has been applied, this is added to the Y coordinate of the tickmark. 0
steppedDraws the line as stepped. Useful for showing stock performance for example.false
linewidthThe width of the line (ie the line on the chart). Note: If your line is stepped and filled, and you don't want a trailing line indicating the last value, you can set this to zero.1
linecapThis property allows you to set the style for the context.lineCap setting. 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 will need to set this to butt.round
linejoinThis property allows you to set the style for the context.lineJoin setting. 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.round
animationUnfoldXThis is used by the unfold Line chart animation and dictates whether the X value is unfolded.false
animationUnfoldYThis is used by the unfold Line chart animation and dictates whether the Y value is unfolded.true
animationUnfoldInitialThis property can be used to set the initial factor for the unfold animation. Setting this to a value less than one will cause the line to expand outwards, whilst a value greater than one will cause the line to contract towards the correct values.2
highlightStyleBy 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. It's passed the shape object as an argument. As of June 2016, you can also set this to halo to get a new style of highlighting. As of version 5.23 you can also set this to invert. If you do this on a dark background you may find that you need to change the highlightFill color setting as well.null
highlightStrokeIf you use tooltips, this controls the color of the highlight stroke.black
highlightFillIf you use tooltips, this controls the color of the highlight fill.rgba(255,255,255,0.5)
highlightPointRadiusThis sets the size of the highlight.2
highlightDatasetWhether dataset highlighting should be enabled. If enabled you can click on a dataset (ie a line) and it will be highlighted. If you add a callback function it will run that function for you. There are demos in the download archive which show this called:
  • line-highlight-dataset1.html
  • line-highlight-dataset2.html
  • line-highlight-dataset3.html
  • line-highlight-dataset4.html
  • line-highlight-dataset5.html
  • line-highlight-dataset6.html
  • line-highlight-dataset7.html
  • line-nvd.html
  • line-nvd-single-object.html
false
highlightDatasetStrokeThe stroke color of the highlight. This can be an array of colors for when you have multiple datasets and want to use a different highlight for each one.rgba(0,0,0,0.25)
highlightDatasetFillThe fill color of the highlight. This can be an array of colors for when you have multiple datasets and want to use a different highlight for each one.rgba(255,255,255,0.75)
highlightDatasetStrokeUseColorsYou can set this to true in order to use the same colors as the colors property.false
highlightDatasetFillUseColorsYou can set this to true in order to use the same colors as the colors property.false
highlightDatasetStrokeAlphaThis allows you to specify an alpha value (the opacity) for the stroke color.1
highlightDatasetFillAlphaThis allows you to specify an alpha value (the opacity) for the fill color.1
highlightDatasetLinewidthThe linewidth of the highlight stroke. By default this will match the linewidth of the line.null
highlightDatasetDashedIf enabled then the highlight stroke will be dashed.false
highlightDatasetDottedIf enabled then the highlight stroke will be dotted.false
highlightDatasetDashArrayIf this is set to an array of two numbers it will be used as the linedash setting.null
highlightDatasetCallbackYou can set this to a function that will be run when a dataset is highlighted (ie when it's clicked on). It's passed an object containing one property - dataset - which is the index of the dataset that has been clicked.null
highlightDatasetExcludeIf there are datasets that you don't want to be highlighted then you can include the index of the dataset here. It can either be a number or an array of numbers.null
highlightDatasetEventThis is the event that triggers the dataset highlighting. It defaults to click but can also be mousemove.click
splineThis option causes the line to be drawn as a spline - ie curvy. Not all options will work with the spline option - however, the introduction of real spline curves over the previous curvy option is a significant improvement. There are numerous examples of this in the demos that are included in the download file. null values will not work with the spline option.false
cleartoThis is used in animations and effects as the default color to use when the canvas.null
combinedEffectSet this to the name of an effect (eg grow ) and the CombinedChart object will use that effect to draw the chart instead of the regular draw function.null
combinedEffectOptionsThis should be a string that contains a javascript object of options for the effect function like this:
combinedchartEffectOptions: '{frames: 300}'
It has to be a string because of a quirk of the option parsing system.
null
combinedEffectCallbackA function that runs when this objects effect has finished.null
dottedWhether the line (not the background grid) is dotted or not. This is a new addition in January 2017.false
dashedWhether the line (not the background grid) is dashed or not. This is a new addition in January 2017.false
outofboundsNormally, out-of-bounds values are not drawn. By setting this to true you can change this behaviour.false
outofboundsClipIf you've enabled the outofbounds option but you're not interested in seeing the bits which fall outside of the chart area (eg in the margins) then you can enable this option. There's a demo of the outofboundsClip option in the download archive (line-overflow-clipped.html).false
horizontalLines 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/left-margin/right-margin 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;
        //}
    }
]);
null
responsiveThis 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.null
tickmarksStyle
What kind of tickmarks to use on the chart. This can be:
  • circle
  • filledcircle
  • endcircle
  • filledendcircle
  • square
  • endsquare
  • filledsquare
  • filledendsquare
  • diamond
  • enddiamond
  • filleddiamond
  • filledenddiamond
  • tick
  • halftick
  • endtick
  • cross
  • dot
  • borderedcircle (same as dot)
  • arrow
  • filledarrow
  • triangle
  • filledtriangle

Note that arrow and filledarrow look better with a thinner (1 or 2) linewidth setting.

Also note that as well as a string, this can be an array of different tickmark styles.

This can be a function in case you want to draw your own style of tickmark or, as in the example shown here, to only draw certain tickmarks. The function shown below only draws every other tickmark (which may be useful on smaller displays).

// Add a custom tickmark - just a regular circle
// but only drawn on every second point
tickmarksStyle: function (obj, dataset, value, index, x, y, color, prevX, prevY)
{
    if (index % 2 === 0) {
        obj.path(
            "b a % % % % % false f red",
            x, y, 7, 0, 6.29
        );
    }
}


As of August 2014, this can be a location/URL of an image file to use as the tickmarks or a data: URL. See below for details.
Default: null

tickmarksSize
The size of the tickmarks.
Default: 3

tickmarksColor
The color of the tickmarks. If null then it will default to the same color as the line.
Default: null

tickmarksStyleDotStroke
This is the color of the filled part of the dot/borderedcircle style tickmarks.
Default: null (defaults to the line color)

tickmarksStyleDotFill
This is the color of the stroked part of the dot/borderedcircle style tickmarks.
Default: null (defaults to the line color)

tickmarksStyleDotLinewidth
This is the width of the line used when drawing the tickmarks.
Default: 0

tickmarksStyleImageHalign
This can be left right or center and determines the horizontal alignment of the tickmark.
Default: center

tickmarksStyleImageValign
This can be top bottom or center and determines the vertical alignment of the tickmark.
Default: center

tickmarksStyleImageOffsetx
After the alignment has been applied, this is added to the X coordinate of the tickmark.
Default: 0

tickmarksStyleImageOffsety
After the alignment has been applied, this is added to the Y coordinate of the tickmark.
Default: 0

stepped
Draws the line as stepped. Useful for showing stock performance for example.
Default: false

linewidth
The width of the line (ie the line on the chart). Note: If your line is stepped and filled, and you don't want a trailing line indicating the last value, you can set this to zero.
Default: 1

linecap
This property allows you to set the style for the context.lineCap setting. 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 will need to set this to butt.
Default: round

linejoin
This property allows you to set the style for the context.lineJoin setting. 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

animationUnfoldX
This is used by the unfold Line chart animation and dictates whether the X value is unfolded.
Default: false

animationUnfoldY
This is used by the unfold Line chart animation and dictates whether the Y value is unfolded.
Default: true

animationUnfoldInitial
This property can be used to set the initial factor for the unfold animation. Setting this to a value less than one will cause the line to expand outwards, whilst a value greater than one will cause the line to contract towards the correct values.
Default: 2

highlightStyle
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. It's passed the shape object as an argument. As of June 2016, you can also set this to halo to get a new style of highlighting. As of version 5.23 you can also set this to invert. If you do this on a dark background you may find that you need to change the highlightFill color setting as well.
Default: null

highlightStroke
If you use tooltips, this controls the color of the highlight stroke.
Default: black

highlightFill
If you use tooltips, this controls the color of the highlight fill.
Default: rgba(255,255,255,0.5)

highlightPointRadius
This sets the size of the highlight.
Default: 2

highlightDataset
Whether dataset highlighting should be enabled. If enabled you can click on a dataset (ie a line) and it will be highlighted. If you add a callback function it will run that function for you. There are demos in the download archive which show this called:
  • line-highlight-dataset1.html
  • line-highlight-dataset2.html
  • line-highlight-dataset3.html
  • line-highlight-dataset4.html
  • line-highlight-dataset5.html
  • line-highlight-dataset6.html
  • line-highlight-dataset7.html
  • line-nvd.html
  • line-nvd-single-object.html

Default: false

highlightDatasetStroke
The stroke color of the highlight. This can be an array of colors for when you have multiple datasets and want to use a different highlight for each one.
Default: rgba(0,0,0,0.25)

highlightDatasetFill
The fill color of the highlight. This can be an array of colors for when you have multiple datasets and want to use a different highlight for each one.
Default: rgba(255,255,255,0.75)

highlightDatasetStrokeUseColors
You can set this to true in order to use the same colors as the colors property.
Default: false

highlightDatasetFillUseColors
You can set this to true in order to use the same colors as the colors property.
Default: false

highlightDatasetStrokeAlpha
This allows you to specify an alpha value (the opacity) for the stroke color.
Default: 1

highlightDatasetFillAlpha
This allows you to specify an alpha value (the opacity) for the fill color.
Default: 1

highlightDatasetLinewidth
The linewidth of the highlight stroke. By default this will match the linewidth of the line.
Default: null

highlightDatasetDashed
If enabled then the highlight stroke will be dashed.
Default: false

highlightDatasetDotted
If enabled then the highlight stroke will be dotted.
Default: false

highlightDatasetDashArray
If this is set to an array of two numbers it will be used as the linedash setting.
Default: null

highlightDatasetCallback
You can set this to a function that will be run when a dataset is highlighted (ie when it's clicked on). It's passed an object containing one property - dataset - which is the index of the dataset that has been clicked.
Default: null

highlightDatasetExclude
If there are datasets that you don't want to be highlighted then you can include the index of the dataset here. It can either be a number or an array of numbers.
Default: null

highlightDatasetEvent
This is the event that triggers the dataset highlighting. It defaults to click but can also be mousemove.
Default: click

spline
This option causes the line to be drawn as a spline - ie curvy. Not all options will work with the spline option - however, the introduction of real spline curves over the previous curvy option is a significant improvement. There are numerous examples of this in the demos that are included in the download file. null values will not work with the spline option.
Default: false

clearto
This is used in animations and effects as the default color to use when the canvas.
Default: null

combinedEffect
Set this to the name of an effect (eg grow ) and the CombinedChart object will use that effect to draw the chart instead of the regular draw function.
Default: null

combinedEffectOptions
This should be a string that contains a javascript object of options for the effect function like this:
combinedchartEffectOptions: '{frames: 300}'
It has to be a string because of a quirk of the option parsing system.
Default: null

combinedEffectCallback
A function that runs when this objects effect has finished.
Default: null

dotted
Whether the line (not the background grid) is dotted or not. This is a new addition in January 2017.
Default: false

dashed
Whether the line (not the background grid) is dashed or not. This is a new addition in January 2017.
Default: false

outofbounds
Normally, out-of-bounds values are not drawn. By setting this to true you can change this behaviour.
Default: false

outofboundsClip
If you've enabled the outofbounds option but you're not interested in seeing the bits which fall outside of the chart area (eg in the margins) then you can enable this option. There's a demo of the outofboundsClip option in the download archive (line-overflow-clipped.html).
Default: false

horizontalLines
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/left-margin/right-margin 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

responsive
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)
An accessor that you can use to retrieve the values of properties.

obj.set(name, value)
An accessor that you can use to set the values of properties.

obj.getShape(event)

This method makes it easy to get hold of which point has been clicked on or hovered over. It returns an object which has the following indexes available:
object The chart object
x This is the X coordinate for the point.
y This is the Y coordinate for the point.
dataset The zero-indexed dataset index that the point belongs to.
index The zero-indexed index of the point in the particular dataset.
sequentialIndex The sequentialIndex is the zero-indexed sequential index of the point across all of the datasets.
tooltip If a tooltip is associated with this point this will be it.id: strings are expanded for you (where the tooltip text is retrieved from the html tag with the matching ID).
<script>
    line.canvas.onclick = function (e)
    {
        RGraph.redraw();
    
        var canvas  = e.target,
            obj     = canvas.__object__,
            shape   = obj.getShape(e);

        if (shape) {
            
            var x = shape.x,
                y = shape.y;
            
            obj.path(
                'b a % % 5 0 6.28 false s black f red',
                x, y
            );
        }
    }
</script>

obj.getValue(mixed)

This method can be used to get the value at a particular point or at the mouse coordinates based on the scale that is in use - not simply the coordinates of the mouse. The argument can either be an event object (for use in event listener functions) or a two-element array consisting of the X and Y coordinates (ie when you're not in an event listener). It returns null if the mouse or coordinates are in the margin areas. An example:

line.canvas.onclick = function (e)
{
    var obj   = e.target.__object__;
    var value = obj.getValue(e);
    
    // ...
}

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 the coordinate for the maximum/minimum value if the given number is out of range.



obj.closest(event)
obj.closest({event: event, tolerance: 25})
obj.closest({event: event, tolerance: 25, xonly: false})

This method returns an object containing the dataset and index of the first point that it comes across thats within the tolerance distance from the mouse click. You can pass it either the event object or a custom object containing the indexes: event (the event object), tolerance (the allowable distance from a point that you want to permit) and xonly which is whether you want to only consider the X coordinate when calculating the closest point (it defaults to false).



obj.growPoint(index, value)

This method animates a single point to the given value. It doesn't take a dataset due to the nature of the how the function works - only the first dataset is accommodated. There's a demo of this function being used to implement a touch-device-friendly version of an adjustable line in the download archive called line-adjustable-onetouch.html.



obj.on(event, function)

This method can be used to set an event listener on an object. It operates similarly to the jquery on function. The first argument is the event that you wish to attach to and the second is the handler function. For example:

obj.on('draw', function (obj)
{
    // Put your event code here
});

obj.exec(function)

The exec function is documented 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.

obj.hide([index])

The hide function hides a line by setting the color to rgba(0,0,0,0). Tooltips and other interactive features still work even though the line is not visible. You can give an integer (the index of the relevant line), an array of line indexes, or no argument at all in which case all of the lines on the chart are hidden


obj.show([index])

This function is the reverse of the above.


obj.hidden(index)

This function returns true or false as to whether the given line index is hidden or not.


obj.over(x, y)

This function returns whether the cursor is over one of the lines that is drawn on the chart. If there is a line being hovered over you'll get back an object containing the index of that line (the indexing begins at zero remember). There's also an easy way to add highlighting - the highlightDataset properties which are detailed above in the Miscellaneous section.


obj.highlightDataset(opt)

If you want to programmatically highlight one of your datasets then you can do so using this function. It takes an object of options as its only argument and that object can look like this:

line.highlightDataset({
    dataset: 1, // Required
    stroke: 'red',
    fill: '#fcc',
    linewidth: 4,
    linedash: [10,10]
});

The only required option to the function is the zero-indexed dataset: which naturally has to be given to highlight the correct dataset. Other options are optional.


Errorbars

Errorbars can allow you to show an upper and lower range for a particular point like the example page line-errorbars.html in the download archive shows. You can specify errorbars like this:

var line = new RGraph.Line({
    id: 'cvs',
    data: [12,18,10,8,5,4,3,2,14,5,6,9],
    options: {
        yaxisScaleMin: 5,
        errorbars: [1, [1,5],[5,1,'red',10],3,3,3,3,3,3,3,3,3,3],
        //errorbarsLinewidth: 10,
        //errorbarsColor: 'red',
        //errorbarsCapped: false,
        //errorbarsCappedWidth: 50,
        marginInner: 15,
        tickmarksStyle: 'circle',
        xaxis: false
    }
}).draw();

This would give you errorbars for each point and the elements of each errorbar array are (each one is optional - specify null if you want to give no value):

Combining the Line and Bar charts

You can combine the Bar charts and Line charts. Find out more here. In the same vein, you can have Y axes on both the left and right sides.

Alternative colors

Instead of a string stipulating the color, each element of the colors array can be a two element array stipulating the up color, and the down color. To use alternating colors you must also stipulate the alternate property:

myLine.set('colors.alternate', true);
myLine.set('colors', ['red', ['blue', 'yellow'], 'green]);

Accumulative filled Line charts

The default behaviour of filled Line charts is to "stack" the lines on top of each other. This allows them all to be totally visible, no matter what (unless a line has a zero value of course). If this is not desired, then there is an option (filledAccumulative - true or false) to change this behaviour so that the lines are plotted "as-is". Keep in mind that if you set this option to false (ie the Lines are plotted as-is) it may be wiser to use semi-transparent colors or some parts of data sets (or even entire data sets) may be hidden by others. There's a comparison of the different modes here.

Custom tickmarks

If none of the available tickmark styles are suitable, you can instead specify a function object that draws the tickmark, enabling you to make the tickmark yourself. For example:

<script>
    line.set('tickmarksStyle', myTick);

    //
    // The function that is called once per tickmark, to draw it
    // 
    // @param object obj   The chart object
    // @param array  data  The entire line data
    // @param number value The individual point's value
    // @param number index The current index in the data array
    // @param number x     The X coordinate
    // @param number y     The Y coordinate
    // @param string color The color of the line
    // @param number prevX The previous X coordinate
    // @param number prevY The previous Y coordinate
    //
    function myTick (obj, data, value, index, x, y, color, prevX, prevY)
    {
        // Draw your custom tickmark here
    }
</script>

As of August 2014 you can also specify an image to use as a tickmark. Various styles of URL are supported:

obj.set({tickmarksStyle: 'image:foo.png'});     // Starts with image: prefix
obj.set({tickmarksStyle: '/images/foo.png'});   // Starts with a /
obj.set({tickmarksStyle: '../images/foo.png'}); // Starts with ../
obj.set({tickmarksStyle: 'data: ...'});         // Starts with data: (for inline images)
obj.set({tickmarksStyle: 'images/foo.png'});    // Starts with images/

The coords2 array

An alternative method of indexing the chart coordinates is available in obj.coords2. With this array all of the first lines coordinates are available in obj.coords2[0], the second lines coordinates in obj.coords2[1] and so on.

The __index2__ property on tooltips

When showing tooltips, one property of the tooltip is __index2__. This is the index that pertains to the individual dataset. In a function called from the tooltip event you can access it like this:

function myFunc (obj)
{
    var idx = RGraph.Registry.get('tooltip').__index2__;
}
RGraph.addCustomEventListener(obj, 'ontooltip', myFunc  );

Note about the data_arr array

Sometimes you may wish to view your data as one big array, instead of one array per dataset. In this case, the obj.data_arr is available. This is one long array containing all of the individual data points.

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.Line({
    id: 'cvs',
    data: [4,8,6,3,5,8,9],
    options: {
    }
}).on('draw', function (obj)
{
    console.log('The draw event has fired');
    
}).draw();

Effects

These effects are available and can be used instead of the draw function. There are also generic effects available which you can see here: Generic effects and transitions
<script>
    //
    // Optional callback function that's called when the effect is complete
    //
    function myCallback (obj)
    {
        // ...
    }

    var obj = new RGraph.Line({
        id: 'cvs',
        min: 0,
        max: 100,
        value: 56,
        options: {
            marginLeft: 35,
            marginInner: 5
        }
    // All of these arguments are optional
    }).trace({frames: 60, reverse: false}, myCallback)
    // .unfold({frames: 60}, myCallback)
    // .unfoldFromCenter({frames: 60}, myCallback)
    // .unfoldFromCenterTace({frames: 60}, myCallback)
    // .foldToCenter({frames: 60}, myCallback)
    // .trace({frames: 60}, myCallback) (shown in the example above)
    // .wave({frames: 60, reverse: false}, myCallback) (shown in the example above
</script>

The growPoint() function

If you want to use adjusting on a touch-based device (eg a tablet) then the default Line chart adjusting won't work because it really requires a mouse to function.

The obj.growPoint function can therefore be used to skirt this limitation and facilitate adjusting on these devices. There follows some sample code for an adjustable Line chart that uses this function instead of the built-in adjusting feature. You can also find a demo in the download archive that employs this function.

<script>
   line = new RGraph.Line({
        id: "cvs",
        data: [4,8,5,2,6,7,9,1,5,4,3,8],
        options: {
            xaxisLabels: ["Alf","Bob","Cal","Dug","Edd","Fay","Gof","Hal","Ind","Jay","Kev","Lou"],
            textSize: 14,
            spline: true,
            xaxis: false,
            yaxis: false,
            backgroundGridBorder: false,
            backgroundGridVlines: false,
            marginInner: 10,
            tickmarksStyle: "filledcircle",
            tickmarksSize: 3,
            shadow: false
        }
    }).draw();
    
    line.canvas.onclick = function (e)
    {
        var indexes = line.closest({
            event: e,
            tolerance: 25, // Optional - defaults to 25
            xonly: true    // Optional - defaults to false
        });

        if (!indexes) {
            return;
        }

        var value = line.getValue(e);

        line.growPoint({
            index:   indexes.index,
            value:   value,
            dataset: 0,  // Optional - defaults to 0
            frames:  15  // Optional - defaults to 15
        });
    }
</script>