Radial Scatter chart

Example

View example on CodePen
<script>
    tooltip = '%{key}';

    new RGraph.RScatter({
        id: 'cvs',
        data: [
            [ [15,53,'red',tooltip], [45,63,'red',tooltip], [48,45,'red',tooltip], [52,38,'red',tooltip], [51,61,'red',tooltip] ],
            [ [270,45, 'blue',tooltip], [270,55, 'red',tooltip] ]
        ],
        options: {
            tooltipsFormattedKeyLabels: ['John','Molly','Pete','Olga','Luis','Kevin','Julie'],
            tooltipsCss: {
                fontSize: '16pt',
                boxShadow: '',
                textAlign: 'left'
            },
            labels: ['NE','E','SE','S','SW','W','NW','N'],
            labelsPosition: 'edge',
            marginLeft: 35,
            marginRight: 35,
            labelsAxesSize: 8
        }
    }).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 shown above.

Chart configuration properties

PropertyDescriptionDefault
centerxIf required, you can position the RScatter chart using this instead of the margins.null
centeryIf required, you can position the RScatter chart using this instead of the margins.null
radiusIf required, you can size the RScatter chart using this instead of the margins.null
centerx
If required, you can position the RScatter chart using this instead of the margins.
Default: null

centery
If required, you can position the RScatter chart using this instead of the margins.
Default: null

radius
If required, you can size the RScatter chart using this instead of the margins.
Default: null

Background properties

PropertyDescriptionDefault
backgroundGridWhether the background grid is drawn.true
backgroundGridColorThe color of the background grid.#ccc
backgroundGridRadialsWhether the lines that emanate from center outwards are drawn.true
backgroundGridRadialsCountThe number of diagonal lines in the background grid.null
backgroundGridCirclesWhether the background grid circles (or angular lines) are drawn.true
backgroundGridCirclesCountHow many circular/angular grid lines are drawn.5
backgroundGridLinewidthThe linewidth of the background grid.1
backgroundColorThe background color of the chart. You can use gradients here if you wish.none
backgroundGrid
Whether the background grid is drawn.
Default: true

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

backgroundGridRadials
Whether the lines that emanate from center outwards are drawn.
Default: true

backgroundGridRadialsCount
The number of diagonal lines in the background grid.
Default: null

backgroundGridCircles
Whether the background grid circles (or angular lines) are drawn.
Default: true

backgroundGridCirclesCount
How many circular/angular grid lines are drawn.
Default: 5

backgroundGridLinewidth
The linewidth of the background grid.
Default: 1

backgroundColor
The background color of the chart. You can use gradients here if you wish.
Default: none

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

Color properties

PropertyDescriptionDefault
colorsDefaultThe default color that's used for the tickmarks.black
colorsDefault
The default color that's used for the tickmarks.
Default: black

Tickmark properties

PropertyDescriptionDefault
tickmarksStyleThis property was formerly called tickmarks and dictates how the tickmarks are drawn It defaults to cross but can also be circle square diamond or plus
tickmarksSizeThis determines the size of the tickmarks.3
tickmarksStyle
This property was formerly called tickmarks and dictates how the tickmarks are drawn It defaults to cross but can also be circle square diamond or plus
Default:

tickmarksSize
This determines the size of the tickmarks.
Default: 3

Labels and text properties

PropertyDescriptionDefault
textAccessibleA 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>
false
textAccessibleOverflowThis can be visible or hidden and it controls whether the text is clipped to the edges of the canvas. It defaults to be visible and means you can set small margins if you wish.visible
textAccessiblePointereventsThis controls whether the dom text responds to mouse based events or not (it sets the pointer-events css property to none).true
textColorThe color of the text on the chart.black
textSizeThe size of the text on the chart.12
textFontThe font used to render the text on the chart.Arial, Verdana, sans-serif
textItalicWhether the text on the chart is italic or not.false
textBoldWhether the text on the chart is bold or not.false
labelsThe circular labels for the chart. You can also give this option a string if you prefer and use formatted labels.none
labelsOffsetRadiusTo offset the labels either away from or towards the Rose chart then this is the property to use for that. 0
labelsFormattedDecimalsWhen using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro. 0
labelsFormattedPointWhen using formatted labels this is the decimal point character that's used with the %{value_formatted} macro..
labelsFormattedThousandWhen using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro.,
labelsFormattedUnitsPreWhen using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro.(an empty string)
labelsFormattedUnitsPostWhen using formatted labels these are the units that are appended to the number with the %{value_formatted} macro.(an empty string)
labelsFontThe font used by the circular labels.null (same as textFont)
labelsSizeThe size of the circular labels.null (same as textSize)
labelsColorThe color of the circular labels.null (same as textColor)
labelsBoldWhether the circular labels are bold or not.null (same as textBold)
labelsItalicWhether the circular labels are italic or not.null (same as textItalic)
labelsPositionThis can be either center or edge and determines the position of the labels.center
labelsAxesThis controls the axes that show the scale labels. It should be a combination of 4 letters: n, e, s, w Each letter stands for the appropriate axis (North, South, East and West).n
labelsAxesBackgroundThis is the color of the background for the labels.rgba(255,255,255,0.7)
labelsAxesFontThe font used for the labels on the axes.null
labelsAxesSizeThe size of the labels on the axes.null
labelsAxesColorThe color of the labels on the axes.null
labelsAxesBoldWhether the labels on the axes are bold or not.null
labelsAxesItalicWhether the labels on the axes are italic or not.null
labelsAxesOffsetxThis allows you finer-grained control in the horizontal direction over the text positioning if you need it. 0
labelsAxesOffsetyThis allows you finer-grained control in the vertical direction over the text positioning if you need it. 0
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
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: false

textAccessibleOverflow
This can be visible or hidden and it controls whether the text is clipped to the edges of the canvas. It defaults to be visible and means you can set small margins if you wish.
Default: visible

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

textColor
The color of the text on the chart.
Default: black

textSize
The size of the text on the chart.
Default: 12

textFont
The font used to render the text on the chart.
Default: Arial, Verdana, sans-serif

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

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

labels
The circular labels for the chart. You can also give this option a string if you prefer and use formatted labels.
Default: none

labelsOffsetRadius
To offset the labels either away from or towards the Rose chart then this is the property to use for that.
Default: 0

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

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

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

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

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

labelsFont
The font used by the circular labels.
Default: null (same as textFont)

labelsSize
The size of the circular labels.
Default: null (same as textSize)

labelsColor
The color of the circular labels.
Default: null (same as textColor)

labelsBold
Whether the circular labels are bold or not.
Default: null (same as textBold)

labelsItalic
Whether the circular labels are italic or not.
Default: null (same as textItalic)

labelsPosition
This can be either center or edge and determines the position of the labels.
Default: center

labelsAxes
This controls the axes that show the scale labels. It should be a combination of 4 letters: n, e, s, w Each letter stands for the appropriate axis (North, South, East and West).
Default: n

labelsAxesBackground
This is the color of the background for the labels.
Default: rgba(255,255,255,0.7)

labelsAxesFont
The font used for the labels on the axes.
Default: null

labelsAxesSize
The size of the labels on the axes.
Default: null

labelsAxesColor
The color of the labels on the axes.
Default: null

labelsAxesBold
Whether the labels on the axes are bold or not.
Default: null

labelsAxesItalic
Whether the labels on the axes are italic or not.
Default: null

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

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

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

Title properties

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

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

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

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

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

titleColor
The color of the title.
Default: null

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

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

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

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

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

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

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

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

titleSubtitleColor
The color of the subtitle.
Default: #aaa

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

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

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

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

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

Key properties

The key properties are documented on the key documentation page.

Scale properties

PropertyDescriptionDefault
scaleMaxThe maximum value of the scale on the chart. By default this is generated based on the data that you supply.null
scaleUnitsPreUnits that are prepended to the number..
scaleUnitsPostUnits that are appended to the number..
scalePointThe character that's used as the decimal point..
scaleThousandThe character that's used as the thousand separator.,
scaleDecimalsThis stipulates how many decimal places there are. 0
scaleZerostartIf true then the zero label will be shown (this is the default now).true
scaleMax
The maximum value of the scale on the chart. By default this is generated based on the data that you supply.
Default: null

scaleUnitsPre
Units that are prepended to the number.
Default: .

scaleUnitsPost
Units that are appended to the number.
Default: .

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

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

scaleDecimals
This stipulates how many decimal places there are.
Default: 0

scaleZerostart
If true then the zero label will be shown (this is the default now).
Default: true

Interactive features properties

PropertyDescriptionDefault
contextmenuAn array of context menu items. More information about context menus is here.[] (An empty array)
tooltipsA numerically indexed array of tooltips that are shown when a bar is clicked. These can contain html.An empty array
tooltipsEffectThe effect used for showing tooltips. Possible values are slide fade or none.slide
tooltipsEventThis is the event that triggers the tooltips. It can be either click or mousemove.click
tooltipsOverrideIf 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
tooltipsFormattedPointWhen using formatted tooltip strings this is used as the point when using the %{value_formatted}< option..
tooltipsFormattedThousandWhen using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.,
tooltipsFormattedDecimalsWhen using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option. 0
tooltipsFormattedUnitsPreWhen using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.(an empty string)
tooltipsFormattedUnitsPostWhen using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.(an empty string)
tooltipsFormattedKeyColorsWhen using formatted tooltip strings you can give specific colors for the %{key} option to use.null
tooltipsFormattedKeyColorsShapeThis is the shape that's used in the tooltip key. It can be square or circlesquare
tooltipsFormattedKeyColorsCss By using this property you can add css values to the key color shape that appears in the tooltip key. Note the property name is "color" and not "colors" like previous properties. It should be an object of css properties like this:
tooltipsFormattedKeyColorsCss : {
    border: "1px solid #ddd";
}
null
tooltipsFormattedKeyLabelsWhen using formatted tooltip strings these are the labels that are displayed.[] (an empty array)
tooltipsFormattedListTypeWith this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol.ul
tooltipsFormattedListItemsThis should be a two-dimension array of the list items that are to be shown for all of the tooltips. An example of this property is:
tooltipsFormattedListItems: [
    ['Bill','Jerry','Berty'], // First tooltip
    ['Gill','Carrie','Lucy'], // Second tooltip
    ['Pob','Nobby','Hilda']   // Third tooltip
]
You can use css to style this list - for example:
.RGraph_tooltip ul#rgraph_formatted_tooltips_list li {
    text-align: left;
    color: yellow;
}
null
tooltipsFormattedTableHeadersWhen showing a table in the tooltips this can be an array of headers for the table. These are added to the tooltip using th tags.null
tooltipsFormattedTableDataThis is the data that is added to the table. This is a 3-dimensional array so it's easy to make a mistake. See the example, copy the code from it and then modify it suit. You'll create fewer bugs this way.null)
tooltipsPointerBy default the tooltips have a small triangular pointer that points to the shape that was clicked on. You can turn this off with this property.true
tooltipsPointerCssIf you want any css values applied to the tooltips pointer (a css border, for example) then specify an object containing those values to this property. For example:
tooltipsPointerCss: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}
null
tooltipsPointerOffsetxThis allows you to adjust the vertical position of the tooltips pointer. 0
tooltipsPointerOffsetyThis allows you to adjust the vertical position of the tooltips pointer (for example, if you add a border you may need to move it down slightly). 0
tooltipsPositionStaticThe new default (as of August 2020) is for tooltips to be positioned statically and not be dependent on the mouse position. If you don't want this for whatever reason, you can disable it with this setting. When you set it to false tooltips are positioned next to the mouse pointer.true
tooltipsCssIf you want to specify some css that gets applied to all of the tooltips, but don't want to use the RGraph.tooltips.style object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object css for the tooltips. These are css styles that get applied to all of the tooltips for the specific object only. It should look like this:
tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt'
}
null
tooltipsCssClassThis is the name of the css class the chart uses.RGraph_tooltip
tooltipsOffsetxThis property allows you to shift the tooltips left or right. 0
tooltipsOffsetyThis property allows you to shift the tooltips up or down. 0
tooltipsHotspotIgnoreThis can be a number of things and can be used to ignore certain tooltip hotspots - which can allow charts to the rear to be clickable. There's an example of this in the download archive called pie-tooltipshotspotignore.html. You can use the transparent color to allow the rear chart to be seen in such a case. It can be:
  • A single boolean value (ie true or false) to enable or disable all of the hotspots - true means the hotspot will be ignored
  • A single number (the zero-indexed number corresponding to the hotspot to ignore)
  • An array of numbers (the numbers are the indexes of hotspots to ignore)
  • An array of boolean true or false values - the position of these values correspond to the index(es) of the segments to ignore (for example [false, false, true, false, false] - true means the corresponding hotspot will be ignored)
null
annotatableWhether annotations are enabled for the chart (ie you can draw on the chart interactively.false
annotatableColorIf you do not allow the use of the palette, then this will be the only color allowed for annotations.black
annotatableLinewidthThis is the linewidth of the annotations.1
contextmenu
An array of context menu items. More information about context menus is here.
Default: [] (An empty array)

tooltips
A numerically indexed array of tooltips that are shown when a bar is clicked. These can contain html.
Default: An empty array

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

tooltipsEvent
This is the event that triggers the tooltips. It can be either click or mousemove.
Default: click

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

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

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

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

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

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

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

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

tooltipsFormattedKeyColorsCss
By using this property you can add css values to the key color shape that appears in the tooltip key. Note the property name is "color" and not "colors" like previous properties. It should be an object of css properties like this:
tooltipsFormattedKeyColorsCss : {
    border: "1px solid #ddd";
}

Default: null

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

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

tooltipsFormattedListItems
This should be a two-dimension array of the list items that are to be shown for all of the tooltips. An example of this property is:
tooltipsFormattedListItems: [
    ['Bill','Jerry','Berty'], // First tooltip
    ['Gill','Carrie','Lucy'], // Second tooltip
    ['Pob','Nobby','Hilda']   // Third tooltip
]
You can use css to style this list - for example:
.RGraph_tooltip ul#rgraph_formatted_tooltips_list li {
    text-align: left;
    color: yellow;
}

Default: null

tooltipsFormattedTableHeaders
When showing a table in the tooltips this can be an array of headers for the table. These are added to the tooltip using th tags.
Default: null

tooltipsFormattedTableData
This is the data that is added to the table. This is a 3-dimensional array so it's easy to make a mistake. See the example, copy the code from it and then modify it suit. You'll create fewer bugs this way.
Default: null)

tooltipsPointer
By default the tooltips have a small triangular pointer that points to the shape that was clicked on. You can turn this off with this property.
Default: true

tooltipsPointerCss
If you want any css values applied to the tooltips pointer (a css border, for example) then specify an object containing those values to this property. For example:
tooltipsPointerCss: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}

Default: null

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

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

tooltipsPositionStatic
The new default (as of August 2020) is for tooltips to be positioned statically and not be dependent on the mouse position. If you don't want this for whatever reason, you can disable it with this setting. When you set it to false tooltips are positioned next to the mouse pointer.
Default: true

tooltipsCss
If you want to specify some css that gets applied to all of the tooltips, but don't want to use the RGraph.tooltips.style object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object css for the tooltips. These are css styles that get applied to all of the tooltips for the specific object only. It should look like this:
tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt'
}

Default: null

tooltipsCssClass
This is the name of the css class the chart uses.
Default: RGraph_tooltip

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

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

tooltipsHotspotIgnore
This can be a number of things and can be used to ignore certain tooltip hotspots - which can allow charts to the rear to be clickable. There's an example of this in the download archive called pie-tooltipshotspotignore.html. You can use the transparent color to allow the rear chart to be seen in such a case. It can be:
Default: null

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

Axes properties

PropertyDescriptionDefault
axesColorThe color of the axes.rgba(0,0,0,0)
axesColor
The color of the axes.
Default: rgba(0,0,0,0)

Line properties

PropertyDescriptionDefault
lineIf true the points will be connected by a line.false
lineCloseIf true then the line will be closed (ie last point connects back to the first point).false
lineLinewidthThe linewidth of the line.1
lineColorsThe color(s) of the line(s).['black']
lineShadowWhether the lines have a shadow.false
lineShadowColorThe color of the shadow.black
lineShadowOffsetxThe horizontal offset of the shadow.3
lineShadowOffsetyThe vertical offset of the shadow.3
lineShadowBlurThe severity of the shadow blurring effect.2
line
If true the points will be connected by a line.
Default: false

lineClose
If true then the line will be closed (ie last point connects back to the first point).
Default: false

lineLinewidth
The linewidth of the line.
Default: 1

lineColors
The color(s) of the line(s).
Default: ['black']

lineShadow
Whether the lines have a shadow.
Default: false

lineShadowColor
The color of the shadow.
Default: black

lineShadowOffsetx
The horizontal offset of the shadow.
Default: 3

lineShadowOffsety
The vertical offset of the shadow.
Default: 3

lineShadowBlur
The severity of the shadow blurring effect.
Default: 2

Miscellaneous properties

PropertyDescriptionDefault
highlightStyleBy default this is null but you can set it to a function if you wish so that function is called to do the chart highlighting. Its 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
highlightSizeThe size of the highlight that gets drawn over the tickmark. If this property is not set then the highlight will be approximately the same size as the tooltip.null
highlightFillThe fill color of the tooltip.rgba(255,255,255,0.7)
highlightStrokeThe stroke color of the tooltip.transparent
cleartoThis is used in animations and effects as the default color to use when clearing the canvas.null
segmentHighlightIf you wish you can have segments of the chart highlight as you move the mouse around.false
segmentHighlightCountThe number of segments by default corresponds to the number of "radials" that the background grid has but using this property you can set it explicitly.null
segmentHighlightFillThe fill color of the highlight.rgba(0,255,0,0.5)
segmentHighlightStrokeThe stroke color of the highlight.rgba(0,0,0,0)
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
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. Its 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

highlightSize
The size of the highlight that gets drawn over the tickmark. If this property is not set then the highlight will be approximately the same size as the tooltip.
Default: null

highlightFill
The fill color of the tooltip.
Default: rgba(255,255,255,0.7)

highlightStroke
The stroke color of the tooltip.
Default: transparent

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

segmentHighlight
If you wish you can have segments of the chart highlight as you move the mouse around.
Default: false

segmentHighlightCount
The number of segments by default corresponds to the number of "radials" that the background grid has but using this property you can set it explicitly.
Default: null

segmentHighlightFill
The fill color of the highlight.
Default: rgba(0,255,0,0.5)

segmentHighlightStroke
The stroke color of the highlight.
Default: rgba(0,0,0,0)

responsive
This option is new to the July 2023 release (v6.13) and allows you to inline the responsive configuration instead of appending it on to the end of the object it as a function. The documentation and demo pages have been updated to use this new option. You can read more about the responsive feature by reading the responsive configuration page.
Default: null

Methods

obj.get(name)
An accessor that you can use to retrieve the values of properties.

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

obj.getShape(event)
This method makes it easy to get hold of which point has been clicked on or hovered over. It returns an object which has the following indexes available:
object The chart object
x This is the X coordinate of the point.
y This is the Y coordinate of the point.
dataset This is the zero-indexed index of the dataset that the point belongs to.
index The zero-indexed index of the point on the chart.
sequentialIndex This is the zero-indexed sequential index of the point on the chart.
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>
    rscatter.canvas.onclick = function (e)
    {
        RGraph.redraw();
    
        var canvas  = e.target,
            obj     = canvas.__object__,
            shape   = obj.getShape(e);

        if (shape) {

            var x = shape.x,
                y = shape.y;

            // Path a circle that indicates the point
            obj.path(
                'b a % % 5 0 6.29 false s red f red',
                x, y
            );
        }
    }
</script>

obj.getRadius(value)

This method can be used to get an appropriate radius of a point based on the scale. This is useful when working out how far away from the center a point should be. In a set of coordinates, the first value is the rotational value in degrees - it can be 0-360.


obj.on(event, function)

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

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

The function is useful if you use method chaining when creating your charts:

var obj = new RGraph.RScatter({
    id: 'cvs',
    data: [[45,36],[48,68],[66,56],[95,35],[120,45],[155,65]],
    options: {
    }
}).on('draw', function (obj)
{
    // Put your draw event code here

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

obj.exec(function)

The exec function is documented here.


obj.responsive(configuration)

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

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

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

Events

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

For example:
var obj = new RGraph.RScatter({
    id: 'cvs',
    data: [[45,36],[48,68],[66,56],[95,35],[120,45],[155,65]],
    options: {
    }
}).on('draw', function (obj)
{
    console.log('The draw event has fired');
    
}).draw();