Radial Scatter chart API reference

Documentation about the Radial scatter chart including information about all of the options that are available to you. A Radial Scatter chart is just like a regular Scatter chart but displayed in a circular fashion instead of a rectangular one.

Example

<script>
    // The data that is used for the chart. The first argument is the
    // angle and the second argument is the magnitude shown.
    data = [ [15,53,'red'], [45,63,null, 'The tooltip'], [48,45,'green'], [52,38], [51,61] ];

    new RGraph.RScatter({
        id: 'cvs',
        data: data,
        options: {
            labels: ['NE','E','SE','S','SW','W','NW','N'],
            marginLeft: 35,
            marginRight: 35
        }
    }).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 is 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

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

Margin properties

PropertyDescriptionDefault
marginLeftThe left margin of the chart, (the margin is where the labels and title are)).25
marginRightThe right margin of the chart, (the margin is where the labels and title are).25
marginTopThe top margin of the chart, (the margin is where the labels and title are).25
marginBottomThe bottom margin of the chart, (the margin is where the labels and title are).25

color properties

PropertyDescriptionDefault
colorsDefaultThe default color that's used for the tickmarks.black

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>
true
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, if any, for the chart.none
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)
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
labelsPositionThis can be either center or edge and determines the position of the labels.center

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 2pt bigger than the textSize setting.null
titleBoldWhether the title is bold or not.true
titleItalicWhether the title is italic or not.false
titleColorThe color of the title.black
titleBackgroundThe background color (if any) for 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

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 used as the decimal point..
scaleThousandThe character 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

Axes properties

PropertyDescriptionDefault
axesColorThe color of the axes.rgba(0,0,0,0)

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. Can be either fade or none.fade
tooltipsEventThis is the event that triggers the tooltips. It can be either click or mousemove.click
tooltipsCssClassThis is the name of the CSS class the chart uses.RGraph_tooltip
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
tooltipsNohideonclearNot 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
annotatableWhether annotations are enabled for the chart (ie you can draw on the chart interactively.false
annotateColorIf you do not allow the use of the palette, then this will be the only color allowed for annotations.black
annotateLinewidthThis is the linewidth of the annotations.1
resizableDefaulting to false, this determines whether your chart will be resizable. Because of the numerous event handlers this has to install code on, This feature is unlikely to work with other dynamic features (the context menu is fine however).false
resizeHandleBackgroundWith this you can specify the background color for the resize handle. If you're adjusting the position of the handle then you may need this to make the handle stand out more.null
resizableMinwidthThis allows you to set a minimum width that the chart can be resized to.null
resizableMinheightThis allows you to set a minimum height that the chart can be resized to.null
resizableMaxwidthThis allows you to set a maximum width that the chart can be resized to.null
resizableMaxheightThis allows you to set a maximum height that the chart can be resized to.null

Event properties

PropertyDescriptionDefault
eventsClickIf you want to add your own click function you can do so by assigning it to this property. See here for details.null
eventsMousemoveIf you want to add your own mousemove function you can do so by assigning it to this property. See here for details.null
eventsMouseoverIf you want to add your own mouseover function you can do so by assigning it to this property. See here for details.null
eventsMouseoutIf you want to add your own mouseout function you can do so by assigning it to this property. See here for details.null

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

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.null
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)

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 returns the details of any applicable/focused point on the chart. It returns:

The shape also includes textual indexes like this: shape['object'] And they are:

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. The first value of a set of coordinates is the actual value in degrees - ie it can be 0-360.

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:

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

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

var obj = new RGraph.RScatter('cvs', [[45,36],[48,68],[66,56],[95,35],[120,45],[155,65]])
    .on('draw', function (e, shape)
    {
        // Put ondraw code here
    })
    .on('click', function (e, shape)
    {
        // Handle click event
    })
    .draw();
The exec option and method

The exec function is documented here.