Vertical Progress bar
Example
<script> new RGraph.VProgress({ id: 'cvs', min: 0, max: 100, value: 48, options: { colors: ['Gradient(#faa:red)'], marginRight: 50, marginInner: 15, tooltips: '<span style="font-size: 14pt">Todays temperature</span><br/>%{key}', tooltipsFormattedKeyLabels: ['London'], tooltipsFormattedKeyColors: ['red'], tooltipsFormattedUnitsPost: '°', tooltipsCss: { fontSize: '18pt', textAlign: 'left' } } }).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.
- Margin properties
- Background properties
- Color properties
- Tickmark properties
- Shadow properties
- Labels and text properties
- Scale properties
- Title properties
- Interactive features properties
- Key properties
- Miscellaneous properties
Margin properties
The left margin of the chart).
Default: 35
marginRight
The right margin of the chart.
Default: 35
marginTop
The top margin of the chart.
Default: 35
marginBottom
The bottom margin of the chart.
Default: 35
marginInner
The inner margin of the progress bar.
Default: 0
Background properties
The background color.
Default: #eee
Color properties
The color of the bar. This can be a solid color, or a gradient that you create.
Default: [#0c0]
colorsStrokeInner
This is the stroke color used for the inner part of the chart.
Default: #999
colorsStrokeOuter
This is the stroke color used for the outer part of the chart.
Default: #999
Tickmark properties
Property | Description | Default |
---|---|---|
tickmarksOuterCount | How many outer tickmarks there are. | 0 |
tickmarksInnerCount | How many inner tickmarks there are. | 0 |
How many outer tickmarks there are.
Default: 0
tickmarksInnerCount
How many inner tickmarks there are.
Default: 0
Shadow properties
Whether a drop shadow is applied.
Default: false
shadowColor
The color of the shadow.
Default: rgba(0,0,0,0.5)
shadowOffsetx
The horizontal offset of the shadow.
Default: 3
shadowOffsety
The vertical offset of the shadow.
Default: 3
shadowBlur
The severity of the shadow blurring effect.
Default: 3
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 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 ). | true |
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 on the chart is bold or not. | false |
textItalic | Whether the text on the chart is bold or not. | false |
labelsFont | The font used to render the labels. | null |
labelsColor | The color of the labels. | null |
labelsSize | The size of the labels (in points). | null |
labelsBold | Whether the labels on the chart are bold or not. | null |
labelsItalic | Whether the labels on the chart are italic or not. | null |
labelsPosition | Can be left or right and controls which side the labels are positioned on. | right |
labelsSpecific | If you want to specify your own labels, which can be textual, you can use this. You can also give this option a string if you prefer and use formatted labels. | null |
labelsSpecificFormattedDecimals | When using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro. | 0 |
labelsSpecificFormattedPoint | When using formatted labels this is the decimal point character that's used with the %{value_formatted} macro. | . |
labelsSpecificFormattedThousand | When using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro. | , |
labelsSpecificFormattedUnitsPre | When using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro. | (an empty string) |
labelsSpecificFormattedUnitsPost | When using formatted labels these are the units that are appended to the number with the %{value_formatted} macro. | (an empty string) |
labelsCount | This controls how many labels there are. When using formatted labels use this property to set how many labels there should be. | 10 |
labelsOffsetx | This can be used to move the labels in the X-direction. | 0 |
labelsOffsety | This can be used to move the labels in the Y-direction. | 0 |
labelsInner | Whether a label is displayed just above the progress bar. | false |
labelsInnerFont | The font used for the label. | null |
labelsInnerSize | The size of the label. | null |
labelsInnerColor | The color of the label. | null |
labelsInnerBold | Whether the label is bold or not. | null |
labelsInnerItalic | Whether the label is italic or not. | null |
labelsInnerBackgroundFill | The background color of the label. | rgba(255,255,255,0.75) |
labelsInnerBorder | Whether the label has a border or not. | true |
labelsInnerBorderLinewidth | The linewidth of the border of the label. | 1 |
labelsInnerBorderColor | The color of the border of the label. | #ccc |
labelsInnerDecimals | How many decimals the label has. | 0 |
labelsInnerUnitsPre | Units that are prepended to the label. | (an empty string) |
labelsInnerUnitsPost | Units that are appended to the label. | (an empty string) |
labelsInnerPoint | The character that's used as the decimal separator. | . |
labelsInnerThousand | The character that's used as the thousand separator. | , |
labelsInnerSpecific | This can be a specific bit of text that you want to show, instead of the value, for the label. | null |
labelsInnerOffsetx | This property gives you finer-grained control in the horizontal direction over the positioning of the label if you need it. | 0 |
labelsInnerOffsety | This property gives you finer-grained control in the vertical direction over the positioning of the label if you need it. | 0 |
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 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: true
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 on the chart is bold or not.
Default: false
textItalic
Whether the text on the chart is bold or not.
Default: false
labelsFont
The font used to render the labels.
Default: null
labelsColor
The color of the labels.
Default: null
labelsSize
The size of the labels (in points).
Default: null
labelsBold
Whether the labels on the chart are bold or not.
Default: null
labelsItalic
Whether the labels on the chart are italic or not.
Default: null
labelsPosition
Can be
left
or right
and controls which side the labels are positioned on.Default: right
labelsSpecific
If you want to specify your own labels, which can be textual, you can use this. You can also give this option a string if you prefer and use formatted labels.
Default: null
labelsSpecificFormattedDecimals
When using formatted labels this is the number of decimals that are applied to the
%{value_formatted}
macro.Default: 0
labelsSpecificFormattedPoint
When using formatted labels this is the decimal point character that's used with the
%{value_formatted}
macro.Default: .
labelsSpecificFormattedThousand
When using formatted labels this is the thousand separator character that's used with the
%{value_formatted}
macro.Default: ,
labelsSpecificFormattedUnitsPre
When using formatted labels these are the units that are prepended to the number with the
%{value_formatted}
macro.Default: (an empty string)
labelsSpecificFormattedUnitsPost
When using formatted labels these are the units that are appended to the number with the
%{value_formatted}
macro.Default: (an empty string)
labelsCount
This controls how many labels there are. When using formatted labels use this property to set how many labels there should be.
Default: 10
labelsOffsetx
This can be used to move the labels in the X-direction.
Default: 0
labelsOffsety
This can be used to move the labels in the Y-direction.
Default: 0
labelsInner
Whether a label is displayed just above the progress bar.
Default: false
labelsInnerFont
The font used for the label.
Default: null
labelsInnerSize
The size of the label.
Default: null
labelsInnerColor
The color of the label.
Default: null
labelsInnerBold
Whether the label is bold or not.
Default: null
labelsInnerItalic
Whether the label is italic or not.
Default: null
labelsInnerBackgroundFill
The background color of the label.
Default: rgba(255,255,255,0.75)
labelsInnerBorder
Whether the label has a border or not.
Default: true
labelsInnerBorderLinewidth
The
linewidth
of the border of the label.Default: 1
labelsInnerBorderColor
The color of the border of the label.
Default: #ccc
labelsInnerDecimals
How many decimals the label has.
Default: 0
labelsInnerUnitsPre
Units that are prepended to the label.
Default: (an empty string)
labelsInnerUnitsPost
Units that are appended to the label.
Default: (an empty string)
labelsInnerPoint
The character that's used as the decimal separator.
Default: .
labelsInnerThousand
The character that's used as the thousand separator.
Default: ,
labelsInnerSpecific
This can be a specific bit of text that you want to show, instead of the value, for the label.
Default: null
labelsInnerOffsetx
This property gives you finer-grained control in the horizontal direction over the positioning of the label if you need it.
Default: 0
labelsInnerOffsety
This property gives you finer-grained control in the vertical direction over the positioning of the label if you need it.
Default: 0
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
The units that the Y scale is measured in (these are prepended to the number).
Default: none
scaleUnitsPost
The units that the Y scale is measured in (these are appended to the number).
Default: none
scaleDecimals
This stipulates how many decimal places there are.
Default: 0
scalePoint
The character that's used as the decimal point.
Default: .
scaleThousand
The character that's used as the thousand separator.
Default: ,
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
titleSide
Using this property you can specify a title for the chart that is displayed in the left-hand margin (vertically).
Default: null
titleSideFont
The font used to draw the title.
Default: null
titleSideSize
The font size of the title.
Default: null
titleSideColor
The color used for the title.
Default: null
titleSideBold
Whether the title is bold or not.
Default: null
titleSideItalic
Whether the title is italic or not.
Default: null
titleSideOffsetx
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
titleSideOffsety
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
Interactive features properties
Property | Description | Default |
---|---|---|
tooltips | An array, albeit one element only. This is 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 |
tooltipsPointerOffsetx | This allows you to adjust the vertical position of the tooltips pointer. | 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). | 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. | true |
tooltipsCssClass | This is the name of the css class the chart uses. | RGraph_tooltip |
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 |
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 about 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 chart will be adjustable. | false |
An array, albeit one element only. This is 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
tooltipsCssClass
This is the name of the
css
class the chart uses.Default: RGraph_tooltip
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
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 about 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
Property | Description | 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. As of version 5.23 you can also set this to invert as well. If you do this on a dark background you may find that you need to change the highlightFill color setting as well. | 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) |
highlightLinewidth | This is the linewidth of the highlight stroke. | 1 |
beveled | This controls whether the bar has a beveled appearance. | false |
clearto | This is used in animations and effects as the default color to use when clearing the canvas . | 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. | null |
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. As of version 5.23 you can also set this to invert
as well. If you do this on a dark background you may find that you need to change the highlightFill
color setting as well.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)
highlightLinewidth
This is the
linewidth
of the highlight stroke.Default: 1
beveled
This controls whether the bar has a beveled appearance.
Default: false
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 X coordinate of the progress bar. |
y |
The Y coordinate of the progress bar. |
width |
The width of the progress bar. |
height |
The height of the progress bar. |
dataset |
As there's only ever one dataset on the progress bar this is always zero. |
index |
This is the index of the element that's been clicked or hovered-over. If your progress bar only has one value then this will always be zero - it's only really used in a stacked bar. |
sequentialIndex |
Because there's only one bar (or set of bars on a stacked chart) this value is
always the same as the index value.
|
tooltip |
If a tooltip is associated with the segment 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>
vprogress.canvas.onclick = function (e)
{
RGraph.redraw();
var canvas = e.target,
obj = canvas.__object__,
shape = obj.getShape(e);
if (shape) {
// Highlight the progress bar.
obj.path(
'lw 10 b r % % % % s black f red',
shape.x, shape.y, shape.width, shape.height
);
}
}
</script>
obj.getValue(mixed)
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.
Not simply the coordinates of the mouse. The argument can either be an event object (for use in event listener functions) OR a two-element
array consisting of the X and Y coordinates (ie when you're not necessarily in an event listener). It returns null
if the mouse
or coordinates are in the margin areas. An example:
progress.canvas.onclick = function (e)
{
var obj = e.target.__object__;
var value = obj.getValue(e);
// ...
}
obj.getYCoord(value)
This method can be used to retrieve the correct Y coordinate for the given Y value.
<script> coord = progress.getYCoord(27); </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:
obj.on('draw', function (obj)
{
// Put your event code here
});
The function is useful if you use method chaining when creating your charts:
progress = new RGraph.VProgress({ 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:
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 standard ccanvas
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.beforeinteractivekey
When you're using the interactive key this event fires just before the key and chart are highlighted.afterinteractivekey
When you're using the interactive key this event fires just after the key and chart are highlighted.keyclick
This event fires when you click on the key - you don't have to be using the interactive key however.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.VProgress({ id: 'cvs', min: 0, max: 100, value: 46, 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-vprogress-grow.html
in the download archive)
<script> // // Optional callback function that's called when the effect is complete // function myCallback (obj) { // ... } var obj = new RGraph.VProgress({ id: 'cvs', min: 0, max: 100, value: 56, options: { marginLeft: 35 } }).grow({frames: 60}, myCallback); </script>