Radial Scatter charts documentation

 

Example

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

    // Create the chart with the data from above.
    var rscatter= new RGraph.RScatter({
        id: 'cvs',
        data: data,
        options: {
            labels: ['NE','E','SE','S','SW','W','NW','N'],
            gutterLeft: 35,
            gutterRight: 35
        }
    }).draw();
</script>

The example file is here.

 

Properties

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

Layout style:     
  

Chart configuration

PropertyDescriptionDefault
centerxIf required, you can position the RScatter chart using this instead of the gutters.null
centeryIf required, you can position the RScatter chart using this instead of the gutters.null
radiusIf required, you can size the RScatter chart using this instead of the gutters.null

Background

PropertyDescriptionDefault
backgroundColorThe background color of the chart. You can use gradients here if you wish.none
backgroundGridWhether the background grid is drawntrue
backgroundGridColorThe color of the background grid#ccc
backgroundGridDiagonalsWhether the lines that emanate from center outwards are drawntrue
backgroundGridDiagonalsCountThe number of diagonal lines in the background gridnull (linked to how many labels there are)
backgroundGridRadialsWhether the background grid radial (circles) are drawntrue
backgroundGridRadialsCountHow many circular grid lines are drawn5 (linked to how many scale labels are shown)
backgroundGridLinewidthThe linewidth of the background grid1

Margins

PropertyDescriptionDefault
gutterLeftThe left gutter of the chart, (the gutter is where the labels and title are)).25
gutterRightThe right gutter of the chart, (the gutter is where the labels and title are).25
gutterTopThe top gutter of the chart, (the gutter is where the labels and title are).25
gutterBottomThe bottom gutter of the chart, (the gutter is where the labels and title are).25

Labels and text

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 gutters 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 labels.black
textSizeThe size (in points) of the labels.10
textFontThe font used to render the text.Arial
labelsThe labels, if any, for the chart.none
labelsColorThe color of the labelsnull (same as textColor)
labelsAxesThis controls the axes that show the scale labels. Each letter stands for the appropriate axis (North, South, East and West)nsew
labelsAxesBackgroundThis is the color of the background for the labelsrgba(255,255,255,0.8)
labelsPositionThis can be either center or edge and determines the position of the labels.center
labelsCountThis determines the number of labels that are displayed on the axes.5

Titles

PropertyDescriptionDefault
titleThe title of the chart, if any.null
titleFontThe font that the title is rendered in. If not specified the text.font setting is used (usually Arial)null
titleSizeThe size of the title. If not specified the size is usually 2pt bigger than the text.size setting.null
titleBoldWhether the title is bold or not.true
titleItalicWhether the title is italic or not.false
titleBackgroundThe background color (if any) for the title.null
titleColorThe color of the title.black
titleXTo give the exact X coordinate for the title - use thisnull
titleYTo give the exact Y coordinate for the title - use thisnull

Key

The key properties are documented on the key documentation page.

Scale

PropertyDescriptionDefault
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 zero will shown (it's not by default)false

Interactive features

PropertyDescriptionDefault
contextmenuAn array of context menu items. More information on 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 onclick or onmousemove.onclick
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 on the tooltips documentation pagenull
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 tooltip 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 colour allowed for annotations.black
annotateLinewidthThis is the line width 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
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

Zoom

PropertyDescriptionDefault
zoomFactorThis is the factor that the chart will be zoomed by (bigger values means more zoom)1.5
zoomFadeInWhether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.true
zoomFadeOutWhether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.true
zoomHdirThe horizontal direction of the zoom. Possible values are: left, center, rightright
zoomVdirThe vertical direction of the zoom. Possible values are: up, center, downdown
zoomDelayThe delay (in milliseconds) between frames.50
zoomFramesThe number of frames in the zoom animation.10
zoomShadowWhether or not the zoomed canvas has a shadow or not.true

Events

PropertyDescriptionDefault
eventsClickIf you want to add your own onclick function you can do so by assigning it to this property. See here for details.null
eventsMousemoveIf you want to add your own onmousemove function you can do so by assigning it to this property. See here for details.null
eventsMouseoverIf you want to add your own onmouseover function you can do so by assigning it to this property. See here for details.null
eventsMouseoutIf you want to add your own onmouseout function you can do so by assigning it to this property. See here for details.null

Axes properties

PropertyDescriptionDefault
axesColorThe color of the axes. You can use gradients here if you wish.black
axesNumticksThis controls how many tickmarks are on the axes5
axesCapsWhether the axes have caps on their endstrue

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

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 highlightrgba(0,255,0,0.5)
segmentHighlightStrokeThe stroke color of the highlightrgba(0,0,0,0)

 

Methods

 

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

 

obj.set(name, value)
An accessor that you can use to set the value 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 coordinates points is the actual value in degrees - ie it can be 360.

 

obj.on(event, func)

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

RGraph on social media