Semi-circular Progress bar

Example

View example on CodePen
<script>
    new RGraph.SemiCircularProgress({
        id: 'cvs',
        min: 0,
        max: 100,
        value: [48,32,12,8],
        options: {
            colors: ['#64E572','#FF81CE','#D5B5E7','#53F7FC'],
            centery: '+25',
            width: 50,
            radius: '-25',
            backgroundGrid: true,
            backgroundGridRadialsCount: 20,
            colorsStroke:        'transparent',
            labelsCenterIndex:   1,
            labelsCenterSize:    65,
            labelsCenterColor:   '#333',
            scale: true,
            scaleMax: 100,
            scaleLabelsSize: 9,
            scaleUnitsPost: '%',
            scaleLabelsCount: 20,
            scaleLabelsOffsetr: 5,
            tooltips: '%{key}',
            tooltipsFormattedKeyLabels: ['Richard','John','Lucy','Pob'],
            tooltipsFormattedUnitsPost: '%'
        }
    }).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
centerxYou can use this to stipulate exactly the X coordinate where the chart should appear. It's normally a number, but it can also be a string like this: +20 or this: -20 If this is the case then the number is added to the calculated coordinate thus allowing you to adjust the X coordinate.null
centeryYou can use this to stipulate exactly the Y coordinate where the chart should appear. It's normally a number, but it can also be a string like this: +20 or this: -20 If this is the case then the number is added to the calculated coordinate thus allowing you to adjust the Y coordinate.null
radiusYou can use this to specify the radius of the chart. It's normally a number, but it can also be a string like this: +20 or this: -20 If this is the case then the number is added to the calculated number thus allowing you to adjust the radius.null
anglesStartYou can specify the angle that the progress should start at with this property. Keep in mind though - that by default the progress is positioned at the bottom of the canvas. Remember that there are three "constants" available for you to use: RGraph.HALFPI RGraph.PI RGraph.TWOPIPi (3.14...)
anglesEndYou can specify the angle that the progress should end at with this property. Keep in mind though - that by default the progress is positioned at the bottom of the canvas. Remember that there are three "constants" available for you to use: RGraph.HALFPI RGraph.PI RGraph.TWOPI2 * Pi (6.28...)
centerx
You can use this to stipulate exactly the X coordinate where the chart should appear. It's normally a number, but it can also be a string like this: +20 or this: -20 If this is the case then the number is added to the calculated coordinate thus allowing you to adjust the X coordinate.
Default: null

centery
You can use this to stipulate exactly the Y coordinate where the chart should appear. It's normally a number, but it can also be a string like this: +20 or this: -20 If this is the case then the number is added to the calculated coordinate thus allowing you to adjust the Y coordinate.
Default: null

radius
You can use this to specify the radius of the chart. It's normally a number, but it can also be a string like this: +20 or this: -20 If this is the case then the number is added to the calculated number thus allowing you to adjust the radius.
Default: null

anglesStart
You can specify the angle that the progress should start at with this property. Keep in mind though - that by default the progress is positioned at the bottom of the canvas. Remember that there are three "constants" available for you to use: RGraph.HALFPI RGraph.PI RGraph.TWOPI
Default: Pi (3.14...)

anglesEnd
You can specify the angle that the progress should end at with this property. Keep in mind though - that by default the progress is positioned at the bottom of the canvas. Remember that there are three "constants" available for you to use: RGraph.HALFPI RGraph.PI RGraph.TWOPI
Default: 2 * Pi (6.28...)

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
colorsThe color of the bar. In version 6.05, this was updated to accommodate multiple values on your chart. It now operates much like the colors property on a Vertical or Horizontal Progress bar.[#0c0, #f66, #66f, yellow, pink,#ccc,#cc0,#0cc,#c0c]
colorsStrokeThis is the stroke color that's used for the inner part of the chart.#999
colors
The color of the bar. In version 6.05, this was updated to accommodate multiple values on your chart. It now operates much like the colors property on a Vertical or Horizontal Progress bar.
Default: [#0c0, #f66, #66f, yellow, pink,#ccc,#cc0,#0cc,#c0c]

colorsStroke
This is the stroke color that's used for the inner part of the chart.
Default: #999

Background properties

PropertyDescriptionDefault
backgroundColorThe background color (of the entire canvas).rgba(0,0,0,0)
backgroundGridWhether the background grid is drawn or not.true
backgroundGridLinewidthThe linewidth of the background grid.1
backgroundGridColorThe color of the background grid.#ddd
backgroundGridRadialsWhether the radial lines (the lines that emanate from the center coordinates) are drawn or not.true
backgroundGridRadialsCountThe number of radial lines that are drawn.10
backgroundGridCirclesWhether the semi-circular border lines are drawn on the background grid.true
backgroundGridMarginThis is the distance that the background grid extends to.20
backgroundBackdropBy default a backdrop is visible on the chart that is a faded version of the color that you give. You can disable the backdrop by setting this property to false.true
backgroundColor
The background color (of the entire canvas).
Default: rgba(0,0,0,0)

backgroundGrid
Whether the background grid is drawn or not.
Default: true

backgroundGridLinewidth
The linewidth of the background grid.
Default: 1

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

backgroundGridRadials
Whether the radial lines (the lines that emanate from the center coordinates) are drawn or not.
Default: true

backgroundGridRadialsCount
The number of radial lines that are drawn.
Default: 10

backgroundGridCircles
Whether the semi-circular border lines are drawn on the background grid.
Default: true

backgroundGridMargin
This is the distance that the background grid extends to.
Default: 20

backgroundBackdrop
By default a backdrop is visible on the chart that is a faded version of the color that you give. You can disable the backdrop by setting this property to false.
Default: true

Shadow properties

PropertyDescriptionDefault
shadowWhether a drop shadow is applied.false
shadowColorThe color of the shadow.rgba(220,220,220,1)
shadowOffsetxThe horizontal offset of the shadow.2
shadowOffsetyThe vertical offset of the shadow.2
shadowBlurThe severity of the shadow blurring effect.2
shadow
Whether a drop shadow is applied.
Default: false

shadowColor
The color of the shadow.
Default: rgba(220,220,220,1)

shadowOffsetx
The horizontal offset of the shadow.
Default: 2

shadowOffsety
The vertical offset of the shadow.
Default: 2

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

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 a 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).false
textFontThe font used to render the text.Arial, Verdana, sans-serif
textColorThe color of the labels.black
textSizeThe size of the text (in points).12
textBoldWhether the text is bold or not.false
textItalicWhether the text is italic or not.false
labelsMinWhether the minimum label is shown or not.true
labelsMinColorThe color of the minimum label.null
labelsMinFontThe font of the minimum label.null
labelsMinBoldWhether the minimum label is bold or not.null
labelsMinSizeThe size of the minimum label.null
labelsMinItalicWhether the minimum label is italic or not.null
labelsMinOffsetAngleAny offset to add to the angle that the minimum label uses (measured in radians). 0
labelsMinOffsetxAny horizontal offset to add to the X coordinate that the minimum label uses. 0
labelsMinOffsetyAny vertical offset to add to the Y coordinate that the minimum label uses.5
labelsMinUnitsPreUnits that are prepended to the number.null
labelsMinUnitsPostUnits that are appended to the number.null
labelsMinPointThe decimal point separator for the minimum label.null
labelsMinThousandThe thousand separator for the minimum label.null
labelsMinDecimalsThe number of decimals that are displayed.null
labelsMinSpecificYou can use this property to set the minimum label to exactly what you want.null
labelsMaxWhether the maximum label is shown or not.true
labelsMaxColorThe color of the maximum label.null
labelsMaxFontThe font of the maximum label.null
labelsMaxBoldWhether the maximum label is bold or not.null
labelsMaxSizeThe size of the maximum label.null
labelsMaxItalicWhether the maximum label is italic or not.null
labelsMaxOffsetAngleAny offset to add to the angle that the maximum label uses (measured in radians). 0
labelsMaxOffsetxAny horizontal offset to add to the X coordinate that the maximum label uses. 0
labelsMaxOffsetyAny vertical offset to add to the Y coordinate that the maximum label uses.5
labelsMaxUnitsPreUnits that are prepended to the number.null
labelsMaxUnitsPostUnits that are appended to the number.null
labelsMaxPointThe decimal point separator for the maximum label.null
labelsMaxThousandThe thousand separator for the maximum label.null
labelsMaxDecimalsThe number of decimals that are displayed.null
labelsMaxSpecificYou can use this property to set the maximum label to exactly what you want.null
labelsCenterWhether the center label is displayed or not.true
labelsCenterFontThe font used to draw the center label.null
labelsCenterBoldWhether the center label is bold or not.null
labelsCenterItalicWhether the center label is italic or not.null
labelsCenterSizeThe size of the center label.40
labelsCenterColorThe color of the center label.null
labelsCenterFadeIf true, and you're using the grow effect, this will cause the center label to fade in after the grow effect has run (but only the first time).false
labelsCenterUnitsPreUnits that are prepended to the number.null
labelsCenterUnitsPostUnits that are appended to the number.null
labelsCenterPointThe decimal point separator for the center label.null
labelsCenterThousandThe thousand separator for the center label.null
labelsCenterDecimalsThe number of decimals that are displayed.null
labelsCenterOffsetxThis allows you finer-grained control in the horizontal direction over the text positioning if you need it. 0
labelsCenterOffsetyThis allows you finer-grained control in the vertical direction over the text positioning if you need it. 0
labelsCenterIndexIf you have multiple values shown on your chart (ie you have an array of numbers instead of a single number) this is the array index of the value that you wish to show. 0
labelsCenterSpecificYou can use this property to set the center label to exactly what you want.null
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 a 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: false

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

textColor
The color of the labels.
Default: black

textSize
The size of the text (in points).
Default: 12

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

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

labelsMin
Whether the minimum label is shown or not.
Default: true

labelsMinColor
The color of the minimum label.
Default: null

labelsMinFont
The font of the minimum label.
Default: null

labelsMinBold
Whether the minimum label is bold or not.
Default: null

labelsMinSize
The size of the minimum label.
Default: null

labelsMinItalic
Whether the minimum label is italic or not.
Default: null

labelsMinOffsetAngle
Any offset to add to the angle that the minimum label uses (measured in radians).
Default: 0

labelsMinOffsetx
Any horizontal offset to add to the X coordinate that the minimum label uses.
Default: 0

labelsMinOffsety
Any vertical offset to add to the Y coordinate that the minimum label uses.
Default: 5

labelsMinUnitsPre
Units that are prepended to the number.
Default: null

labelsMinUnitsPost
Units that are appended to the number.
Default: null

labelsMinPoint
The decimal point separator for the minimum label.
Default: null

labelsMinThousand
The thousand separator for the minimum label.
Default: null

labelsMinDecimals
The number of decimals that are displayed.
Default: null

labelsMinSpecific
You can use this property to set the minimum label to exactly what you want.
Default: null

labelsMax
Whether the maximum label is shown or not.
Default: true

labelsMaxColor
The color of the maximum label.
Default: null

labelsMaxFont
The font of the maximum label.
Default: null

labelsMaxBold
Whether the maximum label is bold or not.
Default: null

labelsMaxSize
The size of the maximum label.
Default: null

labelsMaxItalic
Whether the maximum label is italic or not.
Default: null

labelsMaxOffsetAngle
Any offset to add to the angle that the maximum label uses (measured in radians).
Default: 0

labelsMaxOffsetx
Any horizontal offset to add to the X coordinate that the maximum label uses.
Default: 0

labelsMaxOffsety
Any vertical offset to add to the Y coordinate that the maximum label uses.
Default: 5

labelsMaxUnitsPre
Units that are prepended to the number.
Default: null

labelsMaxUnitsPost
Units that are appended to the number.
Default: null

labelsMaxPoint
The decimal point separator for the maximum label.
Default: null

labelsMaxThousand
The thousand separator for the maximum label.
Default: null

labelsMaxDecimals
The number of decimals that are displayed.
Default: null

labelsMaxSpecific
You can use this property to set the maximum label to exactly what you want.
Default: null

labelsCenter
Whether the center label is displayed or not.
Default: true

labelsCenterFont
The font used to draw the center label.
Default: null

labelsCenterBold
Whether the center label is bold or not.
Default: null

labelsCenterItalic
Whether the center label is italic or not.
Default: null

labelsCenterSize
The size of the center label.
Default: 40

labelsCenterColor
The color of the center label.
Default: null

labelsCenterFade
If true, and you're using the grow effect, this will cause the center label to fade in after the grow effect has run (but only the first time).
Default: false

labelsCenterUnitsPre
Units that are prepended to the number.
Default: null

labelsCenterUnitsPost
Units that are appended to the number.
Default: null

labelsCenterPoint
The decimal point separator for the center label.
Default: null

labelsCenterThousand
The thousand separator for the center label.
Default: null

labelsCenterDecimals
The number of decimals that are displayed.
Default: null

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

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

labelsCenterIndex
If you have multiple values shown on your chart (ie you have an array of numbers instead of a single number) this is the array index of the value that you wish to show.
Default: 0

labelsCenterSpecific
You can use this property to set the center label to exactly what you want.
Default: null

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

Scale properties

PropertyDescriptionDefault
scaleWhether a scale is shown on the chart. If true the minimum and maximum value that you give to the constructor will be used by default.false
scaleMinThis is the minimum value for the scale. This just affects the scale on the chart - not the bar itself. 0
scaleMaxThis is the maximum value for the scale. You don't have to give it and if you don't it will be the same as the max value that you give when you create the chart. This just affects the scale on the chart - not the bar that represents the value.null
scaleLabelsCountThis property allows you to stipulate how many labels there are on the scale.10
scaleLabelsColorThe color of the labels (defaults to the textColor property).null
scaleLabelsFontThe font of the labels (defaults to the textFont property)null
scaleLabelsSizeThe size of the labels (defaults to the textSize property)null
scaleLabelsBoldWhether the scale labels are bold or not (defaults to the textBold property)null
scaleLabelsItalicWhether the scale labels are italic or not (defaults to the textItalic property)null
scaleLabelsOffsetrIf you want to offset the scale labels (radially) you can do that with this property. 0
scaleLabelsOffsetxIf you want to offset the scale labels (in the X-direction) you can do that with this property. 0
scaleLabelsOffsetyIf you want to offset the scale labels (in the Y-direction) you can do that with this property. 0
scaleUnitsPreThese units are prepended to the scale numbers on the chart.none
scaleUnitsPostThese units are appended to the scale numbers on the chart.none
scaleDecimalsThis stipulates how many decimal places are shown on the scale numbers on the chart. 0
scalePointThe character that's used as the decimal point for the scale..
scaleThousandThe character that's used as the thousand separator for the scale.,
scaleFormatterIf you want to handle the formatting of the scale yourself you can do so with this property. It should be a function that returns the formatted number.null
scale
Whether a scale is shown on the chart. If true the minimum and maximum value that you give to the constructor will be used by default.
Default: false

scaleMin
This is the minimum value for the scale. This just affects the scale on the chart - not the bar itself.
Default: 0

scaleMax
This is the maximum value for the scale. You don't have to give it and if you don't it will be the same as the max value that you give when you create the chart. This just affects the scale on the chart - not the bar that represents the value.
Default: null

scaleLabelsCount
This property allows you to stipulate how many labels there are on the scale.
Default: 10

scaleLabelsColor
The color of the labels (defaults to the textColor property).
Default: null

scaleLabelsFont
The font of the labels (defaults to the textFont property)
Default: null

scaleLabelsSize
The size of the labels (defaults to the textSize property)
Default: null

scaleLabelsBold
Whether the scale labels are bold or not (defaults to the textBold property)
Default: null

scaleLabelsItalic
Whether the scale labels are italic or not (defaults to the textItalic property)
Default: null

scaleLabelsOffsetr
If you want to offset the scale labels (radially) you can do that with this property.
Default: 0

scaleLabelsOffsetx
If you want to offset the scale labels (in the X-direction) you can do that with this property.
Default: 0

scaleLabelsOffsety
If you want to offset the scale labels (in the Y-direction) you can do that with this property.
Default: 0

scaleUnitsPre
These units are prepended to the scale numbers on the chart.
Default: none

scaleUnitsPost
These units are appended to the scale numbers on the chart.
Default: none

scaleDecimals
This stipulates how many decimal places are shown on the scale numbers on the chart.
Default: 0

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

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

scaleFormatter
If you want to handle the formatting of the scale yourself you can do so with this property. It should be a function that returns the formatted number.
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

Interactive features properties

PropertyDescriptionDefault
tooltipsAn array of tooltips. These are shown when the progress bar is clicked on. Tooltips can contain html.An empty array
tooltipsEffectThe effect used for showing tooltips. Possible values are slide fade or none.slide
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 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
contextmenuAn array of context menu items. More information on context menus is here.[] (An empty array)
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
adjustableDefaulting to false, this determines whether your chart will be adjustable.false
tooltips
An array of tooltips. These are shown when the progress bar is clicked on. Tooltips can contain html.
Default: An empty array

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

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

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

contextmenu
An array of context menu items. More information on context menus is here.
Default: [] (An empty array)

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

adjustable
Defaulting to false, this determines whether your chart will be adjustable.
Default: false

Key properties

The key properties are documented on the key documentation page.

Miscellaneous properties

PropertyDescriptionDefault
variantBy setting this to rounded you can get the ends of the bar and the background rounded instead of square. If you do this you'll probably also want to set labelsMin and labelsMax to false. There's an example of this style in the download archive called semicircularprogress-rounded.htmldefault
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. It's passed the shape object as an argument.null
highlightStrokeIf you use tooltips, this controls the color of the highlight stroke.black
highlightFillIf you use tooltips, this controls the color of the highlight fill.rgba(255,255,255,0.5)
cleartoThis is used in animations and effects as the default color to use when clearing the canvas.null
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
variant
By setting this to rounded you can get the ends of the bar and the background rounded instead of square. If you do this you'll probably also want to set labelsMin and labelsMax to false. There's an example of this style in the download archive called semicircularprogress-rounded.html
Default: default

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. It's passed the shape object as an argument.
Default: null

highlightStroke
If you use tooltips, this controls the color of the highlight stroke.
Default: black

highlightFill
If you use tooltips, this controls the color of the highlight fill.
Default: rgba(255,255,255,0.5)

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

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 the bar when it's been clicked on or hovered over. It returns an object which has the following indexes available:
object The chart object.
x The center X coordinate of the progress bar.
y The center Y coordinate of the progress bar.
angleStart The start angle of the indicator bar (it's measured in radians).
angleEnd The end angle of the indicator bar (it's measured in radians).
radiusInner The radius of the inside of the indicator bar.
radiusOuter The radius of the outside of the indicator bar.
dataset As there's only ever one bar on the progress bar this is always zero.
index As there's only ever one bar on the progress bar this is always zero.
sequentialIndex As there's only ever one bar on the progress bar this is always zero.
tooltip If a tooltip is associated with the bar 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>
    semicircularprogress.canvas.onclick = function (e)
    {
        RGraph.redraw();
    
        var canvas = e.target,
            obj    = canvas.__object__,
            shape  = obj.getShape(e);

        if (shape) {            
            // Draw the outside of the semi-circular progress
            obj.path(
                'lw 10 b a % % % % % false',
                shape.x, shape.y, shape.radiusOuter, shape.angleStart, shape.angleEnd
            );

            // Draw the inside of the semi-circular progress
            obj.path(
                'a % % % % % true c s black f red',
                shape.x, shape.y, shape.radiusInner, shape.angleEnd, shape.angleStart
            );
        }
    }
</script>

obj.getValue(event)

This method can be used to get the value at a particular point or at the mouse coordinates, based on the scale that is in use. You pass it an event object.

myChart.canvas.onclick = function (e)
{
    var obj   = e.target.__object__;
    var value = obj.getValue(e);
    
    // ...
}

obj.getAngle(value)

This method can be used to retrieve the correct angle (in radians) for the given value.

<script>
    angle = obj.getAngle(7);
</script>

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:

.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.SemiCircularProgress({
    id: 'cvs',
    min: 0,
    max: 100,
    value: 56,
    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:
new RGraph.SemiCircularProgress({
    id: 'cvs',
    min: 0,
    max: 100,
    value: 44,
    options: {
    }
}).on('draw', function (obj)
{
    console.log('The draw event has fired');
    
}).draw();

Effects

These effects are available and can be used instead of the draw function. There are also generic effects available which you can see here: Generic effects and transitions
<script>
    //
    // Optional callback function that's called when the effect is complete.
    //
    function myCallback (obj)
    {
        // ...
    }

    new RGraph.SemiCircularProgress({
        id: 'cvs',
        min: 0,
        max: 100,
        value: 56,
        options: {
            marginLeft: 35
        }
    }).grow({frames: 60}, myCallback);
</script>