Scatter chart

Example

View example on CodePen
<script>
    tooltip = 'Result: <b>%{value_formatted}</b>'

    data1 = [
        {x:'1st January',  y:0,tooltip: tooltip},  {x:'5th April',      y:5.56,tooltip: tooltip},
        {x:'27th February',y:23,tooltip: tooltip}, {x:'4th April',      y:46,tooltip: tooltip},
        {x:'1st October',  y:18,tooltip: tooltip}, {x:'28th September', y:43,tooltip: tooltip},
        {x:'23rd August',  y:50,tooltip: tooltip}, {x:'1st June',       y:12,tooltip: tooltip},
        {x:'1st March',    y:32,tooltip: tooltip}, {x:'27th July',      y:12,tooltip: tooltip},
        {x:'23rd April',   y:32,tooltip: tooltip}, {x:'1st January',    y:50,tooltip: tooltip},
        {x:'3rd November', y:23,tooltip: tooltip}, {x:'12th December',  y:15,tooltip: tooltip},
        {x:'4th May',      y:41,tooltip: tooltip}
    ];
    
    data2 = [
        {x:'4th January',   y:0,  tooltip: tooltip, color: 'red'},  {x:'9th April',      y:5.56, tooltip: tooltip, color: 'red'},
        {x:'24th February', y:23, tooltip: tooltip, color: 'red' }, {x:'8th April',      y:46,   tooltip: tooltip, color: 'red'},
        {x:'9th October',   y:18, tooltip: tooltip, color: 'red' }, {x:'24th September', y:43,   tooltip: tooltip, color: 'red'},
        {x:'21st August',   y:50, tooltip: tooltip, color: 'red' }, {x:'2nd June',       y:12,   tooltip: tooltip, color: 'red'},
        {x:'19th March',    y:32, tooltip: tooltip, color: 'red' }, {x:'25th July',      y:12,   tooltip: tooltip, color: 'red'},
        {x:'24th April',    y:32, tooltip: tooltip, color: 'red' }, {x:'9th January',    y:50,   tooltip: tooltip, color: 'red'},
        {x:'16th November', y:23, tooltip: tooltip, color: 'red' }, {x:'14th December',  y:15,   tooltip: tooltip, color: 'red'},
        {x:'8th May',       y:41, tooltip: tooltip, color: 'red' }
    ];

    scatter = new RGraph.SVG.Scatter({
        id: 'chart-container',
        data: [data1, data2],
        options: {
            marginLeft: 100,
            yaxisScaleDecimals: 2,
            xaxisScaleMin: '1st January 00:00:00',
            xaxisScaleMax: '31st December 23:59:59',
            xaxisLabels: ['Jan','Feb','Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec'],
            tickmarksStyle: 'circle',
            tooltipsFormattedUnitsPost: 'kg',
            tooltipsCss: {
                backgroundColor: '#333',
                fontWeight: 'bold',
                fontSize: '14pt',
                opacity: 0.85
            }
        }
    }).draw();
</script>

How to specify the Scatter chart data

The Scatter chart is slightly different from other charts because, whereas other charts (usually) use arrays of information to specify values, the Scatter chart uses an array of objects. This should come quite naturally though as each Scatter chart point can have several different attributes (eg x-axis value, y-axis value, tooltip etc). At its most basic it looks like this:

var data = [
    {x:5,y:7}, {x:7,y:9}, {x:1,y:3}
];

That would define three points, each with x-axis and y-axis values. There are other things that you can add to each object (or just one/two etc) and they are:

Another example where each point has all of the options specified is:

var data = [
    {x:5,y:7,type: 'triangle',color: 'green', size: 10,opacity: 0.75,tooltip: 'The first tickmark'},
    {x:7,y:9,type: 'square',color: 'red', size: 15,opacity: 0.5,tooltip: 'The second tickmark'},
    {x:1,y:3,type: 'cross',color: 'cyan', size: 15,opacity: 0.25,tooltip: 'The third tickmark'}
];

Using dates and times instead of numeric x-axis values

Instead of numeric x-axis values, you can instead give a DateTime string that RGraph will parse (using the RGraph.SVG.parseDate function) and use as the value instead. The xaxisScaleMin and xaxisScaleMax values can also be specified like this. The format of the DateTime string can be varied (as you can see from the example below). Here's an example of a DateTime chart.

<script>
    data = [
        {x:'23:59 15-01-2012', y:5},
        {x:'2012 15th February', y:6},
        {x:'Mar 15 2012', y:6},
        {x:'2012/04/15', y:6},
        {x:'2012-05.15', y:5},
        {x:'2012 June 15', y:4},
        {x:'July 2012 15th', y:5},
        {x:'Aug 15th 2012', y:6},
        {x:'15th September 2012', y:7},
        {x:'15 Oct 2012', y:6},
        {x:'2012.11.15', y:4},
        {x:'2012.12-15 00:00:00', y:5}
    ];
    
    new RGraph.SVG.Scatter({
        id: 'chart-container',
        data: data,
        options: {
            backgroundGridVlines: false,
            backgroundGridBorder: false,
            yaxis: false,
            colors: ['red'],
            title: 'A Scatter chart using DateTime values',
            xaxisScaleMin: '2012/01/06 12:14:12',
            xaxisScaleMax: '31st dec 2012'
        }
    }).draw();
</script>

How to specify errorbars

You can specify errorbars on your Scatter chart by using the errorbar option in the data array. The value can be either a simple number or an object which allows you a little extra control. The example code below can be seen in a demo file in the download archive named svg-scatter-errorbars.html.

<script>
    var data1 = [
        {x:1, y:7, errorbar: 3, color: 'red'},
        {x:2, y:5, errorbar: {max: 6, color: 'red', linewidth: 2}, color: 'red'},
        {x:3, y:3, errorbar: {min: 1, max: 1}, color: 'red'}
    ];

    var data = [
        {x:7,  y:7, errorbar: {min: 1, max: null}, color: 'red'},
        {x:8,  y:5, errorbar: {min: 1, max: 1}, color: 'red'},
        {x:10, y:3, errorbar: {min: 1, max: 1}, color: 'red'}
    ];


    new RGraph.SVG.Scatter({
        id: 'chart-container',
        data: [data, data1],
        options: {
            //errorbarsLinewidth: 5,
            //errorbarsCapwidth: 20,
            //errorbarsColor: 'pink',
            marginLeft: 35,
            xaxisScaleMin: 0,
            xaxisScaleMax: 12,
            xaxisLabels: ['Q1', 'Q2','Q3','Q4'],
            tickmarksStyle: 'circle'
        }
    }).draw();
</script>

Using image-based tickmarks

If the list of tickmarks does not suit your needs you can use an image as your tickmark instead. You can specify one by doing this:

<script>
    new RGraph.SVG.Scatter({
        id: 'image-based-tickmarks',
        data: [
            {x: 50, y: 26, type:'image:/images/a.png'},
            {x: 100, y: 26, type:'image:/images/b.png'},
            {x: 150, y: 26, type:'image:/images/c.png'},
            {x: 200, y: 26, type:'image:/images/d.png'},
            {x: 250, y: 26, type:'image:/images/e.png'}
        ],
        options: {
            title: 'A Scatter chart using image-based tickmarks',
            xaxisScaleMin: 0,
            xaxisScaleMax: 365,
            xaxisLabels: ['Jan','Feb','Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec']
        }
    }).draw();
</script>

Adding a line connecting the tickmarks

By using the line option you can have a line connecting the points, therefore, creating a Line chart - but with this Line chart (instead of the regular Line chart ) the points are not necessarily a fixed width apart - the x-axis value is totally down to you along with the y-axis value. The DateTime chart above is also showing an example of using the line option.

With a little configuration, you can use the Scatter chart with this line option to show a Vertical Line chart instead of a horizontal one. There's an example that shows you an example of it in the download archive.

Showing the coordinates using the labelsAbove feature

The Scatter chart has the labelsAbove feature - just like the Bar, Line and Waterfall charts. It's enabled a little differently though. Instead of setting the labelsAbove property to true you set the above property in each points configuration object in the data to true. Like this:

<script>
    var data = [
        {x:0,   y:0,  above:true},
        {x:100, y:5,  above:true},
        {x:84,  y:23, above:true},
        {x:65,  y:46, above:true},
        {x:221, y:18, above:true}
    ];

    new RGraph.SVG.Scatter({
        id: 'chart-container',
        data: data,
        options: {
            xaxisScaleMax: 365,
            xaxisLabels: ['Jan','Feb','Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec']
        }
    }).draw();
</script>

You can then use the labelsAbove configuration properties that are shown below to configure their appearance as normal.

The coordinates properties

The coordinates of all of the marks that are on the Scatter chart are held in the obj.coords and obj.coords2 arrays. The difference between the two is how they're indexed - the obj.coords array is simply a sequential array where each points information is simply appended to the array. The obj.coords2 array on the other hand is indexed by dataset and then by the index in that dataset. So if you have two datasets each having six points then the obj.coords array would look like this:

And the obj.coords2 array would look like this: Each data point is an object that consists of the following:

Properties

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

Background properties

PropertyDescriptionDefault
backgroundColorThe color of the background.null
backgroundImageA URL of an image to render to the background.null
backgroundImageAspectThe aspect ratio setting of the svg image tag, eg it could be XMinYMin meet.none
backgroundImageOpacityThe 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-axis coordinate of the image.null
backgroundImageXIf you're not using the stretch option you can specify the y-axis 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 border 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 labels there are on your scale.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 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-axis coordinate of the image.
Default: null

backgroundImageX
If you're not using the stretch option you can specify the y-axis 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 border 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 labels there are on your scale.
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
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

Tickmark properties

PropertyDescriptionDefault
tickmarksStyleThe style of the tickmarks. This can be a string, or it can also be an array of different types that are used on a per dataset basis. You can also specify the type attribute in the data set (see above). Possible types are:
  • cross
  • image:xxx
  • triangle
  • plus
  • square (or rect)
  • circle (or dot)
cross
tickmarksSizeThe size of the tickmarks. It can be a number or an array of numbers, one for each dataset. This can be overridden on a per-point basis by using the size property in each point's configuration data.7
tickmarksStyle
The style of the tickmarks. This can be a string, or it can also be an array of different types that are used on a per dataset basis. You can also specify the type attribute in the data set (see above). Possible types are:
Default: cross

tickmarksSize
The size of the tickmarks. It can be a number or an array of numbers, one for each dataset. This can be overridden on a per-point basis by using the size property in each point's configuration data.
Default: 7

X-axis properties

PropertyDescriptionDefault
xaxisWhether the x-axis is shown or not.true
xaxisLinewidthThe linewidth that's used to draw the x-axis.1
xaxisTickmarksWhether the x-axis has tickmarks or not.true
xaxisTickmarksLengthThe size of the x-axis tickmarks.5
xaxisColorThe color of the x-axis.black
xaxisLabelsAn array of labels that are spread across the x-axis.null
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
xaxisLabelsOffsetxThe horizontal pixel offset that's added to the x-axis labels. 0
xaxisLabelsOffsetyThe vertical pixel offset that's added to the x-axis labels. 0
xaxisLabelsPositionSectionTickmarksCountNot something you'll use often, if at all. Determines how many tickmarks there are.null
xaxisLabelsPositionEdgeTickmarksCountIf you're showing a scale then you'll probably want to control the number of tickmarks that are displayed. You can do that with this property.10
xaxisLabelsCountThe number of labels that are shown on the x-axis scale.10
xaxisLabelsAngleIf you have long labels you may want to set this to a number between 0 and 90 to enable angled labels.null
xaxisScaleIf set to true then a scale will be shown instead of labels. The scale is based on the xaxisScaleMax value that you set.null
xaxisScaleMaxIf you're using an x-axis scale then you need to set this to control the maximum value that can be plotted on the chart.null
xaxisScaleDecimalsThe number of decimal places that are used for values on the x-axis scale. 0
xaxisScaleUnitsPreUnits that are prepended to the number on the x-axis scale.[an empty string]
xaxisScaleUnitsPostUnits that are appended to the number on the x-axis scale.[an empty string]
xaxisScalePointThe character that's used for the decimal point on the x-axis scale..
xaxisScaleThousandThe character that's used for the thousand separator on the x-axis scale.,
xaxisScaleFormatterUsed by the x-axis scale - this should be a function that's passed two arguments - the object and the number - and should return the number formatted the way you wish.
xaxisFormatter: function (obj, num)
{
    return num;
}
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-axis coordinate of the x-axis title.null
xaxisTitleYBy giving this you can specifically set the y-axis coordinate of the x-axis title.null
xaxisTitleOffsetxThe horizontalpixel offset that's applied to the x-axis title. 0
xaxisTitleOffsetyThe vertical 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: 5

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

xaxisLabels
An array of labels that are spread across the x-axis.
Default: null

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

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

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

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

xaxisLabelsPositionEdgeTickmarksCount
If you're showing a scale then you'll probably want to control the number of tickmarks that are displayed. You can do that with this property.
Default: 10

xaxisLabelsCount
The number of labels that are shown on the x-axis scale.
Default: 10

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

xaxisScale
If set to true then a scale will be shown instead of labels. The scale is based on the xaxisScaleMax value that you set.
Default: null

xaxisScaleMax
If you're using an x-axis scale then you need to set this to control the maximum value that can be plotted on the chart.
Default: null

xaxisScaleDecimals
The number of decimal places that are used for values on the x-axis scale.
Default: 0

xaxisScaleUnitsPre
Units that are prepended to the number on the x-axis scale.
Default: [an empty string]

xaxisScaleUnitsPost
Units that are appended to the number on the x-axis scale.
Default: [an empty string]

xaxisScalePoint
The character that's used for the decimal point on the x-axis scale.
Default: .

xaxisScaleThousand
The character that's used for the thousand separator on the x-axis scale.
Default: ,

xaxisScaleFormatter
Used by the x-axis scale - this should be a function that's passed two arguments - the object and the number - and should return the number formatted the way you wish.
xaxisFormatter: function (obj, num)
{
    return num;
}

Default:

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

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

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

xaxisTitleOffsety
The vertical 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
yaxisColorThe color of the y-axis.black
yaxisLinewidthThe linewidth that's used to draw the y-axis.1
yaxisTickmarksWhether the y-axis has tickmarks or not.true
yaxisTickmarksLengthThe size of the y-axis tickmarks.5
yaxisLabelsIf the yaxisScale option is false then this can be used to give an array of labels that are shown on the y-axis instead.null
yaxisLabelsOffsetxThe horizontal pixel offset that's added to the y-axis labels. 0
yaxisLabelsOffsetyThe vertical 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-axis labels.5
yaxisLabelsPositionEdgeTickmarksCountNot something you'll use often, if at all. Determines how many tickmarks there are.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
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 y-axis scale value.null
yaxisScaleMinThe minimum y-axis scale 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
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-axis coordinate of the y-axis title.null
yaxisTitleYBy giving this you can specifically set the y-axis coordinate of the y-axis title.null
yaxisTitleOffsetxThe horizontal pixel offset that's applied to the y-axis title. 0
yaxisTitleOffsetyThe vertical 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

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

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

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

yaxisTickmarksLength
The size of the y-axis tickmarks.
Default: 5

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

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

yaxisLabelsOffsety
The vertical 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-axis labels.
Default: 5

yaxisLabelsPositionEdgeTickmarksCount
Not something you'll use often, if at all. Determines how many tickmarks there are.
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

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 y-axis scale value.
Default: null

yaxisScaleMin
The minimum y-axis scale 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

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

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

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

yaxisTitleOffsety
The vertical 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
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
labelsAboveWith the Scatter chart labelsAbove isn't enabled by using this property - it's enabled by using the "above" parameter within each points configuration object in the data (the place where you specify the x-axis and y-axis values).N/A - see above
labelsAboveXPointThe decimal point character to use for the labelsAbove labels (this is for the X coordinate).null
labelsAboveXThousandThe thousand separator character to use for the labelsAbove labels (this is for the X coordinate).null
labelsAboveXDecimalsThe number of decimals to use for the labelsAbove labels (this is for the x-axis coordinate). 0
labelsAboveXDecimalsTrimIf there are trailing zeros on the number (only decimals though) by enabling this they will be stripped. This is for the x-axis coordinate.false
labelsAboveXUnitsPreA string to prepend to the labelsAbove labels (this is for the x-axis coordinate).null
labelsAboveXUnitsPostA string to append to the labelsAbove labels (this is for the x-axis coordinate).null
labelsAboveXFormatterA function that handles ALL of the formatting of the number. The function is passed two arguments - the object and the unformatted number. This is for the x-axis coordinate.null
labelsAboveYPointThe decimal point character to use for the labelsAbove labels (this is for the y-axis coordinate).null
labelsAboveYThousandThe thousand separator character to use for the labelsAbove labels (this is for the y-axis coordinate).null
labelsAboveYDecimalsThe number of decimals to use for the labelsAbove labels (this is for the y-axis coordinate). 0
labelsAboveYDecimalsTrimIf there are trailing zeros on the number (only decimals though) by enabling this they will be stripped. This is for the y-axis coordinate.false
labelsAboveYUnitsPreA string to Prepend to the labelsAbove labels (this is for the y-axis coordinate).null
labelsAboveYUnitsPostA string to append to the labelsAbove labels (this is for the y-axis coordinate).null
labelsAboveYFormatterA function that handles ALL of the formatting of the number. The function is passed two arguments - the object and the unformatted number. This is for the y-axis coordinate.null
labelsAboveOffsetxThe horizontal offset of the labelsAbove labels. 0
labelsAboveOffsetyThe vertical offset of the labelsAbove labels.-10
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.rgba(255,255,255,0.7)
labelsAboveBackgroundPaddingThe padding of the labelsAbove labels.2
labelsAboveHalignThe horizontal alignment of the labelsAbove.center
labelsAboveValignThe vertical alignment of the labelsAbove.bottom
labelsAboveSpecificThis property is not used by the Scatter chart. If you wish to specify a literal string then you can do so by setting the above: property in the points object (in the data array) to that string (instead of it simply being true).null
labelsAboveSeparatorThis property allows you to set the comma in the labelsAbove to any character you want. It can be multiple characters if you want.,
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

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

labelsAbove
With the Scatter chart labelsAbove isn't enabled by using this property - it's enabled by using the "above" parameter within each points configuration object in the data (the place where you specify the x-axis and y-axis values).
Default: N/A - see above

labelsAboveXPoint
The decimal point character to use for the labelsAbove labels (this is for the X coordinate).
Default: null

labelsAboveXThousand
The thousand separator character to use for the labelsAbove labels (this is for the X coordinate).
Default: null

labelsAboveXDecimals
The number of decimals to use for the labelsAbove labels (this is for the x-axis coordinate).
Default: 0

labelsAboveXDecimalsTrim
If there are trailing zeros on the number (only decimals though) by enabling this they will be stripped. This is for the x-axis coordinate.
Default: false

labelsAboveXUnitsPre
A string to prepend to the labelsAbove labels (this is for the x-axis coordinate).
Default: null

labelsAboveXUnitsPost
A string to append to the labelsAbove labels (this is for the x-axis coordinate).
Default: null

labelsAboveXFormatter
A function that handles ALL of the formatting of the number. The function is passed two arguments - the object and the unformatted number. This is for the x-axis coordinate.
Default: null

labelsAboveYPoint
The decimal point character to use for the labelsAbove labels (this is for the y-axis coordinate).
Default: null

labelsAboveYThousand
The thousand separator character to use for the labelsAbove labels (this is for the y-axis coordinate).
Default: null

labelsAboveYDecimals
The number of decimals to use for the labelsAbove labels (this is for the y-axis coordinate).
Default: 0

labelsAboveYDecimalsTrim
If there are trailing zeros on the number (only decimals though) by enabling this they will be stripped. This is for the y-axis coordinate.
Default: false

labelsAboveYUnitsPre
A string to Prepend to the labelsAbove labels (this is for the y-axis coordinate).
Default: null

labelsAboveYUnitsPost
A string to append to the labelsAbove labels (this is for the y-axis coordinate).
Default: null

labelsAboveYFormatter
A function that handles ALL of the formatting of the number. The function is passed two arguments - the object and the unformatted number. This is for the y-axis coordinate.
Default: null

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

labelsAboveOffsety
The vertical offset of the labelsAbove labels.
Default: -10

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: rgba(255,255,255,0.7)

labelsAboveBackgroundPadding
The padding of the labelsAbove labels.
Default: 2

labelsAboveHalign
The horizontal alignment of the labelsAbove.
Default: center

labelsAboveValign
The vertical alignment of the labelsAbove.
Default: bottom

labelsAboveSpecific
This property is not used by the Scatter chart. If you wish to specify a literal string then you can do so by setting the above: property in the points object (in the data array) to that string (instead of it simply being true).
Default: null

labelsAboveSeparator
This property allows you to set the comma in the labelsAbove to any character you want. It can be multiple characters if you want.
Default: ,

Line properties

PropertyDescriptionDefault
lineThis can either be a boolean or an array of booleans that determine whether a line is drawn connecting the points (for each dataset).false
lineColorsThis can either be a string or an array of strings that determine the colors of the lines that are drawn.black
lineLinewidthThis can either be a number or an array of numbers that determine the colors of the lines that are drawn.black
line
This can either be a boolean or an array of booleans that determine whether a line is drawn connecting the points (for each dataset).
Default: false

lineColors
This can either be a string or an array of strings that determine the colors of the lines that are drawn.
Default: black

lineLinewidth
This can either be a number or an array of numbers that determine the colors of the lines that are drawn.
Default: black

Key properties

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

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

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

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

keyLabelsFont
The font to use for the key text. If not specified it defaults to the textFont setting.
Default: null

keyLabelsSize
The size to use for the key text. If not specified then the textSize is used.
Default: null

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

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

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

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

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

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

Tooltip properties

PropertyDescriptionDefault
tooltipsThis is a dummy entry as the tooltip for a point on the Scatter chart is given as part of the data that you give in the initial configuration when you create the chart. 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: "1px 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
tooltipsPointerOffsetxThis allows you to adjust the horizontal position of the tooltips pointer. 0
tooltipsPointerOffsetyThis allows you to adjust the vertical position of the tooltips pointer. 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.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
highlightFillThe fill color that's used when highlighting the chart.rgba(255,255,255,0.7)
tooltips
This is a dummy entry as the tooltip for a point on the Scatter chart is given as part of the data that you give in the initial configuration when you create the chart. 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: "1px 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

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

tooltipsPointerOffsety
This allows you to adjust the vertical position of the tooltips pointer.
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.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

highlightFill
The fill color that's used when highlighting the chart.
Default: rgba(255,255,255,0.7)

Title properties

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

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

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

titleOffsetx
An offset value that is added to the calculated x-axis coordinate.
Default: 0

titleOffsety
An offset value that is added to the calculated y-axis coordinate.
Default: 0

titleHalign
The horizontal alignment of the title.
Default: center

titleColor
The color of the title.
Default: null

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

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

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

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

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

titleSubtitleColor
The color of the subtitle.
Default: #aaa

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

titleSubtitleSize
The size of the font used to render the subtitle. It defaults to be slightly smaller than the textSize setting.
Default: null

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

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

Bubble chart properties

PropertyDescriptionDefault
bubbleWhether your Scatter chart should be drawn as a Bubble chart. As well as x-axis and y-axis coordinates, Bubble charts also require a Z coordinate. You can see an example of a Bubble chart in the download archive.false
bubbleMaxValueThe maximum value that the bubbles have (the maximum Z value).null
bubbleMaxRadiusThe maximum radius that bubbles can have. So Z values that equal the maximum Z value (as defined with the above property) will be this wide.null
bubbleColorsSolidBy default the bubbles are drawn using a gradient so that they have a 3D appearance. You can turn this off and have flat bubbles with this option.false
bubble
Whether your Scatter chart should be drawn as a Bubble chart. As well as x-axis and y-axis coordinates, Bubble charts also require a Z coordinate. You can see an example of a Bubble chart in the download archive.
Default: false

bubbleMaxValue
The maximum value that the bubbles have (the maximum Z value).
Default: null

bubbleMaxRadius
The maximum radius that bubbles can have. So Z values that equal the maximum Z value (as defined with the above property) will be this wide.
Default: null

bubbleColorsSolid
By default the bubbles are drawn using a gradient so that they have a 3D appearance. You can turn this off and have flat bubbles with this option.
Default: false

Error bar properties

PropertyDescriptionDefault
errorbarsThis is just a placeholder - with Scatter charts the errorbar information is supplied in each points object within the data array.No errorbars are shown by default
errorbarsColorThe default color of the errorbars. This can be overridden using the color setting if you give an object as the errorbar property in the data array.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 property in the data array.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 property in the data array.10
errorbars
This is just a placeholder - with Scatter charts the errorbar information is supplied in each points object within the data array.
Default: No errorbars are shown by default

errorbarsColor
The default color of the errorbars. This can be overridden using the color setting if you give an object as the errorbar property in the data array.
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 property in the data array.
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 property in the data array.
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 the colors for the trend line(s). It should be an array of colors even if you only have one line.[gray]
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
trendlineDashedIf true then the trend lines on the chart will be dashed.true
trendlineDottedIf true then the trend lines on the chart will be dotted,false
trendlineDashArrayIf you want to give your own style of dashes then you can with this. It should be an array containing numbers - alternating between the length of a dash and the length of a gap after the dash.null
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 the colors for the trend line(s). It should be an array of colors even if you only have one line.
Default: [gray]

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

trendlineDashed
If true then the trend lines on the chart will be dashed.
Default: true

trendlineDotted
If true then the trend lines on the chart will be dotted,
Default: false

trendlineDashArray
If you want to give your own style of dashes then you can with this. It should be an array containing numbers - alternating between the length of a dash and the length of a gap after the dash.
Default: null

Miscellaneous properties

PropertyDescriptionDefault
outofboundsIf you have the y-axis minimum and/or maximum values set but still want to show values that fall outside these bounds then you can set this property to true.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 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
outofbounds
If you have the y-axis minimum and/or maximum values set but still want to show values that fall outside these bounds then you can set this property to true.
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: 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)

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

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

obj.getYCoord(value)

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

obj.on(event, handler)

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

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

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

obj.exec(function (obj)
{
    // Put your code here
});
obj.responsive(configuration)

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

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

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

Data properties that are used on the tickmarks

The svg elements that represent the tickmarks (eg path, circle elements) on the Scatter chart have various data attributes added to them that hold various bits of information. These are:

These can be retrieved by using standard dom methods:

obj.coords[0].element.getAttribute('data-index');

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.Scatter({
    id: 'chart-container',
    data: [
        {x:355, y:18, color: 'red'},  {x: 25, y:35, color: 'red'},
        {x:120, y:23, color: 'red' }, {x: 65, y:46, color: 'red'},
    ],
    options: {
        xaxisScaleMax: 365
    }
}).on('tooltip', function (obj)
{
    console.log('The draw event has fired');
    
}).draw();