Radial Scatter charts documentation

Recommend RGraph:  
    Read comments...

 

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.

 

Chart configuration

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

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

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

 

Background

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

backgroundGrid
Whether the background grid is drawn
Default: true

backgroundGridColor
The color of the background grid
Default: #ccc

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

backgroundGridDiagonalsCount
The number of diagonal lines in the background grid
Default: null (linked to how many labels there are)

backgroundGridRadials
Whether the background grid radial (circles) are drawn
Default: true

backgroundGridRadialsCount
How many circular grid lines are drawn
Default: 5 (linked to how many scale labels are shown)

backgroundGridLinewidth
The linewidth of the background grid
Default: 1

 

Margins

gutterLeft
The left gutter of the chart, (the gutter is where the labels and title are)).
Default: 25

gutterRight
The right gutter of the chart, (the gutter is where the labels and title are).
Default: 25

gutterTop
The top gutter of the chart, (the gutter is where the labels and title are).
Default: 25

gutterBottom
The bottom gutter of the chart, (the gutter is where the labels and title are).
Default: 25

 

Labels and text

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 gutters 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 labels.
Default: black

textSize
The size (in points) of the labels.
Default: 10

textFont
The font used to render the text.
Default: Arial

labels
The labels, if any, for the chart.
Default: none

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

labelsAxes
This controls the axes that show the scale labels. Each letter stands for the appropriate axis (North, South, East and West)
Default: nsew

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

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

labelsCount
This determines the number of labels that are displayed on the axes.
Default: 5

 

Titles

title
The title of the chart, if any.
Default: null

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

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

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

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

titleBackground
The background color (if any) for the title.
Default: null

titleColor
The color of the title.
Default: black

titleX
To give the exact X coordinate for the title - use this
Default: null

titleY
To give the exact Y coordinate for the title - use this
Default: null

 

Key

The key properties are documented on the key documentation page.

 

Scale

scalePoint
The character used as the decimal point.
Default: .

scaleThousand
The character used as the thousand separator
Default: ,

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

scaleZerostart
If true zero will shown (it's not by default)
Default: false

 

Interactive features

contextmenu
An array of context menu items. More information on 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. Can be either fade or none.
Default: fade

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

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

tooltipsOverride
If 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 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 tooltip DO NOT get hidden.
Default: false

annotatable
Whether annotations are enabled for the chart (ie you can draw on the chart interactively.
Default: false

annotateColor
If you do not allow the use of the palette, then this will be the only colour allowed for annotations.
Default: black

annotateLinewidth
This is the line width of the annotations.
Default: 1

resizable
Defaulting 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).
Default: false

resizeHandleBackground
With 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.
Default: null

resizableMaxwidth
This allows you to set a maximum width that the chart can be resized to.
Default: null

resizableMaxheight
This allows you to set a maximum height that the chart can be resized to.
Default: null

 

Zoom

zoomFactor
This is the factor that the chart will be zoomed by (bigger values means more zoom)
Default: 1.5

zoomFadeIn
Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.
Default: true

zoomFadeOut
Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.
Default: true

zoomHdir
The horizontal direction of the zoom. Possible values are: left, center, right
Default: right

zoomVdir
The vertical direction of the zoom. Possible values are: up, center, down
Default: down

zoomDelay
The delay (in milliseconds) between frames.
Default: 50

zoomFrames
The number of frames in the zoom animation.
Default: 10

zoomShadow
Whether or not the zoomed canvas has a shadow or not.
Default: true

 

Events

eventsClick
If you want to add your own onclick function you can do so by assigning it to this property. See here for details.
Default: null

eventsMousemove
If you want to add your own onmousemove function you can do so by assigning it to this property. See here for details.
Default: null

eventsMouseover
If you want to add your own onmouseover function you can do so by assigning it to this property. See here for details.
Default: null

eventsMouseout
If you want to add your own onmouseout function you can do so by assigning it to this property. See here for details.
Default: null

 

Axes properties

axesColor
The color of the axes. You can use gradients here if you wish.
Default: black

axesNumticks
This controls how many tickmarks are on the axes
Default: 5

axesCaps
Whether the axes have caps on their ends
Default: true

 

Line properties

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

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.
Default: null

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)

 

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.

Comments