Semi-circular Progress bar
Example
<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
- Margin properties
- Color properties
- Background properties
- Shadow properties
- Labels and text properties
- Scale properties
- Title properties
- Interactive features properties
- Key properties
- Miscellaneous properties
Chart configuration properties
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
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
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
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
Shadow properties
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
Property | Description | Default |
---|---|---|
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> | 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. | visible |
textAccessiblePointerevents | This controls whether the DOM text responds to mouse-based events or not (it sets the pointer-events CSS property to none ). | false |
textFont | The font used to render the text. | Arial, Verdana, sans-serif |
textColor | The color of the labels. | black |
textSize | The size of the text (in points). | 12 |
textBold | Whether the text is bold or not. | false |
textItalic | Whether the text is italic or not. | false |
labelsMin | Whether the minimum label is shown or not. | true |
labelsMinColor | The color of the minimum label. | null |
labelsMinFont | The font of the minimum label. | null |
labelsMinBold | Whether the minimum label is bold or not. | null |
labelsMinSize | The size of the minimum label. | null |
labelsMinItalic | Whether the minimum label is italic or not. | null |
labelsMinOffsetAngle | Any offset to add to the angle that the minimum label uses (measured in radians ). | 0 |
labelsMinOffsetx | Any horizontal offset to add to the X coordinate that the minimum label uses. | 0 |
labelsMinOffsety | Any vertical offset to add to the Y coordinate that the minimum label uses. | 5 |
labelsMinUnitsPre | Units that are prepended to the number. If left as null this falls back to the scaleUnitsPre property. | null |
labelsMinUnitsPost | Units that are appended to the number. If left as null this falls back to the scaleUnitsPost property. | null |
labelsMinPoint | The decimal point separator for the minimum label. If left as null this falls back to the scalePoint property. | null |
labelsMinThousand | The thousand separator for the minimum label. If left as null this falls back to the scaleThousand property. | null |
labelsMinDecimals | The number of decimals that are displayed. If left as null this falls back to the scaleDecimals property. | null |
labelsMinSpecific | You can use this property to set the minimum label to exactly what you want. | null |
labelsMax | Whether the maximum label is shown or not. | true |
labelsMaxColor | The color of the maximum label. | null |
labelsMaxFont | The font of the maximum label. | null |
labelsMaxBold | Whether the maximum label is bold or not. | null |
labelsMaxSize | The size of the maximum label. | null |
labelsMaxItalic | Whether the maximum label is italic or not. | null |
labelsMaxOffsetAngle | Any offset to add to the angle that the maximum label uses (measured in radians ). | 0 |
labelsMaxOffsetx | Any horizontal offset to add to the X coordinate that the maximum label uses. | 0 |
labelsMaxOffsety | Any vertical offset to add to the Y coordinate that the maximum label uses. | 5 |
labelsMaxUnitsPre | Units that are prepended to the number. If left as null this falls back to the scaleUnitsPre property. | null |
labelsMaxUnitsPost | Units that are appended to the number. If left as null this falls back to the scaleUnitsPost property. | null |
labelsMaxPoint | The decimal point separator for the maximum label. If left as null this falls back to the scalePoint property. | null |
labelsMaxThousand | The thousand separator for the maximum label. If left as null this falls back to the scaleThousand property. | null |
labelsMaxDecimals | The number of decimals that are displayed. If left as null this falls back to the scaleDecimals property. | null |
labelsMaxSpecific | You can use this property to set the maximum label to exactly what you want. | null |
labelsCenter | Whether the center label is displayed or not. | true |
labelsCenterFont | The font used to draw the center label. | null |
labelsCenterBold | Whether the center label is bold or not. | null |
labelsCenterItalic | Whether the center label is italic or not. | null |
labelsCenterSize | The size of the center label. | 40 |
labelsCenterColor | The color of the center label. | 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). | false |
labelsCenterUnitsPre | Units that are prepended to the number. If left as null this falls back to the scaleUnitsPre property. | null |
labelsCenterUnitsPost | Units that are appended to the number. If left as null this falls back to the scaleUnitsPost property. | null |
labelsCenterPoint | The decimal point separator for the center label. If left as null this falls back to the scalePoint property. | null |
labelsCenterThousand | The thousand separator for the center label. If left as null this falls back to the scaleThousand property. | null |
labelsCenterDecimals | The number of decimals that are displayed. If left as null this falls back to the scaleDecimals property. | null |
labelsCenterOffsetx | This allows you finer-grained control in the horizontal direction over the text positioning if you need it. | 0 |
labelsCenterOffsety | This allows you finer-grained control in the vertical direction over the text positioning if you need it. | 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. | 0 |
labelsCenterSpecific | You can use this property to set the center label to exactly what you want. | 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. | null |
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. If left as
null
this falls back to the scaleUnitsPre
property.Default: null
labelsMinUnitsPost
Units that are appended to the number. If left as
null
this falls back to the scaleUnitsPost
property.Default: null
labelsMinPoint
The decimal point separator for the minimum label. If left as
null
this falls back to the scalePoint
property.Default: null
labelsMinThousand
The thousand separator for the minimum label. If left as
null
this falls back to the scaleThousand
property.Default: null
labelsMinDecimals
The number of decimals that are displayed. If left as
null
this falls back to the scaleDecimals
property.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. If left as
null
this falls back to the scaleUnitsPre
property.Default: null
labelsMaxUnitsPost
Units that are appended to the number. If left as
null
this falls back to the scaleUnitsPost
property.Default: null
labelsMaxPoint
The decimal point separator for the maximum label. If left as
null
this falls back to the scalePoint
property.Default: null
labelsMaxThousand
The thousand separator for the maximum label. If left as
null
this falls back to the scaleThousand
property.Default: null
labelsMaxDecimals
The number of decimals that are displayed. If left as
null
this falls back to the scaleDecimals
property.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. If left as
null
this falls back to the scaleUnitsPre
property.Default: null
labelsCenterUnitsPost
Units that are appended to the number. If left as
null
this falls back to the scaleUnitsPost
property.Default: null
labelsCenterPoint
The decimal point separator for the center label. If left as
null
this falls back to the scalePoint
property.Default: null
labelsCenterThousand
The thousand separator for the center label. If left as
null
this falls back to the scaleThousand
property.Default: null
labelsCenterDecimals
The number of decimals that are displayed. If left as
null
this falls back to the scaleDecimals
property.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
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
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
Property | Description | Default |
---|---|---|
tooltips | An array of tooltips. These are shown when the progress bar is clicked on. Tooltips can contain HTML . | An empty array |
tooltipsEffect | The effect used for showing tooltips. Possible values are slide fade or none . | 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. | null |
tooltipsFormattedPoint | When using formatted tooltip strings this is used as the point when using the %{value_formatted} option. | . |
tooltipsFormattedThousand | When using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option. | , |
tooltipsFormattedDecimals | When using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option. | 0 |
tooltipsFormattedUnitsPre | When using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option. | (an empty string) |
tooltipsFormattedUnitsPost | When using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option. | (an empty string) |
tooltipsFormattedKeyColors | When using formatted tooltip strings you can give specific colors for the %{key} option to use. | null |
tooltipsFormattedKeyColorsShape | This is the shape that's used in the tooltip key. It can be square or circle | 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"; } | null |
tooltipsFormattedKeyLabels | When using formatted tooltip strings these are the labels that are displayed. | [] (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 . | 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; } | 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. | 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. | 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. | 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' } | null |
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. | 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' } | null |
tooltipsCssClass | This is the name of the CSS class the chart uses. | RGraph_tooltip |
tooltipsOffsetx | This property allows you to shift the tooltips left or right. | 0 |
tooltipsOffsety | This property allows you to shift the tooltips up or down. | 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:
| null |
contextmenu | An array of context menu items. More information on context menus is here. | [] (An empty array) |
annotatable | Whether annotations are enabled for the chart (ie you can draw on the chart interactively. | false |
annotatableColor | If you do not allow the use of the palette, then this will be the only color allowed for annotations. | black |
annotatableLinewidth | This is the linewidth of the annotations. | 1 |
adjustable | Defaulting to false, this determines whether your bar chart will be adjustable. | false |
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
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:
- A single
boolean
value (ietrue
orfalse
) 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
orfalse
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)
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 bar chart will be adjustable.
Default: false
Key properties
The key properties are documented on the key documentation page.Miscellaneous properties
Property | Description | Default |
---|---|---|
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 |
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. | null |
highlightStroke | If you use tooltips, this controls the color of the highlight stroke. | black |
highlightFill | If you use tooltips, this controls the color of the highlight fill. | rgba(255,255,255,0.5) |
clearto | This is used in animations and effects as the default color to use when clearing the canvas . | null |
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
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.
The responsive function is documented on its 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:
adjustbegin
This event fires at the start of adjusting - like the standardmousedown
event.adjust
This event fires (repeatedly) during adjusting - like the standardmousemove
event.adjustend
This event fires at the end of adjusting - like the standardmouseup
event.annotatebegin
This event fires at the start of annotating - like the standardmousedown
event.annotate
This event fires (repeatedly) during annotating - like the standardmousemove
event.annotateend
This event fires at the end of annotating - like the standardmouseup
event.annotateclear
This event fires at the end of theRGraph.clearAnnotations
function.beforeclear
This event fires at the start of theRGraph.clear
function.clear
This event fires at the end of theRGraph.clear
function.click
This is similar to the standardcanvas
click
event but this only fires when you click on a bar - not the wholecanvas
.beforecontextmenu
This event fires when you have the contextmenu enabled and it is about to appear.contextmenu
This event fires when you have the contextmenu enabled and it has been displayed.beforedraw
This event fires at the start of thedraw
method before anything has been done.firstdraw
This event fires at the end of thedraw
function - but only the first time that thedraw
function is called.draw
This event fires at the end of thedraw
function.mousemove
This event is similar to the standardmousemove
event but only fires when you move the mouse over a bar on the chart.mouseover
This event is similar to the standardmouseover
event but only fires when you move the mouse over a bar on the chart.mouseout
This event is similar to the standardmouseout
event but only fires when you move the mouse away from a bar on the chart that you've previously hovered over.beforetooltip
This event fires at the start of the tooltip showing process.tooltip
This event fires after a tooltip has been shown.
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 thedraw
function. There are also generic effects available which
you can see here: Generic effects and transitions
- The
grow
effect (effects-semicircularprogress-grow.html
in the download archive)
<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>