Line chart documentation

Documentation about the SVG Line chart including information about all of the options and methods that are available to you.

Example

The code below produces a chart like this:

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

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

Using errorbars on the Line chart

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

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

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

The coordinates properties

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

Properties

You can use these properties to control how the chart appears. You can set them by including them in the options section of the configuration as is shown above.

Background properties

PropertyDescriptionDefault
backgroundColorThe color of the background.null
backgroundImageA URL of an image to render to the background.null
backgroundImageAspectThe aspect ratio setting of the SVG image tag, eg it could be XMinYMin meet.none
backgroundImageOpacityThe alpha/opacity value of the background image.0.5
backgroundImageStretchWhether the background image is stretched across the whole chart (except the margins).true
backgroundImageXIf you're not using the stretch option you can specify the X coordinate of the image.null
backgroundImageXIf you're not using the stretch option you can specify the Y coordinate of the image.null
backgroundImageWIf you're not using the stretch option you can specify the width of the image.null
backgroundImageHIf you're not using the stretch option you can specify the height of the image.null
backgroundGridWhether to show the background grid or not.true
backgroundGridColorThe color of the background grid.#ddd
backgroundGridLinewidthThe linewidth that the background grid lines are. Decimals (eg 0.5) are permitted.1
backgroundGridBorderDetermines whether a borderline is drawn around the grid.true
backgroundGridHlinesDetermines whether to draw the horizontal grid lines.true
backgroundGridHlinesCountDetermines how many horizontal grid lines you have. The default is linked to how many scale labels that you have.null
backgroundGridVlinesDetermines whether to draw the vertical grid lines.true
backgroundGridVlinesCountDetermines how many vertical grid lines you have. The default is to be linked to how many scale labels that you have.null
backgroundGridDashedYou can specify a dashed background grid by setting this to true. This option takes precedence over the dotted variant.false
backgroundGridDottedYou can specify a dotted background grid by setting this to true.false
backgroundGridDashArrayWith this option you can specify exactly what the array used for the linedash setting should be. It should be an array consisting of two numbers.null
backgroundColor
The color of the background.
Default: null

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

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

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

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

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

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

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

backgroundImageH
If you're not using the stretch option you can specify the height of the image.
Default: null

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

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

backgroundGridLinewidth
The linewidth that the background grid lines are. Decimals (eg 0.5) are permitted.
Default: 1

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

backgroundGridHlines
Determines whether to draw the horizontal grid lines.
Default: true

backgroundGridHlinesCount
Determines how many horizontal grid lines you have. The default is linked to how many scale labels that you have.
Default: null

backgroundGridVlines
Determines whether to draw the vertical grid lines.
Default: true

backgroundGridVlinesCount
Determines how many vertical grid lines you have. The default is to be linked to how many scale labels that you have.
Default: null

backgroundGridDashed
You can specify a dashed background grid by setting this to true. This option takes precedence over the dotted variant.
Default: false

backgroundGridDotted
You can specify a dotted background grid by setting this to true.
Default: false

backgroundGridDashArray
With this option you can specify exactly what the array used for the linedash setting should be. It should be an array consisting of two numbers.
Default: null

Margin properties

PropertyDescriptionDefault
marginLeftThe left margin of the chart, (the margin is where the labels and title are)).35
marginRightThe right margin of the chart, (the margin is where the labels and title are).35
marginTopThe top margin of the chart, (the margin is where the labels and title are).35
marginBottomThe bottom margin of the chart, (the margin is where the labels and title are).35
marginInnerThe horizontal margin (in pixels) of the chart. The horizontal margin is on the inside of the axes.15
marginLeft
The left margin of the chart, (the margin is where the labels and title are)).
Default: 35

marginRight
The right margin of the chart, (the margin is where the labels and title are).
Default: 35

marginTop
The top margin of the chart, (the margin is where the labels and title are).
Default: 35

marginBottom
The bottom margin of the chart, (the margin is where the labels and title are).
Default: 35

marginInner
The horizontal margin (in pixels) of the chart. The horizontal margin is on the inside of the axes.
Default: 15

Color properties

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

Fill properties

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

filledColors
An array containing the fill colors to be used.
Default: []

filledClick
A function that is triggered by clicking on the fill part of the line. It can look like this:
filledClick: function (e, obj, index)
{
    // e:     The event object
    // obj:   The chart object
    // index: The index of the line that was clicked
},

Default: null

filledOpacity
The opacity of the fill color. This should be a number between 0 and 1.
Default: 1

filledAccumulative
This controls whether the values for the lines are displayed accumulatively (ie the filled lines are stacked)
Default: false

X-axis properties

PropertyDescriptionDefault
xaxisWhether the X-axis is shown or not.true
xaxisLinewidthThe linewidth that's used to draw the X-axis.1
xaxisTickmarksWhether the X-axis has tickmarks or not.true
xaxisTickmarksLengthThe size of the X-axis tickmarks.3
xaxisLabelsThe labels for the X-axis.null
xaxisLabelsOffsetxThe X pixel offset that's added to the X-axis labels.0
xaxisLabelsOffsetyThe Y pixel offset that's added to the X-axis labels.0
xaxisLabelsPositionThis determines the positioning of the X-axis labels. You probably won't need to change this.edge
xaxisColorThe color of the X-axis.black
xaxisLabelsColorThe color of the X-axis text.null
xaxisLabelsBoldWhether the X-axis text is bold or not.null
xaxisLabelsItalicWhether the X-axis text is italic or not.null
xaxisLabelsFontThe font of the X-axis text.null
xaxisLabelsSizeThe size of the X-axis text.null
xaxisLabelsPositionEdgeTickmarksCountNot something you'll use often, if at all. Determines how many tickmarks there are when the X-axis is in edge mode.null
xaxisLabelsAngleIf you have long labels you may want to set this to a number between 0 and 90 to enable angled labels.null
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)
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 position of the X-axis title.null
xaxisTitleYBy giving this you can specifically set the Y position of the X-axis title.null
xaxisTitleOffsetxThe X pixel offset that's applied to the X-axis title.0
xaxisTitleOffsetyThe Y pixel offset that's applied to the X-axis title.0
xaxisTitleHalignThe horizontal alignment of the X-axis title.null
xaxisTitleValignThe vertical alignment of the X-axis title.null
xaxis
Whether the X-axis is shown or not.
Default: true

xaxisLinewidth
The linewidth that's used to draw the X-axis.
Default: 1

xaxisTickmarks
Whether the X-axis has tickmarks or not.
Default: true

xaxisTickmarksLength
The size of the X-axis tickmarks.
Default: 3

xaxisLabels
The labels for the X-axis.
Default: null

xaxisLabelsOffsetx
The X pixel offset that's added to the X-axis labels.
Default: 0

xaxisLabelsOffsety
The Y pixel offset that's added to the X-axis labels.
Default: 0

xaxisLabelsPosition
This determines the positioning of the X-axis labels. You probably won't need to change this.
Default: edge

xaxisColor
The color of the X-axis.
Default: black

xaxisLabelsColor
The color of the X-axis text.
Default: null

xaxisLabelsBold
Whether the X-axis text is bold or not.
Default: null

xaxisLabelsItalic
Whether the X-axis text is italic or not.
Default: null

xaxisLabelsFont
The font of the X-axis text.
Default: null

xaxisLabelsSize
The size of the X-axis text.
Default: null

xaxisLabelsPositionEdgeTickmarksCount
Not something you'll use often, if at all. Determines how many tickmarks there are when the X-axis is in edge mode.
Default: null

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

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)

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 position of the X-axis title.
Default: null

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

xaxisTitleOffsetx
The X pixel offset that's applied to the X-axis title.
Default: 0

xaxisTitleOffsety
The Y pixel offset that's applied to the X-axis title.
Default: 0

xaxisTitleHalign
The horizontal alignment of the X-axis title.
Default: null

xaxisTitleValign
The vertical alignment of the X-axis title.
Default: null

Y-axis properties

PropertyDescriptionDefault
yaxisWhether the Y-axis is shown or not.true
yaxisPositionThis controls whether the Y-axis is positioned on the left or the right.left
yaxisLinewidthThe linewidth that's used to draw the Y-axis.1
yaxisTickmarksWhether the Y-axis has tickmarks or not.true
yaxisTickmarksLengthThe size of the Y-axis tickmarks.3
yaxisColorThe color of the Y-axis.black
yaxisLabelsIf the yaxisScale option is false then this can be used to give an array of labels that are shown on the Y-axis instead.null
yaxisLabelsOffsetxThe X pixel offset that's added to the Y-axis labels.0
yaxisLabelsOffsetyThe Y pixel offset that's added to the Y-axis labels.0
yaxisLabelsHalignThe horizontal alignment of the labels.right
yaxisLabelsValignThe vertical alignment of the labels.center
yaxisLabelsCountThe number of Y labels.5
yaxisLabelsPositionEdgeTickmarksCountNot something you'll use often, if at all. Determines how many tickmarks there are.null
yaxisScaleWhether the Y-axis scale is shown.true
yaxisScaleUnitsPreUnits that are prepended to the scale numbers. (An empty string
yaxisScaleUnitsPostUnits that are appended to the scale numbers.(An empty string
yaxisScaleDecimalsThe number of decimals that the scale will show.0
yaxisScalePointThe character(s) used as the decimal point..
yaxisScaleThousandThe character(s) used as the thousand separator.,
yaxisScaleRoundIf set to true the max scale value will be rounded up.false
yaxisScaleMaxThe maximum scale value.null
yaxisScaleMinThe minimum Y value. As well as a numeric value you can also set this to mirror so that the X-axis is put in the center.0
yaxisScaleFormatterThis option should be a function. This function handles the entirety of the number formatting for the Y-axis. Units are not added, decimals are not added - it's all up to you. The function is passed two arguments - the chart object and the number. It should look like this:
yaxisFormatter: function (obj, num)
{
}
null
yaxisLabelsColorThe color of the Y-axis text.null
yaxisLabelsBoldWhether the Y-axis text is bold or not.null
yaxisLabelsItalicWhether the Y-axis text is italic or not.null
yaxisLabelsFontThe font of the Y-axis text.null
yaxisLabelsSizeThe size of the Y-axis text.null
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
yaxisTitleItalicThis controls whether the Y-axis title is italic or not.null
yaxisTitleColorThis controls the color of the Y-axis title.null
yaxisTitleXBy giving this you can specifically set the X position of the Y-axis title.null
yaxisTitleYBy giving this you can specifically set the Y position of the Y-axis title.null
yaxisTitleOffsetxThe X pixel offset that's applied to the Y-axis title.0
yaxisTitleOffsetyThe Y pixel offset that's applied to the Y-axis title.0
yaxisTitleHalignThe horizontal alignment of the Y-axis title.null
yaxisTitleValignThe vertical alignment of the Y-axis title.null
yaxis
Whether the Y-axis is shown or not.
Default: true

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

yaxisLinewidth
The linewidth that's used to draw the Y-axis.
Default: 1

yaxisTickmarks
Whether the Y-axis has tickmarks or not.
Default: true

yaxisTickmarksLength
The size of the Y-axis tickmarks.
Default: 3

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

yaxisLabels
If the yaxisScale option is false then this can be used to give an array of labels that are shown on the Y-axis instead.
Default: null

yaxisLabelsOffsetx
The X pixel offset that's added to the Y-axis labels.
Default: 0

yaxisLabelsOffsety
The Y pixel offset that's added to the Y-axis labels.
Default: 0

yaxisLabelsHalign
The horizontal alignment of the labels.
Default: right

yaxisLabelsValign
The vertical alignment of the labels.
Default: center

yaxisLabelsCount
The number of Y labels.
Default: 5

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

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

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

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

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

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

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

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

yaxisScaleMax
The maximum scale value.
Default: null

yaxisScaleMin
The minimum Y value. As well as a numeric value you can also set this to mirror so that the X-axis is put in the center.
Default: 0

yaxisScaleFormatter
This option should be a function. This function handles the entirety of the number formatting for the Y-axis. Units are not added, decimals are not added - it's all up to you. The function is passed two arguments - the chart object and the number. It should look like this:
yaxisFormatter: function (obj, num)
{
}

Default: null

yaxisLabelsColor
The color of the Y-axis text.
Default: null

yaxisLabelsBold
Whether the Y-axis text is bold or not.
Default: null

yaxisLabelsItalic
Whether the Y-axis text is italic or not.
Default: null

yaxisLabelsFont
The font of the Y-axis text.
Default: null

yaxisLabelsSize
The size of the Y-axis text.
Default: null

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

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

yaxisTitleColor
This controls the color of the Y-axis title.
Default: null

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

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

yaxisTitleOffsetx
The X pixel offset that's applied to the Y-axis title.
Default: 0

yaxisTitleOffsety
The Y pixel offset that's applied to the Y-axis title.
Default: 0

yaxisTitleHalign
The horizontal alignment of the Y-axis title.
Default: null

yaxisTitleValign
The vertical alignment of the Y-axis title.
Default: null

Other text properties

PropertyDescriptionDefault
textColorThe color of the text.black
textFontThe font used for text.Arial, Verdana, sans-serif
textSizeThe size of the text.12
textBoldWhether the text is bold or not.false
textItalicWhether the text is italic or not.false
labelsAboveWhether to show the labelsAbove style labels.false
labelsAbovePointThe decimal point character to use for the labelsAbove labels.null
labelsAboveThousandThe thousand separator character to use for the labelsAbove labels.null
labelsAboveDecimalsThe number of decimals to use for the labelsAbove labels.0
labelsAbovePreA string to prepend to the labelsAbove labels.null
labelsAbovePostA string to append to the labelsAbove labels.null
labelsAboveFormatterA function that handles ALL of the formatting of the number. The function is passed two arguments - the object and the unformatted number.null
labelsAboveOffsetxThe horizontal offset of the labelsAbove labels.0
labelsAboveOffsetyThe vertical offset of the labelsAbove labels.0
labelsAboveFontThe font of the labelsAbove labels.null
labelsAboveSizeThe size of the labelsAbove labels.null
labelsAboveBoldWhether the labelsAbove labels are bold or not.null
labelsAboveItalicWhether the labelsAbove labels are italic or not.null
labelsAboveColorThe color of the labelsAbove labels.null
labelsAboveBackgroundThe background color of the labelsAbove labels.null
labelsAboveBackgroundPaddingThe padding of the labelsAbove labels.0
labelsAboveHalignThe horizontal alignment of the labelsAbove.center
labelsAboveValignThe vertical alignment of the labelsAbove.bottom
labelsAboveSpecificThis property allows you to make the labelsAbove labels specific strings.null
textColor
The color of the text.
Default: black

textFont
The font used for text.
Default: Arial, Verdana, sans-serif

textSize
The size of the text.
Default: 12

textBold
Whether the text is bold or not.
Default: false

textItalic
Whether the text is italic or not.
Default: false

labelsAbove
Whether to show the labelsAbove style labels.
Default: false

labelsAbovePoint
The decimal point character to use for the labelsAbove labels.
Default: null

labelsAboveThousand
The thousand separator character to use for the labelsAbove labels.
Default: null

labelsAboveDecimals
The number of decimals to use for the labelsAbove labels.
Default: 0

labelsAbovePre
A string to prepend to the labelsAbove labels.
Default: null

labelsAbovePost
A string to append to the labelsAbove labels.
Default: null

labelsAboveFormatter
A function that handles ALL of the formatting of the number. The function is passed two arguments - the object and the unformatted number.
Default: null

labelsAboveOffsetx
The horizontal offset of the labelsAbove labels.
Default: 0

labelsAboveOffsety
The vertical offset of the labelsAbove labels.
Default: 0

labelsAboveFont
The font of the labelsAbove labels.
Default: null

labelsAboveSize
The size of the labelsAbove labels.
Default: null

labelsAboveBold
Whether the labelsAbove labels are bold or not.
Default: null

labelsAboveItalic
Whether the labelsAbove labels are italic or not.
Default: null

labelsAboveColor
The color of the labelsAbove labels.
Default: null

labelsAboveBackground
The background color of the labelsAbove labels.
Default: null

labelsAboveBackgroundPadding
The padding of the labelsAbove labels.
Default: 0

labelsAboveHalign
The horizontal alignment of the labelsAbove.
Default: center

labelsAboveValign
The vertical alignment of the labelsAbove.
Default: bottom

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

Tooltip properties

PropertyDescriptionDefault
tooltipsAn array of tooltips for the chart. This array should NOT be multidimensional. You can also check the canvas tooltips documentation for more information.null
tooltipsOverrideIf required, this can be a function that handles the tooltip showing instead of the default RGraph tooltips. It should look like this:
tooltipsOverride: function (obj, opt)
{
    // Show tooltip
}
The opt is an argument that contains these items:
  • object The chart object.
  • index The index of the element (that triggered the tooltip).
  • sequentialIndex The sequential index of the element that was clicked.
  • text The text to be used as the tooltip. Remember that this may contain HTML (or whatever else you may have specified).
  • event The event object (either a click or mousemove event).
null
tooltipsEventThe event used for tooltips (either click or mousemove.click
tooltipsFormattedPointWhen using formatted tooltip strings this is used as the point when using the %{value_formatted} option..
tooltipsFormattedThousandWhen using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.,
tooltipsFormattedDecimalsWhen using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option.0
tooltipsFormattedUnitsPreWhen using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.(an empty string)
tooltipsFormattedUnitsPostWhen using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.(an empty string)
tooltipsFormattedKeyLabelsThe labels that are used in the formatted tooltip key.[] (an empty array)
tooltipsFormattedKeyColorsThe colors that are used in the formatted tooltip key. Normally these are automatically taken from the colors on the chart but can be specified differently using this property.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: "1 px solid #ddd";
}
null
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 in the canvas documentation, 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:
tooltips: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}
null
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.SVG.tooltips.style object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object CSS for the tooltips. These are CSS styles that get applied to all of the tooltips for the specific object only. It should look like this:
tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt'
}
null
tooltipsCssClassThe CSS class that's applied to the tooltip DIV.RGraph_tooltip
tooltipsOffsetxThis property allows you to shift the tooltips left or right.0
tooltipsOffsetyThis property allows you to shift the tooltips up or down.0
tooltips
An array of tooltips for the chart. This array should NOT be multidimensional. You can also check the canvas tooltips documentation for more information.
Default: null

tooltipsOverride
If required, this can be a function that handles the tooltip showing instead of the default RGraph tooltips. It should look like this:
tooltipsOverride: function (obj, opt)
{
    // Show tooltip
}
The opt is an argument that contains these items:
Default: null

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

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

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

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

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

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

tooltipsFormattedKeyLabels
The labels that are used in the formatted tooltip key.
Default: [] (an empty array)

tooltipsFormattedKeyColors
The colors that are used in the formatted tooltip key. Normally these are automatically taken from the colors on the chart but can be specified differently using this property.
Default: null

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: "1 px solid #ddd";
}

Default: null

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 in the canvas documentation, 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:
tooltips: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}

Default: null

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.SVG.tooltips.style object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object CSS for the tooltips. These are CSS styles that get applied to all of the tooltips for the specific object only. It should look like this:
tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt'
}

Default: null

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

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

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

Tickmark properties

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

tickmarksSize
The size of the tickmarks. This can be a number or an array of numbers (if there are multiple lines).
Default: 5

tickmarksFill
The fill color used for the inner of tickmarks. This can be a string or an array of strings (if there are multiple lines).
Default: white

Shadow properties

PropertyDescriptionDefault
shadowWhether or not shadows or shown underneath the linesfalse
shadowOffsetxThe X offset of the shadows.2
shadowOffsetyThe Y offset of the shadows.2
shadowBlurThe magnitude of the blurring effect of the shadow.2
shadowOpacityThe opacity of the shadow. This should be a number between 0 and 1. Smaller values result in a lighter shadow.0.25
shadow
Whether or not shadows or shown underneath the lines
Default: false

shadowOffsetx
The X offset of the shadows.
Default: 2

shadowOffsety
The Y offset of the shadows.
Default: 2

shadowBlur
The magnitude of the blurring effect of the shadow.
Default: 2

shadowOpacity
The opacity of the shadow. This should be a number between 0 and 1. Smaller values result in a lighter shadow.
Default: 0.25

Title properties

PropertyDescriptionDefault
titleThe title of the chart.(An empty string)
titleXThe specific X coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.null
titleYThe specific Y coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.null
titleOffsetxAn offset value that is added to the calculated X coordinate.0
titleOffsetyAn offset value that is added to the calculated Y coordinate.0
titleHalignThe horizontal alignment of the title.center
titleColorThe color of the title.null
titleFontThe font used to render the title.null
titleSizeThe size of the font used to render the title.null
titleBoldWhether the title is bold or not.null
titleItalicWhether the title is italic or not.null
titleSubtitleThe subtitle of the chart. If a subtitle is specified the title is moved up to accommodate it. As such you might need to give a larger marginTop value.(An empty string)
titleSubtitleColorThe color of the subtitle.#aaa
titleSubtitleFontThe font used to render the subtitle.null
titleSubtitleSizeThe size of the font used to render the subtitle.null
titleSubtitleBoldWhether the subtitle is bold or not.null
titleSubtitleItalicWhether the subtitle is italic or not.null
title
The title of the chart.
Default: (An empty string)

titleX
The specific X coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.
Default: null

titleY
The specific Y coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.
Default: null

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

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

titleHalign
The horizontal alignment of the title.
Default: center

titleColor
The color of the title.
Default: null

titleFont
The font used to render the title.
Default: null

titleSize
The size of the font used to render the title.
Default: null

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

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

titleSubtitle
The subtitle of the chart. If a subtitle is specified the title is moved up to accommodate it. As such you might need to give a larger marginTop value.
Default: (An empty string)

titleSubtitleColor
The color of the subtitle.
Default: #aaa

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

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

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

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

Key properties

PropertyDescriptionDefault
keyAn array of the labels that appear on the key.null
keyColorsAn array of colors to be shown on the key. If not specified then the colors option will be used instead.null
keyLabelsColorThe color of the text in the key.null
keyLabelsBoldWhether the key text is bold or not.null
keyLabelsFontThe font to use for the key text.null
keyLabelsSizeThe size to use for the key text.null
ketLabelsItalicWhether the key text is italic or not.null
keyLabelsOffsetxThe horizontal pixel offset of the key text (just the text).0
keyLabelsOffsetyThe vertical pixel offset of the key text (just the text).-1
keyOffsetxThe horizontal pixel offset of the entire key.0
keyOffsetyThe horizontal pixel offset of the entire key.0
keyColorShapeThis controls which shape should be displayed on the key. It can be a string or an array of strings. The possible options are: rect, circle, triangle, line, dot, rectdotrect
key
An array of the labels that appear on the key.
Default: null

keyColors
An array of colors to be shown on the key. If not specified then the colors option will be used instead.
Default: null

keyLabelsColor
The color of the text in the key.
Default: null

keyLabelsBold
Whether the key text is bold or not.
Default: null

keyLabelsFont
The font to use for the key text.
Default: null

keyLabelsSize
The size to use for the key text.
Default: null

ketLabelsItalic
Whether the key text is italic or not.
Default: null

keyLabelsOffsetx
The horizontal pixel offset of the key text (just the text).
Default: 0

keyLabelsOffsety
The vertical pixel offset of the key text (just the text).
Default: -1

keyOffsetx
The horizontal pixel offset of the entire key.
Default: 0

keyOffsety
The horizontal pixel offset of the entire key.
Default: 0

keyColorShape
This controls which shape should be displayed on the key. It can be a string or an array of strings. The possible options are: rect, circle, triangle, line, dot, rectdot
Default: rect

Error bar properties

PropertyDescriptionDefault
errorbarsThis should be an array of either numbers or objects that represent the errorbars. If it's an object you can specify information that's specific to the point.null
errorbarsColorThe default color of the errorbars. This can be overridden using the color setting if you give an object as the errorbar information.black
errorbarsLinewidthThe linewidth that is used to draw the errorbars. This can be overridden using the linewidth setting if you give an object as the errorbar information.1
errorbarsCapwidthThe width of the caps to the errorbars. This can be overridden using the capwidth setting if you give an object as the errorbar information.10
errorbars
This should be an array of either numbers or objects that represent the errorbars. If it's an object you can specify information that's specific to the point.
Default: null

errorbarsColor
The default color of the errorbars. This can be overridden using the color setting if you give an object as the errorbar information.
Default: black

errorbarsLinewidth
The linewidth that is used to draw the errorbars. This can be overridden using the linewidth setting if you give an object as the errorbar information.
Default: 1

errorbarsCapwidth
The width of the caps to the errorbars. This can be overridden using the capwidth setting if you give an object as the errorbar information.
Default: 10

Trend line properties

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

Other properties

PropertyDescriptionDefault
linewidthThe linewidth used to render the line with.1
linecapThis property allows you to set the style for the stroke-linecap attribute. It can be butt round or square This can also be an array of those strings for when you have multiple lines on your chart and you want different styles for each. NB When the linejoin property is set to bevel you'll need to set this to butt.round
linejoinThis property allows you to set the style for the stroke-linejoin attribute. It can be bevel round or miter This can also be an array of those strings for when you have multiple lines on your chart and you want different styles for each.round
splineWhether a spline line chart (curvy instead of angular) is used.false
steppedIf true then the line will be drawn in a stepped fashion. Obviously, this cannot be used with the spline option.false
dottedWhether the line should be drawn as a dotted line.false
dashedWhether the line should be drawn as a dashed line.false
dasharrayIf you want to specify your own style of dash/gap for the line then this is the property to use. Give it an array consisting of two numbers - the size of the gap and then the size of the dash like this: [5,20][1,0]
linewidth
The linewidth used to render the line with.
Default: 1

linecap
This property allows you to set the style for the stroke-linecap attribute. It can be butt round or square This can also be an array of those strings for when you have multiple lines on your chart and you want different styles for each. NB When the linejoin property is set to bevel you'll need to set this to butt.
Default: round

linejoin
This property allows you to set the style for the stroke-linejoin attribute. It can be bevel round or miter This can also be an array of those strings for when you have multiple lines on your chart and you want different styles for each.
Default: round

spline
Whether a spline line chart (curvy instead of angular) is used.
Default: false

stepped
If true then the line will be drawn in a stepped fashion. Obviously, this cannot be used with the spline option.
Default: false

dotted
Whether the line should be drawn as a dotted line.
Default: false

dashed
Whether the line should be drawn as a dashed line.
Default: false

dasharray
If you want to specify your own style of dash/gap for the line then this is the property to use. Give it an array consisting of two numbers - the size of the gap and then the size of the dash like this: [5,20]
Default: [1,0]

Methods

obj.get(name)

This can be used to get properties if necessary. It's normally used after the chart is drawn if you need to get parameters (if you're doing custom coding for example).

obj.set(name, value)

This can be used to set properties if necessary. It's normally used after the chart is drawn if you need to set additional parameters or change them.

obj.getYCoord(value)

This method can be used to get an appropriate Y coordinate for a value when you're doing custom drawing on the chart. It returns null if the value is out of range.

obj.on(event, handler)

This function adds an event listener (such as beforedraw or draw) to the chart object. For example:

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

This function can be used to execute a function (immediately). It's not event-based (ie it doesn't run when something happens) - it just runs immediately - and only once. You might use it when you need to get something from the chart when it's drawn and then call the redraw function. Because this function only runs once the RGraph.SVG.redraw() function would not cause a loop - which would happen if you used the draw event.

obj.exec(function (obj)
{
    // Put your code here
});
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.

The responsive() function is documented on its own page here.

Data properties that are used on the points

The SVG <circle> or <rect> elements that represent the tickmark hotspots on the Line chart have various data attributes added to them that hold various bits of information. These are:

These can be retrieved by using standard DOM methods:

hotspot.getAttribute('data-index');

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

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

Events

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

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

Effects

These effects are available and can be used instead of the draw() function.
<script>
    /**
    * Optional callback function that's called when the effect is complete
    */
    function myCallback (obj)
    {
        // ...
    }

    var obj = new RGraph.SVG.Line({
        id: 'mySVG',
        data: [3,4,7,5,6,9,8],
        options: {
        }
    }).trace({frames: 60}, myCallback);
</script>