SVG Radar charts API reference

Summary: Documentation about the SVG Radar chart including information about all of the options and methods that are available to you.

 

Example

The code below produces a chart like this:

<script>
    // Some data that's to be shown on the Radar chart. For multiple
    // lines it can also be an array of arrays
    var data = [50,57,54,59,56];
    //var data = [
    //    [50,58,54,59,56],
    //    [90,84,86,98,86]
    //];

    new RGraph.SVG.Radar({
        id: 'chart-container',
        data: data,
        options: {
            colors: ['black', 'red'],
            tickmarksStyle: 'circle',
            tickmarksSize: 5,
            linewidth: 2
        }
    }).draw();
</script>

 

The angles (coordinates) properties

The details of the points on the Radar chart are held in two arrays called obj.angles and obj.angles2. The difference is how they're indexed. With the former, each point is appended to the array - so on a Radar chart with two datasets where each consists of eight points - the obj.angles array would result in having 16 elements - one per point.

The obj.angles2 array on the other hand is indexed by the relevant dataset - to which points are appended. So in the previous example the angles2 array would have two elements - each of them being another array of eight elements (one per point). These elements are objects that consist of the following properties:

 

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.

Chart configuration properties

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

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

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

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

Background properties

PropertyDescriptionDefault
backgroundGridWhether the background "grid" is displayed or not.true
backgroundGridColorThe color of the background grid.#ddd
backgroundGridRadialsCountThe number of lines emanating from the center of the Radar chart outwards.null (linked to how many data points that you have)
backgroundGridConcentricsCountThe number of lines that go around the center of the radar chart.5
backgroundGridLinewidthThe linewidth that is used to draw the background grid.1
backgroundGridPolyWhether the background grid uses polygon concentric lines or circular based ones.true
backgroundGrid
Whether the background "grid" is displayed or not.
Default: true

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

backgroundGridRadialsCount
The number of lines emanating from the center of the Radar chart outwards.
Default: null (linked to how many data points that you have)

backgroundGridConcentricsCount
The number of lines that go around the center of the radar chart.
Default: 5

backgroundGridLinewidth
The linewidth that is used to draw the background grid.
Default: 1

backgroundGridPoly
Whether the background grid uses polygon concentric lines or circular based ones.
Default: true

Color properties

PropertyDescriptionDefault
colorsColors to be used for the Radar chart.['red', 'black', 'orange', 'green', '#6ff', '#ccc', 'pink', 'orange', 'cyan', 'maroon', 'olive', 'teal']
filledWhether the Radar chart is filed or not.false
filledOpacityThe opacity of the fill in Radar charts.0.25
filledAccumulativeIf true that datasets will be stacked on top of each other.true
colors
Colors to be used for the Radar chart.
Default: ['red', 'black', 'orange', 'green', '#6ff', '#ccc', 'pink', 'orange', 'cyan', 'maroon', 'olive', 'teal']

filled
Whether the Radar chart is filed or not.
Default: false

filledOpacity
The opacity of the fill in Radar charts.
Default: 0.25

filledAccumulative
If true that datasets will be stacked on top of each other.
Default: true

Labels and text properties

PropertyDescriptionDefault
textSizeThe size of the text.12
textFontThe font used to render the text.Arial, Verdana, sans-serif
textColorThe color of the labels.black
textItalicWhether the labels are italic or not.false
textBoldWhether the labels are bold or not.false
labelsAn array of labels for the chart.[]
labelsSizeThe size of the text.null
labelsFontThe font used to render the text.null
labelsColorThe color of the labels.null
labelsItalicWhether the labels are italic or not.null
labelsBoldWhether the labels are bold or not.null
textSize
The size of the text.
Default: 12

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

textColor
The color of the labels.
Default: black

textItalic
Whether the labels are italic or not.
Default: false

textBold
Whether the labels are bold or not.
Default: false

labels
An array of labels for the chart.
Default: []

labelsSize
The size of the text.
Default: null

labelsFont
The font used to render the text.
Default: null

labelsColor
The color of the labels.
Default: null

labelsItalic
Whether the labels are italic or not.
Default: null

labelsBold
Whether the labels are bold or not.
Default: null

Shadow properties

PropertyDescriptionDefault
shadowWhether or not the chart has a shadow or not.false
shadowOffsetxThe X offset of the shadow.2
shadowOffsetyThe Y offset of the shadow.2
shadowBlurThe blurring of the shadow.2
shadowOpacityThe opacity of the shadow color.0.25
shadow
Whether or not the chart has a shadow or not.
Default: false

shadowOffsetx
The X offset of the shadow.
Default: 2

shadowOffsety
The Y offset of the shadow.
Default: 2

shadowBlur
The blurring of the shadow.
Default: 2

shadowOpacity
The opacity of the shadow color.
Default: 0.25

Title properties

PropertyDescriptionDefault
titleThe title of the chart.(An empty string)
titleXThe specific X coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.null
titleYThe specific Y coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.null
titleHalignThe horizontal alignment of the title.center
titleColorThe color of the title.null
titleFontThe font used to render the title.null
titleSizeThe size of the font used to render the title.null
titleBoldWhether the title is bold or not.null
titleItalicWhether the title is italic or not.null
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.(An empty string)
titleSubtitleColorThe color of the subtitle.#aaa
titleSubtitleFontThe font used to render the subtitle.null
titleSubtitleSizeThe size of the font used to render the subtitle.null
titleSubtitleBoldWhether the subtitle is bold or not.null
titleSubtitleItalicWhether the subtitle is italic or not.null
title
The title of the chart.
Default: (An empty string)

titleX
The specific X coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.
Default: null

titleY
The specific Y coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.
Default: null

titleHalign
The horizontal alignment of the title.
Default: center

titleColor
The color of the title.
Default: null

titleFont
The font used to render the title.
Default: null

titleSize
The size of the font used to render the title.
Default: null

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

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

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: (An empty string)

titleSubtitleColor
The color of the subtitle.
Default: #aaa

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

titleSubtitleSize
The size of 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

Key properties

PropertyDescriptionDefault
keyAn array of the labels that appear on the key.null
keyColorsAn array of colors to be shown on the key. If not specified then the colors option will be used instead.null
keyLabelsColorThe color of the text in the key.null
keyLabelsBoldWhether the key text is bold or not.null
keyLabelsFontThe font to use for the key text.null
keyLabelsSizeThe size to use for the key text.null
ketLabelsItalicWhether the key text is italic or not.null
keyLabelsOffsetxThe horizontal pixel offset of the key text (just the text).0
keyLabelsOffsetyThe vertical pixel offset of the key text (just the text).-1
keyOffsetxThe horizontal pixel offset of the entire key.0
keyOffsetyThe horizontal pixel offset of the entire key.0
keyColorShapeThis controls which shape should be displayed on the key. It can be a string or an array of strings. The possible options are: circle triangle line dot rectdotrect
key
An array of the labels that appear on the key.
Default: null

keyColors
An array of colors to be shown on the key. If not specified then the colors option will be used instead.
Default: null

keyLabelsColor
The color of the text in the key.
Default: null

keyLabelsBold
Whether the key text is bold or not.
Default: null

keyLabelsFont
The font to use for the key text.
Default: null

keyLabelsSize
The size to use for the key text.
Default: null

ketLabelsItalic
Whether the key text is italic or not.
Default: null

keyLabelsOffsetx
The horizontal pixel offset of the key text (just the text).
Default: 0

keyLabelsOffsety
The vertical pixel offset of the key text (just the text).
Default: -1

keyOffsetx
The horizontal pixel offset of the entire key.
Default: 0

keyOffsety
The horizontal pixel offset of the entire key.
Default: 0

keyColorShape
This controls which shape should be displayed on the key. It can be a string or an array of strings. The possible options are: circle triangle line dot rectdot
Default: rect

Tooltip properties

PropertyDescriptionDefault
tooltipsAn array of tooltips for the chart. This array should NOT be multidimensional - even for stacked or grouped charts.null
tooltipsOverrideIf required, this can be a function that totally handles the tooltip showing instead of the default RGraph tooltips. It should look like this:
tooltipsOverride: function (obj, opt)
{
    // Show tooltip
}
The opt is an argument that contains these items:
  • object The chart object.
  • index The index of the element (that triggered the tooltip).
  • sequentialIndex The sequential index of the element that was clicked.
  • text The text to be used as the tooltip. Remember that this may contain HTML (or whatever else you may have specified).
  • event The event object (either a click or mousemove event).
null
tooltipsCssClassThe CSS class that's applied to the tooltip DIV.RGraph_tooltip
tooltipsEventThe event used for tooltips (either click or mousemove.click
tooltips
An array of tooltips for the chart. This array should NOT be multidimensional - even for stacked or grouped charts.
Default: null

tooltipsOverride
If required, this can be a function that totally handles the tooltip showing instead of the default RGraph tooltips. It should look like this:
tooltipsOverride: function (obj, opt)
{
    // Show tooltip
}
The opt is an argument that contains these items:
Default: null

tooltipsCssClass
The CSS class that's applied to the tooltip DIV.
Default: RGraph_tooltip

tooltipsEvent
The event used for tooltips (either click or mousemove.
Default: click

Highlight properties

PropertyDescriptionDefault
highlightStrokeThe color of the stroke of the highlight.rgba(0,0,0,0)
highlightFillThe color of the fill of the highlight.rgba(255,255,255,0.7)
highlightLinewidthThe linewidth of the stroke of the highlight.1
highlightStroke
The color of the stroke of the highlight.
Default: rgba(0,0,0,0)

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

highlightLinewidth
The linewidth of the stroke of the highlight.
Default: 1

Scale properties

PropertyDescriptionDefault
scaleVisibleWhether the scale is displayed or not.true
scaleUnitsPreThe units which are prepended to the numbers.(an empty string)
scaleUnitsPostThe units which are appended to the numbers.(an empty string)
scaleMinThe minimum scale value.0
scaleMaxThe maximum scale value.null
scalePointThe character to use as the decimal point..
scaleThousandThe character to use as the thousand separator.,
scaleRoundWhether to round the maximum scale value up.false
scaleDecimalsThe number of decimal places to display.0
scaleFormatterA function that handles all of the formatting of the value. The function should look like this:
function (obj, num)
{
}
null
scaleBoldWhether the scale values are bold or not.null
scaleItalicWhether the scale values are italic or not.null
scaleColorThe color of the scale labels.null
scaleSizeThe size of the scale labels.null
scaleFontThe font of the scale labels.null
scaleLabelsCountThe number of scale labels.5
scaleVisible
Whether the scale is displayed or not.
Default: true

scaleUnitsPre
The units which are prepended to the numbers.
Default: (an empty string)

scaleUnitsPost
The units which are appended to the numbers.
Default: (an empty string)

scaleMin
The minimum scale value.
Default: 0

scaleMax
The maximum scale value.
Default: null

scalePoint
The character to use as the decimal point.
Default: .

scaleThousand
The character to use as the thousand separator.
Default: ,

scaleRound
Whether to round the maximum scale value up.
Default: false

scaleDecimals
The number of decimal places to display.
Default: 0

scaleFormatter
A function that handles all of the formatting of the value. The function should look like this:
function (obj, num)
{
}

Default: null

scaleBold
Whether the scale values are bold or not.
Default: null

scaleItalic
Whether the scale values are italic or not.
Default: null

scaleColor
The color of the scale labels.
Default: null

scaleSize
The size of the scale labels.
Default: null

scaleFont
The font of the scale labels.
Default: null

scaleLabelsCount
The number of scale labels.
Default: 5

Tickmark properties

PropertyDescriptionDefault
tickmarksStyleThe style of tickmarks that are used. You set this to false to disable tickmarks. This can be either a string or an array of tickmark styles:
  • circle
  • filledcircle
  • rect
  • filledrect
circle
tickmarksLinewidthThe linewidth used for the tickmarks.1
tickmarksSizeThe overall size of the tickmarks.6
tickmarksFillThe fill color used for tickmarks (when in circle mode or rect mode).white
tickmarksStyle
The style of tickmarks that are used. You set this to false to disable tickmarks. This can be either a string or an array of tickmark styles:
Default: circle

tickmarksLinewidth
The linewidth used for the tickmarks.
Default: 1

tickmarksSize
The overall size of the tickmarks.
Default: 6

tickmarksFill
The fill color used for tickmarks (when in circle mode or rect mode).
Default: white

Other properties

PropertyDescriptionDefault
linewidthThe linewidth of the separating lines.1
linewidth
The linewidth of the separating lines.
Default: 1

Methods

 

obj.set(name, value)

This can be used to set properties if necessary. It's normally used after the chart is drawn if you need to set additional parameters or change them.

 

obj.on(event, handler)

This function adds an event listener (such as beforedraw or draw) to the chart object.

 

obj.exec(func)

This function simply executes the function that you give it (there and then - not on any particular event)