Scatter chart API reference
Summary: Documentation about the Scatter chart including information about all of the options that are available to you. The Scatter chart can show various points on X/Y scales as well as a time scale. The Scatter chart is quite versatile and can be used to show a variety of different types of data.
- Example
- Format of the data array (colors/tooltips)
- Properties
- Methods
- Custom RGraph events that are available
- Box/Whisker (candlestick) plots
- Specific points for labels on the X axis
- Custom tickmarks
- Note about colors and the key
- Note about the crosshairs event
- Adding a trend line to your chart
- Note about the data_arr array
- Date/time based charts
- Bubble charts
- Animation effects
Example
<script> tooltip = '%{key}'; new RGraph.Scatter({ id: 'cvs', data: [ [ [10,78,null,tooltip], [20,69,null,tooltip], [34,42,null,tooltip], [35,66,null,tooltip], [46,45,null,tooltip], [64,38,null,tooltip], [78,29,null,tooltip], [78,34,null,tooltip], [112,26,null,tooltip], [119,15,null,tooltip] ], [ [186,54,'red',tooltip], [195,56,'red',tooltip], [210,58,'red',tooltip], [214,53,'blue',tooltip], [233,51,'red',tooltip], [245,48,'red',tooltip], [270,61,'red',tooltip], [281,43,'red',tooltip], [299,52,'red',tooltip], [312,77,'red',tooltip] ] ], options: { tooltipsFormattedKeyLabels: ['Richard','John','Luis','Pob','Pete','Olga','Kiffen','Hevin','Joy','Hoolio'], tooltipsFormattedKeyColors: ['black','red'], tooltipsCss: { fontSize: '16pt', boxShadow: '', textAlign: 'left' }, trendline: true, trendlineColor: ['gray','red'], trendlineMargin: 5, backgroundGridBorder: false, backgroundGridVlines: false, yaxis: false, backgroundGridColor: '#eee', marginLeft: 30, xaxisLabels: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'], xaxisScaleMax: 365, tickmarksSize: 10 } }).draw(); </script>
Format of the data array (colors/tooltips)
Each point on the Scatter chart is made by supplying an array of up to 4 elements:
- The X value (required)
- The Y value (required). As well as a single number this can also be an array of numbers that describe a boxplot/whisker.
- The color (optional)
- The tooltip for this mark (optional)
If you wish to specify a tooltip, but not a color (ie use the default color instead), you can pass null instead of a color.
<script> // A regular dataset data = [ [67,78], // A basic datapoint [67,40,'red'], // A datapoint with a color specified [150,26,'green','A tooltip!'], // A datapoint with a color and tooltip specified [164,35, null, 'Just the tooltip'], // A datapoint with no color and a tooltip [203,53] ]; new RGraph.Scatter({ id: 'cvs', data: data, options: { xaxisScaleMax: 365 } }).draw(); </script>
Properties
You can use these properties to control how the chart appears. You can set them by including them in the options section of the configuration as above.
- Background properties
- X axis properties
- Y axis properties
- Color properties
- Other label properties
- Margin properties
- Tickmark properties
- Title properties
- Interactive features properties
- Line properties
- Trend line properties
- Bubble properties
- Key properties
- Miscellaneous properties
Background properties
If you want to have a single background color for your chart you can use this. It doesn't cover the margins. If you want that then you can simply apply a CSS background color to the canvas tag.
Default: null
backgroundBarsCount
The number of background bars.
Default: 5
backgroundBarsColor1
The color of the background bars. (1 of 2).
Default: rgba(0,0,0,0)
backgroundBarsColor2
The color of the background bars. (2 of 2).
Default: rgba(0,0,0,0)
backgroundGrid
Whether to show the background grid or not.
Default: true
backgroundGridColor
The color of the background grid.
Default: #eee
backgroundHbars
An array of information stipulating horizontal colored bars. You can use these to indicate limits. Eg:
myScatter.set('backgroundHbars', [[75, 10, 'yellow'], [85, 15, 'red']]);This would give you two bars, one red and a lower yellow bar. The units correspond to your scale, and are the starting point and the height.
Default: null
backgroundVbars
An array of vertical bar information. They're specified like his:
myScatter.set('backgroundVbars', [[0, 181, 'rgba(0,255,0,0.5)']]);Normally the values are:
- The start value
- The extent of the bar (the width in scale terms)
- The color
obj.set('backgroundVbars', [['2013/06/01','2013/07/01','pink']]);
Default: null
backgroundGridBorder
Determines whether a border line is drawn around the grid.
Default: true
backgroundGridHlines
Determines whether to draw the horizontal grid lines.
Default: true
backgroundGridVlines
Determines whether to draw the vertical grid lines.
Default: true
backgroundGridHlinesCount
When using autofit this allows you to specify how many horizontal grid lines you want.
Default: 5
backgroundGridVlinesCount
When using autofit this allows you to specify how many vertical grid lines you want.
Default: 20
backgroundGridAlign
If you want to have your grid lines line up with the labels (both X and Y axes), you can set this to true and RGraph will attempt to make the grid lines line up.
Default: false
backgroundImage
If you want to specify a background image to use on your chart, specify it with this property. If you use effects with a background image on your chart it may make the effect flicker. Using a background image with the
draw
event may mean that the event fires twice. There is a property that you can check though that is set when the image has loaded: obj.__rgraph_background_image_loaded__
Simply check this flag in your draw
event. If it's true then the background image has loaded.Default: null
backgroundImageStretch
By default your background image is stretched (if necessary) to cover the whole chart area (margins not included). If this is not what you want then set this property to false.
Default: true
backgroundImageX
The X position of the image. The coordinates are the top left corner of the image.
Default: null
backgroundImageY
The Y position of the image. The coordinates are the top left corner of the image.
Default: null
backgroundImageW
The width of the image. If you have a large canvas with many charts - you may need to specify this.
Default: null
backgroundImageH
The height of the image. If you have a large canvas with many charts - you may need to specify this.
Default: null
backgroundImageAlign
Instead of specifying the coordinates of the image, you can instead simply align it top, bottom, left or right. Examples are:
top left
bottom right
bottom
right
Default: null
backgroundImageAlpha
The alpha value (the opacity) of the image.
Default: 1
X axis properties
Set this to true if you don't want an X axis.
Default: true
xaxisPosition
This determines where the X axis is positioned. If you wish to show negative values then you should set this to
center
or you can now (Jul 2016) use an offset X axis by leaving this property at the default bottom
and using the yaxisScaleMax
and yaxisScaleMin
properties.Default: bottom
xaxisLinewidth
The linewidth used for the X axis and the X axis tickmarks.
Default: 1
xaxisColor
The color of the X axis (and its tickmarks.
Default: black
xaxisTickmarks
Whether the X axis tickmarks are shown.
Default: true
xaxisTickmarksLastLeft
Whether the last tickmark on the left is displayed.
Default: null
xaxisTickmarksLastRight
Whether the last tickmark on the right is displayed.
Default: null
xaxisTickmarksLength
The length of the tickmarks.
Default: 3
xaxisTickmarksCount
The number of tickmarks that are shown on the X axis.
Default: null
xaxisLabels
An array of the labels to be used on the chart.
Default: An empty array
xaxisLabelsFont
The font used to render the labels.
Default: null
xaxisLabelsSize
The size of the labels.
Default: null
xaxisLabelsColor
The color of the labels.
Default: null
xaxisLabelsBold
Whether the labels are bold or not.
Default: null
xaxisLabelsItalic
Whether the labels are italic or not.
Default: null
xaxisLabelsOffsetx
This allows you finer grained control in the horizontal direction over the X label positioning if you need it.
Default: 0
xaxisLabelsOffsety
This allows you finer grained control in the vertical direction over the X label positioning if you need it.
Default: 0
xaxisLabelsHalign
The horizontal alignment of the labels.
Default: center
xaxisLabelsValign
The vertical alignment of the labels.
Default: top
xaxisLabelsAngle
The angle of the X axis labels. For example you could set this to 45 to get angled labels.
Default: 0 (Horizontal)
xaxisLabelsPosition
This property controls how the labels are arranged -
section
for most chart types and edge
for Line charts. You probably won't need to change this.Default: section
xaxisLabelsSpecificAlign
This determines the alignment of the specific labels. You probably won't need this.
Default: left
xaxisScale
If true then an X scale is drawn instead of X labels.
Default: false
xaxisScaleUnitsPre
These are units that are prepended to the number.
Default: none
xaxisScaleUnitsPost
These are units that are appended to the number.
Default: none
xaxisScaleDecimals
The number of decimals used for the X scale. If not specified the
scaleDecimals
property is used.Default: null
xaxisScaleFormatter
This can be a function, which is passed the object and the number and should return a formatted number (formatted as you wish).
function myFormatter(opt) { var obj = opt.object, num = opt.number; return num + 'F'; // An example of formatting }
Default: null
xaxisScaleLabelsCount
This is a number representing how many X labels there should be when you're using the X scale.
Default: 10
xaxisScaleMin
The minimum X axis value you wish to set.
Default: 0
xaxisScaleMax
The maximum X axis value you wish to set. For example if you're displaying products sold in a year, you might use 365.
Default: none - must be supplied
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 title.
Default: 0
xaxisTitleOffsety
The Y pixel offset that's applied to the title.
Default: 0
xaxisTitleHalign
The horizontal alignment of the title.
Default: center
xaxisTitleValign
The vertical alignment of the title.
Default: top
xaxisTitlePos
This is a multiplier (ie a digit usually between 0 and 1) that gets multiplied with the margin to get the Y position of the title.
Default: null
Y axis properties
Whether the Y axis is drawn.
Default: true
yaxisPosition
Specifies the Y axis position. Can be
left
or right
.Default: left
yaxisLinewidth
The linewidth of the Y axis.
Default: 1
yaxisColor
The color of the Y axis.
Default: black
yaxisTickmarks.
Whether the Y axis tickmarks are drawn.
Default: true
yaxisTickmarksLength
The length of the Y axis tickmarks.
Default: 3
yaxisTickmarksCount
This allows you to stipulate how many Y axis tickmarks there are.
Default: null (related to how many labels there are)
yaxisTickmarksLastTop
Whether the top-most tickmark is drawn.
Default: null (displayed if the X axis position warrants it)
yaxisTickmarksLastBottom
Whether the bottom-most tickmark is drawn.
Default: null (displayed if the X axis position warrants it)
yaxisLabelsCount
A value that controls how many Y labels there are. This value could formerly be either 1/3/5/10 however now it can be any number.
Default: 5
yaxisLabelsSpecific
You can use this option to give your own Y labels (eg
['Low', 'Medium', 'High']
. Note: Since March 2013 you may now need to add an extra (optionally) empty element to the array of labels to achieve your desired result.Default: null
yaxisLabelsPosition
This controls how the specific labels are positioned on the Y axis. It has no effect on a scale.
Default: edge
yaxisLabelsOffsetx
This allows you finer grained control in the horizontal direction over the Y label positioning if you need it.
Default: 0
yaxisLabelsOffsety
This allows you finer grained control in the vertical direction over the Y label positioning if you need it.
Default: 0
yaxisLabelsFont
The font that's used by the Y axis labels.
Default: null
yaxisLabelsSize
The size of the Y axis labels.
Default: null
yaxisLabelsColor
The color of the Y axis labels.
Default: null
yaxisLabelsBold
Whether the Y axis labels are bold or not.
Default: null
yaxisLabelsItalic
Whether the Y axis labels are italic or not.
Default: null
yaxisLabelsHalign
The horizontal alignment of the Y axis labels.
Default: null
yaxisLabelsValign
The vertical alignment of the Y axis labels.
Default: null
yaxisTitle
This allows you to specify a title for the Y axis.
Default: none
yaxisTitleSize
This allows you to specify a size for the Y axis title.
Default: null
yaxisTitleFont
This allows you to specify a font for the Y axis title.
Default: null
yaxisTitleBold
This controls whether the Y axis title is bold or not.
Default: null
yaxisTitleColor
This controls what color the Y axis title is.
Default: null
yaxisTitleItalic
This controls whether the Y axis title is italic or not.
Default: null
yaxisTitlePos
This is multiplied with the margin to give the position of the Y axis title.
Default: 0.25
yaxisTitleOffsetx
The pixel offset that's added to the Y axis titles X coordinate.
Default: 0
yaxisTitleOffsety
The pixel offset that's added to the Y axis titles Y coordinate.
Default: 0
yaxisTitleX
By giving this you can specifically set the X 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
yaxisTitleHalign
The horizontal alignment of the Y axis title.
Default: 0
yaxisTitleValign
The vertical alignment of the Y axis title.
Default: 0
yaxisTitleAccessible
With this property you can control whether the Y axis title is accessible or not.
Default: true
yaxisScale
Whether the Y axis scale is displayed or not.
Default: true
yaxisScaleRound
Whether the Y axis scale is rounded up or not.
Default: false
yaxisScaleUnitsPre
The units that the Y axis is measured in. This string is displayed before the actual number, allowing you to specify values such as "$50".
Default: none
yaxisScaleUnitsPost
The units that the Y axis is measured in. This string is displayed after the actual number, allowing you to specify values such as "50ms".
Default: none
yaxisScaleMax
The optional maximum Y scale value. If not specified then it will be calculated.
Default: null (It's calculated)
yaxisScaleMin
The optional minimum Y scale value. If not specified then it will be 0.
Default: 0
yaxisScaleFormatter
To allow thoroughly custom formats of numbers in the scale, you can use this option to specify a function that is used by RGraph to format numbers. This function should handle ALL of the formatting. Eg:
function myFormatter(opt) { var num = Number(opt.number) * 5; return String(num) } obj.set('yaxisScaleFormatter', myFormatter);
Default: null
yaxisScaleRound
Whether to round the scale up. eg A maximum value of 59 results in scale to 100.
Default: false
yaxisScaleDecimals
The number of decimal places to display for the Y scale.
Default: 0
yaxisScalePoint
The character used as the decimal point.
Default: .
yaxisScaleThousand
The character used as the thousand separator.
Default: ,
yaxisScaleInvert
Whether the Y axis scale is inverted or not.
Default: false
Color properties
This is the default color of tickmarks, which is used if a color isn't given.
Default: #000
colorsBubbleGraduated
By default the Bubble chart bubbles are graduated in color. By setting this to false you can disable the gradients and use flat colors.
Default: true
Other label properties
Property | Description | Default |
---|---|---|
labelsAbove | If true this will show the values of the points above them. | false |
labelsAboveFont | The font used to render the text. | null |
labelsAboveSize | If you're showing the labels above the points, this controls their size. | null |
labelsAboveColor | The color of the text. | null |
labelsAboveBold | Whether the labels are bold or not. | null |
labelsAboveItalic | Whether the labels are italic or not. | null |
labelsAboveDecimals | If your points have lots of decimals, you use this option to curtail them. | |
labelsAboveFormatterX | If you need to format the X value then you can use this function to do so. An example function to format a datetime value is: labelsAboveFormatterX: function (obj, value) { var d = new Date(value); date = d.getDate(); month = d.getMonth(); year = d.getFullYear(); return '{1}/{2}/{3}'.format(date, month, year); }, | null |
labelsAboveFormatterY | If you need to format the X value then you can use this function to do so. An example function to format a datetime value is: labelsAboveFormatterY: function (obj, value) { return value; }, | null |
textFont | The font used to render the text. | Arial |
textColor | The color of the labels. | black |
textSize | The size of the text (in points). | 12 |
textBold | Whether the text is bold or not. | false |
textItalic | Whether the text is bold or not. | false |
textAccessible | A new feature in 2016 that allows you to use DOM text in place of canvas text. It makes for much higher quality text that you can also select if desired (for copy/paste operations). It won't fit all situations and you can read more about the DOM text feature here. A good way to control borders/margins/padding etc is not to set them on the canvas but to wrap the canvas in a div and set them on that like this: <div style="margin-left: 50px; display: inline-block"> | true |
textAccessibleOverflow | This can be visible or hidden and it controls whether the text is clipped to the edges of the canvas. It defaults to be visible and means you can set small margins if you wish. | visible |
textAccessiblePointerevents | This controls whether the DOM text responds to mouse based events or not (it sets the pointer-events CSS property to none ). | true |
If true this will show the values of the points above them.
Default: false
labelsAboveFont
The font used to render the text.
Default: null
labelsAboveSize
If you're showing the labels above the points, this controls their size.
Default: null
labelsAboveColor
The color of the text.
Default: null
labelsAboveBold
Whether the labels are bold or not.
Default: null
labelsAboveItalic
Whether the labels are italic or not.
Default: null
labelsAboveDecimals
If your points have lots of decimals, you use this option to curtail them.
Default: 0
labelsAboveFormatterX
If you need to format the X value then you can use this function to do so. An example function to format a datetime value is:
labelsAboveFormatterX: function (obj, value) { var d = new Date(value); date = d.getDate(); month = d.getMonth(); year = d.getFullYear(); return '{1}/{2}/{3}'.format(date, month, year); },
Default: null
labelsAboveFormatterY
If you need to format the X value then you can use this function to do so. An example function to format a datetime value is:
labelsAboveFormatterY: function (obj, value) { return value; },
Default: null
textFont
The font used to render the text.
Default: Arial
textColor
The color of the labels.
Default: black
textSize
The size of the text (in points).
Default: 12
textBold
Whether the text is bold or not.
Default: false
textItalic
Whether the text is bold or not.
Default: false
textAccessible
A new feature in 2016 that allows you to use DOM text in place of canvas text. It makes for much higher quality text that you can also select if desired (for copy/paste operations). It won't fit all situations and you can read more about the DOM text feature here. A good way to control borders/margins/padding etc is not to set them on the canvas but to wrap the canvas in a div and set them on that like this:
<div style="margin-left: 50px; display: inline-block">
<canvas id="cvs" width="650" height="250"></canvas>
</div>
Default: true
textAccessibleOverflow
This can be
visible
or hidden
and it controls whether the text is clipped to the edges of the canvas. It defaults to be visible and means you can set small margins if you wish.Default: visible
textAccessiblePointerevents
This controls whether the DOM text responds to mouse based events or not (it sets the
pointer-events
CSS property to none
).Default: true
Margin properties
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
Property | Description | Default |
---|---|---|
tickmarksStyle | The style of the tickmarks. Can be: cross , plus , circle , diamond , square or null (no tickmarks). As of August 2014 this can be a location of an image file to use as the tickmarks or a data: URL. See below for details. | cross |
tickmarksSize | The size of the tickmarks. | 3 |
tickmarksStyleImageHalign | This can be left right or center and determines the horizontal alignment of the tickmark. | center |
tickmarksStyleImageValign | This can be top bottom or center and determines the vertical alignment of the tickmark. | center |
tickmarksStyleImageOffsetx | After the alignment has been applied, this is added to the X coordinate of the tickmark. | |
tickmarksStyleImageOffsety | After the alignment has been applied, this is added to the Y coordinate of the tickmark. |
The style of the tickmarks. Can be:
cross
, plus
, circle
, diamond
, square
or null
(no tickmarks). As of August 2014 this can be a location of an image file to use as the tickmarks or a data: URL. See below for details.Default: cross
tickmarksSize
The size of the tickmarks.
Default: 3
tickmarksStyleImageHalign
This can be
left
right
or center
and determines the horizontal alignment of the tickmark.Default: center
tickmarksStyleImageValign
This can be
top
bottom
or center
and determines the vertical alignment of the tickmark.Default: center
tickmarksStyleImageOffsetx
After the alignment has been applied, this is added to the X coordinate of the tickmark.
Default: 0
tickmarksStyleImageOffsety
After the alignment has been applied, this is added to the Y coordinate of the tickmark.
Default: 0
Title properties
The title of the scatter chart.
Default: none
titleFont
The font that the title is rendered in. If not specified the
textFont
setting is used (usually Arial).Default: null
titleSize
The size of the title. If not specified the size is usually 2pt bigger than the
textSize
setting.Default: null
titleColor
The color of the title.
Default: black
titleBold
Whether the title is bold or not.
Default: null
titleItalic
Whether the title is italic or not.
Default: null
titleBackground
The background color (if any) for the title.
Default: null
titleX
To give the exact X coordinate for the title - use this. This can also be a string like this: "-5" -- in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.
Default: null
titleY
To give the exact Y coordinate for the title - use this. This can also be a string like this: "-5" -- in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.
Default: null
titleHalign
The horizontal alignment of the title.
Default: center (can change depending on other options)
titleValign
The vertical alignment of the title.
Default: center (can change depending on other options)
Interactive features properties
Property | Description | Default |
---|---|---|
tooltipsEffect | The effect used for showing tooltips. Can be either fade or none . | fade |
tooltipsHotspot | This controls the size of the hotspot on the chart for tooltips. | 3 |
tooltipsHighlight | Set this to false if you don't want your charts to be highlighted. | true |
tooltipsOverride | If you wish to handle showing tooltips yourself, this should be a function object which does just that. There's more information in the tooltips documentation page. | null |
tooltipsNohideonclear | Not an option that you'll need particularly often if at all. Setting this to true means that when you call the RGraph.clear() API function tooltips do not get hidden. | false |
tooltipsFormattedPoint | When using formatted tooltip strings this is used as the point when using the %{value_formatted} option. | . |
tooltipsFormattedThousand | When using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option. | , |
tooltipsFormattedDecimals | When using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option. | |
tooltipsFormattedUnitsPre | When using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option. | (an empty string) |
tooltipsFormattedUnitsPost | When using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option. | (an empty string) |
tooltipsFormattedKeyColors | When using formatted tooltip strings you can give specific colors for the %{key} option to use. | null |
tooltipsFormattedKeyColorsShape | This is the shape that's used in the tooltip key. It can be square or circle | 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"; } | null |
tooltipsFormattedKeyLabels | When using formatted tooltip strings these are the labels that are displayed. | [] (an empty array) |
tooltipsFormattedListType | With this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol . | 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; } | 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. | null |
tooltipsFormattedTableData | This is the data that is added to the table. This is a 3-dimensional array so it's easy to make a mistake. See the example, copy the code from it and then modify it suit. You'll create fewer bugs this way. | 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. | true |
tooltipsPointerCss | If you want any CSS values applied to the tooltips pointer (for example a CSS border) then specify an object containing those values to this property. For example: tooltips: { borderLeft: 'gray 2px solid', borderBottom: 'gray 2px solid' } | 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. | true |
tooltipsCss | If you want to specify some CSS that gets applied to all of the tooltips, but don't want to use the RGraph.tooltips.style object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object CSS for the tooltips. These are CSS styles that get applied to all of the tooltips for the specific object only. It should look like this:tooltipsCss: { fontFamily: 'Verdana', fontSize: '20pt' } | null |
tooltipsCssClass | This is the name of the CSS class the chart uses. | RGraph_tooltip |
tooltipsOffsetx | This property allows you to shift the tooltips left or right. | |
tooltipsOffsety | This property allows you to shift the tooltips up or down. | |
crosshairs | If true, you will get a crosshair centring on the current mouse position. | false |
crosshairsLinewidth | This controls the linewidth of the crosshairs. | 1 |
crosshairsColor | The color of the crosshairs. | #333 |
crosshairsCoords | If true, this will show the coordinates that the crosshairs are currently over. | false |
crosshairsCoordsFixed | If true, this makes the coordinates static (attached), instead of following the pointer around. | false |
crosshairsCoordsLabelsX | Instead of X and Y, you can specify more meaningful labels. | X |
crosshairsCoordsLabelsY | Instead of X and Y, you can specify more meaningful labels. | Y |
crosshairsCoordsFormatterX | This can be a function with which you can format the value to appear just as you want. Simply return the value that you wish to be displayed. The single argument is an object that has two properties: object (which is the chart object) and value (which is the X value). | null |
crosshairsCoordsFormatterY | This can be a function with which you can format the value to appear just as you want. Simply return the value that you wish to be displayed. The single argument is an object that has two properties: object (which is the chart object) and value (which is the Y value). | null |
crosshairsHline | This determines whether the horizontal crosshair line is shown. | true |
crosshairsVline | This determines whether the vertical crosshair line is shown. | true |
contextmenu | An array of context menu items. More information about context menus is here. | An empty array |
annotatable | Whether annotations are enabled for the chart (ie you can draw on the chart interactively. | false |
annotatableColor | If you do not allow the use of the palette, then this will be the only color allowed for annotations. | black |
annotatableLinewidth | This is the linewidth of the annotations. | 1 |
The effect used for showing tooltips. Can be either
fade
or none
.Default: fade
tooltipsHotspot
This controls the size of the hotspot on the chart for tooltips.
Default: 3
tooltipsHighlight
Set this to false if you don't want your charts to be highlighted.
Default: true
tooltipsOverride
If you wish to handle showing tooltips yourself, this should be a function object which does just that. There's more information in the tooltips documentation page.
Default: null
tooltipsNohideonclear
Not an option that you'll need particularly often if at all. Setting this to true means that when you call the
RGraph.clear()
API function tooltips do not get hidden.Default: false
tooltipsFormattedPoint
When using formatted tooltip strings this is used as the point when using the %{value_formatted} option.
Default: .
tooltipsFormattedThousand
When using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.
Default: ,
tooltipsFormattedDecimals
When using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option.
Default: 0
tooltipsFormattedUnitsPre
When using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.
Default: (an empty string)
tooltipsFormattedUnitsPost
When using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.
Default: (an empty string)
tooltipsFormattedKeyColors
When using formatted tooltip strings you can give specific colors for the
%{key}
option to use.Default: null
tooltipsFormattedKeyColorsShape
This is the shape that's used in the tooltip key. It can be
square
or circle
Default: square
tooltipsFormattedKeyColorsCss
By using this property you can add CSS values to the key color shape that appears in the tooltip key. Note the property name is "color" and not "colors" like previous properties. It should be an object of CSS properties like this:
tooltipsFormattedKeyColorsCss : { border: "1 px solid #ddd"; }
Default: null
tooltipsFormattedKeyLabels
When using formatted tooltip strings these are the labels that are displayed.
Default: [] (an empty array)
tooltipsFormattedListType
With this property you can switch between an unordered list (the default) and an ordered list. Possible values are
ul
and ol
.Default: ul
tooltipsFormattedListItems
This should be a two-dimension array of the list items that are to be shown for all of the tooltips. An example of this property is:
tooltipsFormattedListItems: [ ['Bill','Jerry','Berty'], // First tooltip ['Gill','Carrie','Lucy'], // Second tooltip ['Pob','Nobby','Hilda'] // Third tooltip ]You can use CSS to style this list - for example:
.RGraph_tooltip ul#rgraph_formatted_tooltips_list li { text-align: left; color: yellow; }
Default: null
tooltipsFormattedTableHeaders
When showing a table in the tooltips this can be an array of headers for the table. These are added to the tooltip using
<th>
tags.Default: null
tooltipsFormattedTableData
This is the data that is added to the table. This is a 3-dimensional array so it's easy to make a mistake. See the example, copy the code from it and then modify it suit. You'll create fewer bugs this way.
Default: null)
tooltipsPointer
By default the tooltips have a small triangular pointer that points to the shape that was clicked on. You can turn this off with this property.
Default: true
tooltipsPointerCss
If you want any CSS values applied to the tooltips pointer (for example a CSS border) 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.tooltips.style
object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object CSS for the tooltips. These are CSS styles that get applied to all of the tooltips for the specific object only. It should look like this:tooltipsCss: { fontFamily: 'Verdana', fontSize: '20pt' }
Default: null
tooltipsCssClass
This is the name of the CSS class the chart uses.
Default: RGraph_tooltip
tooltipsOffsetx
This property allows you to shift the tooltips left or right.
Default: 0
tooltipsOffsety
This property allows you to shift the tooltips up or down.
Default: 0
crosshairs
If true, you will get a crosshair centring on the current mouse position.
Default: false
crosshairsLinewidth
This controls the linewidth of the crosshairs.
Default: 1
crosshairsColor
The color of the crosshairs.
Default: #333
crosshairsCoords
If true, this will show the coordinates that the crosshairs are currently over.
Default: false
crosshairsCoordsFixed
If true, this makes the coordinates static (attached), instead of following the pointer around.
Default: false
crosshairsCoordsLabelsX
Instead of X and Y, you can specify more meaningful labels.
Default: X
crosshairsCoordsLabelsY
Instead of X and Y, you can specify more meaningful labels.
Default: Y
crosshairsCoordsFormatterX
This can be a function with which you can format the value to appear just as you want. Simply return the value that you wish to be displayed. The single argument is an object that has two properties:
object
(which is the chart object) and value
(which is the X value).Default: null
crosshairsCoordsFormatterY
This can be a function with which you can format the value to appear just as you want. Simply return the value that you wish to be displayed. The single argument is an object that has two properties:
object
(which is the chart object) and value
(which is the Y value).Default: null
crosshairsHline
This determines whether the horizontal crosshair line is shown.
Default: true
crosshairsVline
This determines whether the vertical crosshair line is shown.
Default: true
contextmenu
An array of context menu items. More information about context menus is here.
Default: An empty array
annotatable
Whether annotations are enabled for the chart (ie you can draw on the chart interactively.
Default: false
annotatableColor
If you do not allow the use of the palette, then this will be the only color allowed for annotations.
Default: black
annotatableLinewidth
This is the linewidth of the annotations.
Default: 1
Line properties
Whether to show a connecting line (like in the sixth example).
Default: false
lineColors
The colors of the lines connecting the tickmarks.
Default: ['green', 'red']
lineShadowColor
The color of the lines shadow (if any).
Default: rgba(0,0,0,0)
lineShadowOffsetx
The X offset of the lines shadow.
Default: 3
lineShadowOffsety
The Y offset of the lines shadow.
Default: 3
lineShadowBlur
The severity of the line shadows blurring effect.
Default: 2
lineStepped
Like the line chart, Scatter chart lines can be stepped by setting this to true.
Default: false
lineLinewidth
This can be either a number or an array of numbers (for multiple lines) and controls the linewidth that is used for the lines.
Default: 1
lineDash
With this setting you can control the
linedash
setting so your lines can be dashed (or dotted).Note: Browser support is limited (but growing) for dashed/dotted lines - so depending on your browser you may see just a solid line.
Default: null
Trend line properties
If desired, 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
trendlineColor
Use this property to specify either a single color or an array of colors for the trend line(s).
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
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.
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
trendlineClipping
If set to false then the chart will not be clipped to the area that the tickmarks are located in. This means that the trend line will cover the whole of the chart area (albeit with a small margin and you can turn this off with the
trendlineMargin
property).Default: null
Bubble properties
The minimum value that the bubble represents
Default: 0
bubbleMax
The maximum value that the bubble represents
Default: null
bubbleWidth
The maximum width of a bubble on the chart
Default: null
bubbleData
The bubble values for each of the points the on the chart
Default: null
Key properties
The key properties are documented on the key documentation page.Miscellaneous properties
Property | Description | Default |
---|---|---|
highlightStyle | By default this is null but you can set it to a function if you wish so that function is called to do the chart highlighting. It's passed the shape object as an argument. As of version 5.23 you can also set this to invert as well. If you do this on a dark background you may find that you need to change the highlightFill color setting as well. | null |
boxplotWidth | This stipulates the default width of boxes. For more on boxplots, see here. | 10 |
boxplotCapped | This stipulates whether the boxplot will have caps on the end of the whiskers. This could be useful if you're creating a stock chart for example. For more on boxplots, see here. | true |
clearto | This is used in animations and effects as the default color to use when clearing the canvas. | null |
outofbounds | If you've set a yaxisScaleMax but you still want to see marks drawn that go above this maximum then you'll need to set this property to true. | false |
By default this is null but you can set it to a function if you wish so that function is called to do the chart highlighting. It's passed the shape object as an argument. As of version 5.23 you can also set this to invert as well. If you do this on a dark background you may find that you need to change the
highlightFill
color setting as well.Default: null
boxplotWidth
This stipulates the default width of boxes. For more on boxplots, see here.
Default: 10
boxplotCapped
This stipulates whether the boxplot will have caps on the end of the whiskers. This could be useful if you're creating a stock chart for example. For more on boxplots, see here.
Default: true
clearto
This is used in animations and effects as the default color to use when clearing the canvas.
Default: null
outofbounds
If you've set a
yaxisScaleMax
but you still want to see marks drawn that go above this maximum then you'll need to set this property to true.Default: false
Methods
obj.get(name)
An accessor that you can use to retrieve the values of properties.
obj.set(name, value)
An accessor that you can use to set the values of properties.
obj.getShape(event)
This function makes it easier to get hold of which point on the Scatter chart has been clicked or hovered over. It returns an object that has the following properties:
object |
The chart object |
x |
The X coordinate |
y |
The Y coordinate |
dataset |
The zero-indexed dataset (the Scatter chart supports multiple datasets). |
index |
The zero-indexed index of the point. |
sequentialIndex |
The zero-indexed sequential index of the point. For example on a chart where there's three datasets of three points each - this goes from 0 up to 8. |
tooltip |
If a tooltip is associated with this point this will be it.id:
strings are expanded for you (where the tooltip text is retrieved from the HTML
tag with the matching ID).
|
<script> scatter.canvas.onmousemove = function (e) { var canvas = e.target; var obj = canvas.__object__; var shape = obj.getShape(e); if (shape) { obj.path( 'b a % % 5 0 6.29 f red', shape.x, shape.y ); } } </script>
In boxplots the shape object is slightly different:
object |
The chart object |
x |
The X coordinate |
y |
The Y coordinate |
width |
The width of the bar |
height |
The height of the bar |
dataset |
The zero-indexed dataset . Scatter charts can have multiple datasets and this
indicates the dataset index.
|
index |
The zero-indexed index of the box. |
sequentialIndex |
The zero-indexed sequential index of the box. |
tooltip |
If a tooltip is associated with this box this will be it. id:
strings are expanded for you (where the tooltip text is retrieved from the HTML
tag with the matching ID).
|
<script> scatter.canvas.onclick = function (e) { RGraph.redraw(); var canvas = e.target, obj = canvas.__object__, shape = obj.getShape(e); if (shape) { obj.path( 'lc square lj square b r % % % % f red', shape.x, shape.y, shape.width, shape.height ); } } </script>
obj.getXValue(mixed)
This method can be used to get the X value at a particular point or at the mouse coordinates, based on the X maximum value that is being used. Not simply the coordinates of the mouse. The argument can either be an event object (for use in event listener functions) OR a two element array consisting of the X and Y coordinates (ie when you're not necessarily in an event listener). It returns null if the mouse or coordinates are in the margin areas.
obj.getYValue(mixed)
This method can be used to get the Y value at a particular point or at the mouse coordinates, based on the scale that is in use. Not simply the coordinates of the mouse. The argument can either be an event object (for use in event listener functions) OR a two element array consisting of the X and Y coordinates (ie when you're not necessarily in an event listener). It returns null if the mouse or coordinates are in the margin areas.
obj.getYCoord(value)
This method can be used to get an appropriate Y coordinate for a value when you're doing custom drawing on the chart. It returns the coordinate for the max/min value if the given number is out of range.
obj.getXCoord(value)
This method can be used to get an appropriate X coordinate for a value
when you're doing custom drawing on the chart. It returns
null if the given number is out of range. If you're using a date/time
chart with the min
and max
set to date/time strings
you can also pass this function a date/time string eg:
obj.getXCoord('2013-06-12T15:14:16');
obj.on(event, function)
This method can be used to set an event listener on an object.
It operates in a similar way to the jQuery on()
function.
The first argument is the event that you wish to attach to and the
second is the handler function. For example:
obj.on('draw', function (obj)
{
// Put your event code here
});
The function is useful if you use method chaining when creating your charts:
<script> new RGraph.Scatter({ id: 'cvs', data: [ [12,35],[23,53],[35,35],[45,58],[56,55],[86,86] ], xaxisScaleMax: 100 }).on('draw', function (obj) { // Put your draw event code here }).on('click', function (e, shape) { // Put your click event code here }).draw(); </script>obj.exec(function)
The exec function is documented here.
Custom RGraph events that are available
Custom RGraph events are events that RGraph fires when certain actions occur. There is a more comprehensive list of these events here . Here's some example code that show you how to add these events to your chart.
- click
- mousemove
- mouseover
- mouseout
There's more documentation about events available here: Summary of events documentation
<script>
scatter = new RGraph.Scatter({
id: 'cvs',
data: [[1,1],[2,2],[3,3],[4,4],[5,5]],
options: {
xaxisScaleMax: 10
}
}).draw().on('click', function (e, shape)
{
// Add your click event listener code here
}).on('mousemove', function (e, shape)
{
// Add your mousemove event listener code here
}).on('mouseover', function (e, shape)
{
// Add your mouseover event listener code here
}).on('mouseout', function (obj)
{
// Add your mouseout event listener code here
});
</script>
Box/Whisker (candlestick) plots
Instead of a single Y value, you have the ability to specify an array of 5, 6, 7 or 8 values, which will be used to make a box plot (also known as a candlestick plot). These values are (in order):
- Lower whisker
- Bottom of the box
- Middle value (which isn't necessarily in the center of the box - this depends on your data)
- Top of the box
- Upper whisker
- Upper color (optional)
- Lower color (optional)
- Width (optional)
<script> new RGraph.Scatter({ id: 'scatter8', data: [ [10,[1,1,16,24,24, 'red', 'green']], [105,[5,10,15,25,25, 'red', 'green']], [125,[10,15,25,35,45, 'red', 'green']], [325,[10,15,25,35,45, 'red', 'green', 30]] ], options: { title: 'An example of a boxplot', xaxisLabels: ['Q1', 'Q2', 'Q3', 'Q4'], xaxisScaleMax: 365, yaxisScaleMax: 50, boxplotWidth: 12 // the default width } }).draw(); </script>
Capped ends
For better compatibility with stock charts, you can now specify that the
horizontal lines at the ends of the box plot
are not shown with the boxplotCapped
option.
Specific points for labels on the X axis
Instead of a simple string which is used as the label, each entry of the labels array can be a two element array consisting of the label and the X value that the label should be placed at. For example:
scatter.set({ xaxisLabels:[ ['Quarter 1', 0], ['Quarter 2', 90], ['Quarter 3', 181], ['Quarter 4', 273] ] });
Custom tickmarks
If none of the available tickmark styles are suitable, you can specify a function that draws the tickmark, enabling you to draw the tickmark yourself. For example:
<script>
line.set('tickmarksStyle', myTick);
/**
* The function that is called once per tickmark, to draw it
*
* @param object obj The chart object
* @param object data The chart data
* @param number x The X coordinate
* @param number y The Y coordinate
* @param number xVal The X value
* @param number yVal The Y value
* @param number xMax The maximum X scale value
* @param number yMax The maximum Y scale value
* @param string color The color of the tickmark
* @param string dataset_index The index of the data (which starts at zero
* @param string data_index The index of the data in the dataset (which starts at zero)
*/
function myTick (obj, data, x, y, xVal, yVal, xMax, yMax, color, dataset_index, data_index)
{
// Draw your custom tick here
}
</script>
As of August 2014 you can also specify an image to use as a tickmark. Various styles of URL are supported:
obj.set({tickmarks: 'image:foo.png'}); // Starts with image: prefix obj.set({tickmarks: '/images/foo.png'}); // Starts with a / obj.set({tickmarks: '../images/foo.png'}); // Starts with ../ obj.set({tickmarks: 'data: ...'}); // Starts with data: (for inline images) obj.set({tickmarks: 'images/foo.png'}); // Starts with images/
Note about colors and the key
If you're using a key you may need to set lineColors
to
allow it to use the correct colors. For example:
obj.set('lineColors', ['red','green','blue']);
Note about the crosshairs event
With the Scatter chart you can use the crosshairs
custom
event to pull out the crosshair coordinates like this
(the coordinates are only available if you have them displayed):
function myFunc (obj)
{
var xCoord = obj.canvas.__crosshairs_x__;
var yCoord = obj.canvas.__crosshairs_y__;
}
RGraph.addCustomEventListener(obj, 'crosshairs', function ()
{
// Handle the event here
});
Adding a trend line to your chart
Since version 5.22 RGraph has supported trend lines on the Scatter chart. This is as easy as setting
the trendline
option to true and RGraph will calculate the best-fit line for your data.
The Scatter chart at the top of the page is using the trendline
option and
there's also an example here.
There are a few ways to configure the lines which you can see in the trend line section of the API documentation.
Note about the data_arr array
Sometimes you may wish to view your data as one big array, instead of one array per dataset. In this case theobj.data_arr
is available. This is one long array containing all of
the individual data points. Remember that
with the Scatter chart the data points themselves are arrays/objects of
X/Y/color/tooltip etc information.
Date/time based charts
Instead of using a number as the X coordinate you can instead use a
date/time value instead. Likewise you can use
the same style date/time values as the xaxisScaleMin
and
xaxisScaleMax
values. The underlying date/time parsing uses
the
Date.parse()
function (via the RGraph.parseDate()
function) so you can use values such as: 2012-01-01 00:00:00
There's an example of a date/time chart in
the download archive
(scatter-date-time-values.html)
Update (version 5.25) - Moment.js added to RGraph
The date/time parsing in RGraph is versatile and recognises a lot of formats. The Moment.js
library however is a dedicated library for parsing and manipulating dates and times. From
version 5.25 the Moment.js library is bundled with RGraph. You can include it in your page
by including the file RGraph.common.moment.js
in your page. Once you've done
that you can use the Moment.js API to manipulate dates as you require. Here's a very simplistic
example of using Moment.js to set the minimum and maximum values of a Scatter chart:
new RGraph.Scatter({ id: 'cvs', data: data, options: { tickmarksSize: 10, xaxisTickmarksCount: 7, xaxisScaleMin: moment('2020-01-01'), xaxisScaleMax: moment('2020-01-01').add(1, 'year'), backgroundGridVlines: false, marginRight: 100 } }).draw();
The HTML tag to include the Moment.js library in your page is this:
<script src="RGraph.moment.js"></script>
Bubble charts
The RGraph Scatter chart can show Bubble charts natively - as shown by the chart here. From version 5.26 the way you make Bubble charts has changed and been integrated into the Scatter chart.
There's an example of the code that's necessary to show this type of chart shown below. The various properties are:
The minimum value that the bubble represents
Default: 0
bubbleMax
The maximum value that the bubble represents
Default: null
bubbleWidth
The maximum width of a bubble on the chart
Default: null
bubbleData
The bubble values for each of the points the on the chart
Default: null
<script>
scatter = new RGraph.Scatter({
id: 'cvs2',
data: [
[30,15, 'red', 'Red bubble tooltip'],
[60,5, 'blue', 'Blue bubble tooltip'],
[90,8, 'pink', 'Pink bubble tooltip'],
[120,19, 'green', 'Green bubble tooltip'],
[150,14, 'gray', 'Gray bubble tooltip'],
[50,12, 'red', 'Red bubble tooltip'],
[180,24, 'gray', 'Gray bubble tooltip'],
[250,21, 'black', 'Black bubble tooltip']
],
options: {
xaxisScaleMax: 365,
xaxisLabels: ['Jan','Feb','Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec'],
textSize:14,
backgroundGridVlines: false,
backgroundGridBorder: false,
xaxisTickmarks:false,
yaxisTickmarks:false,
xaxisLinewidth: 2,
yaxisLinewidth: 2,
tooltipsHotspot: 10,
title: 'A bubble chart',
titleBold: true,
titleSize: 16,
titleY: '-5',
bubbleMin: 0, // The minimum for the bubble values
bubbleMax: 100, // The maximum for the bubble values
bubbleWidth: 50, // The maximum width of the bubbles
bubbleData: [50,60,70,80,90,84,86,87] // The values of the bubbles (ie how big the bubbles are)
}
}).draw().on('mouseout', function (e)
{
RGraph.hideTooltip();
RGraph.redraw();
});
</script>
Animation effects
These effects are available and can be used instead of thedraw()
function. There are also generic effects available which
you can see here: Generic effects and transitions
- The Trace effect (effects-scatter-trace2.html in the download archive)
<script> // Optional callback function that's called when the effect is complete function myCallback (obj) { // ... } new RGraph.Scatter({ id: 'cvs', data: [[5,5],[10,10],[15,15],[20,20]], options: { xaxisScaleMax: 90 } }).trace({frames: 60}, myCallback) </script>