Horizontal Progress bars

Example

View example on CodePen
<script>
    new RGraph.HProgress({
        id: 'cvs',
        min: 0,
        max: 100,
        value: 63,
        options: {
            tooltips: '<b>Results:</b>%{key}',
            tooltipsFormattedKeyLabels: ['Richard'],
            colors: ['red'],
            marginInner: 10,
            tooltipsCss: {
                fontSize: '16pt',
                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 above.

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
marginInnerThis is the margin that can be applied to the inside of the progress bar. 0
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

marginInner
This is the margin that can be applied to the inside of the progress bar.
Default: 0

Tickmark properties

PropertyDescriptionDefault
tickmarksColorThe color used for tickmarks.black
tickmarksOuterCountHow many outer tickmarks there are. 0
tickmarksInnerCountHow many inner tickmarks there are. 0
tickmarksColor
The color used for tickmarks.
Default: black

tickmarksOuterCount
How many outer tickmarks there are.
Default: 0

tickmarksInnerCount
How many inner tickmarks there are.
Default: 0

Color properties

PropertyDescriptionDefault
colorsThe colors of the bar(s). This can be a solid color or a gradient that you create.[#0c0]
colorsStrokeInnerThis is the stroke color used for the inner part of the chart.#999
colorsStrokeOuterThis is the stroke color used for the outer part of the chart.#999
backgroundColorThe background color.#eee
colors
The colors of the bar(s). 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

backgroundColor
The background color.
Default: #eee

Shadow properties

PropertyDescriptionDefault
shadowWhether the progress bar has a shadow. false
shadowOffsetxThe X offset of the progress bar shadow.3
shadowOffsetyThe Y offset of the progress bar shadow.3
shadowColorThe color of the shadow.rgba(0,0,0,0.5)
shadowBlurThe blurring effect that is applied to the shadow.3
shadow
Whether the progress bar has a shadow.
Default: false

shadowOffsetx
The X offset of the progress bar shadow.
Default: 3

shadowOffsety
The Y offset of the progress bar shadow.
Default: 3

shadowColor
The color of the shadow.
Default: rgba(0,0,0,0.5)

shadowBlur
The blurring effect that is applied to the shadow.
Default: 3

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 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).true
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 on the chart is bold or not.false
textItalicWhether the text on the chart is italic or not.false
labelsPositionThis determines whether the labels are placed on the top or the bottom of the progress bar.bottom
labelsSpecificIf you want to specify your own labels, which can be textual, you can use this. This can also be a string when using formatted labels.null
labelsSpecificFormattedDecimalsWhen using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro. 0
labelsSpecificFormattedPointWhen using formatted labels this is the decimal point character that's used with the %{value_formatted} macro..
labelsSpecificFormattedThousandWhen using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro.,
labelsSpecificFormattedUnitsPreWhen using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro.(an empty string)
labelsSpecificFormattedUnitsPostWhen using formatted labels these are the units that are appended to the number with the %{value_formatted} macro.(an empty string)
labelsCountThis controls how many labels are shown as part of the scale. If you don't want any labels at all you should use this code instead of setting this property to 0: obj.set('labelsSpecific', []);. This option is also used to determine how many labels there are when you use formatted labels.10
labelsOffsetxThis can be used to move the labels in the X-direction. 0
labelsOffsetyThis can be used to move the labels in the Y-direction. 0
labelsFontThe font used by the labels.null
labelsSizeThe size of the labels.null
labelsColorThe color of the labels.null
labelsBoldWhether the labels are bold or not.null
labelsItalicWhether the labels are italic or not.null
labelsInnerWhether a label is displayed just above the progress bar.false
labelsInnerFontThe font used by the inner label.null
labelsInnerSizeThe size of the inner label.null
labelsInnerColorThe color of the inner label.null
labelsInnerBoldWhether the inner label is bold or not.null
labelsInnerItalicWhether the inner label is italic or not.null
labelsInnerBackgroundFillThis is used as the color of the background of the label.rgba(255,255,255,0.7)
labelsInnerDecimalsThe number of decimals on the inner label. 0
labelsInnerUnitsPreThe units that are prepended to the inner label.[an empty string]
labelsInnerUnitsPostThe units that are appended to the inner label.[an empty string]
labelsInnerPointThe decimal point separator for the inner label.null
labelsInnerThousandThe thousand separator for the inner label.null
labelsInnerBorderWhether the inner labels have a border or not.true
labelsInnerBorderColorThe color of the inner border.#ccc
labelsInnerBorderLinewidthThe linewidth of the inner labels border.1
labelsInnerSpecificThis can be a string that's used as the label instead of the value.null
labelsInnerOffsetxThis allows you finer-grained control in the horizontal direction over the text positioning if you need it. 0
labelsInnerOffsetyThis allows you finer-grained control in the vertical direction over the text positioning if you need it. 0
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 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 italic or not.
Default: false

labelsPosition
This determines whether the labels are placed on the top or the bottom of the progress bar.
Default: bottom

labelsSpecific
If you want to specify your own labels, which can be textual, you can use this. This can also be a string when using 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 are shown as part of the scale. If you don't want any labels at all you should use this code instead of setting this property to 0: obj.set('labelsSpecific', []);. This option is also used to determine how many labels there are when you use formatted labels.
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

labelsFont
The font used by the labels.
Default: null

labelsSize
The size of the labels.
Default: null

labelsColor
The color of the labels.
Default: null

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

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

labelsInner
Whether a label is displayed just above the progress bar.
Default: false

labelsInnerFont
The font used by the inner label.
Default: null

labelsInnerSize
The size of the inner label.
Default: null

labelsInnerColor
The color of the inner label.
Default: null

labelsInnerBold
Whether the inner label is bold or not.
Default: null

labelsInnerItalic
Whether the inner label is italic or not.
Default: null

labelsInnerBackgroundFill
This is used as the color of the background of the label.
Default: rgba(255,255,255,0.7)

labelsInnerDecimals
The number of decimals on the inner label.
Default: 0

labelsInnerUnitsPre
The units that are prepended to the inner label.
Default: [an empty string]

labelsInnerUnitsPost
The units that are appended to the inner label.
Default: [an empty string]

labelsInnerPoint
The decimal point separator for the inner label.
Default: null

labelsInnerThousand
The thousand separator for the inner label.
Default: null

labelsInnerBorder
Whether the inner labels have a border or not.
Default: true

labelsInnerBorderColor
The color of the inner border.
Default: #ccc

labelsInnerBorderLinewidth
The linewidth of the inner labels border.
Default: 1

labelsInnerSpecific
This can be a string that's used as the label instead of the value.
Default: null

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

labelsInnerOffsety
This allows you finer-grained control in the vertical direction over the text positioning 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

PropertyDescriptionDefault
scaleUnitsPreThe units that the scale is measured in (these are prepended to the number).none
scaleUnitsPostThe units that the scale is measured in (these are appended to the number).none
scaleDecimalsThe number of decimal places to display for the scale. 0
scalePointThe character that's used as the decimal point..
scaleThousandThe character that's used as the thousand separator.,
scaleUnitsPre
The units that the scale is measured in (these are prepended to the number).
Default: none

scaleUnitsPost
The units that the scale is measured in (these are appended to the number).
Default: none

scaleDecimals
The number of decimal places to display for the scale.
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

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, albeit one element only. This is shown when the progress bar is clicked on. This 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
tooltipsNohideonclearNot an option that you'll need particularly often if at all. Setting this to true means that when you call the RGraph.clear api function the tooltips do not get hidden.false
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 tooltips use.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 about 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 progress bar will be adjustable (click the bar and drag it).false
tooltips
An array, albeit one element only. This is shown when the progress bar is clicked on. This 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

tooltipsNohideonclear
Not an option that you'll need particularly often if at all. Setting this to true means that when you call the RGraph.clear api function the tooltips do not get hidden.
Default: false

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 tooltips use.
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 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 progress bar will be adjustable (click the bar and drag it).
Default: false

Key properties

The key properties are documented on the key documentation page.

Miscellaneous properties

PropertyDescriptionDefault
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)
highlightLinewidthThis is the linewidth of the highlight stroke.1
borderInnerThis controls the inner border of the bar. If you're using a gradient you may wish to turn this off.true
beveledThis controls whether the bar has a beveled appearance.false
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
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)

highlightLinewidth
This is the linewidth of the highlight stroke.
Default: 1

borderInner
This controls the inner border of the bar. If you're using a gradient you may wish to turn this off.
Default: true

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 which segment has 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 segment or bar
y The Y coordinate of the segment or bar
width The width of the segment or bar
height The height of the segment or bar
dataset For a Horizontal Progress bar there's only ever one dataset so this is always zero.
index This is the zero-indexed index of the relevant segment. If your progress bar only has one segment then this will be zero.
sequentialIndex As there's only ever one dataset on a progress bar this is exactly the same as the index value.
tooltip If a tooltip is associated with this 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>
    hprogress.canvas.onclick = function (e)
    {
        RGraph.redraw();
    
        var canvas  = e.target,
            obj     = canvas.__object__,
            shape   = obj.getShape(e);

        if (shape) {
            var x      = shape.x,
                y      = shape.y,
                width  = shape.width,
                height = shape.height;
            
            obj.path(
                'b r % % % % s black f red',
                x, y, width, 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:

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

obj.getXCoord(value)

This method can be used to get an appropriate X coordinate for a value when you're doing custom drawing on the chart. It returns null if the value is out of range.


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
});

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.HProgress({
    id: 'cvs',
    min: 0,
    max: 100,
    value: 67,
    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)
    {
        // ...
    }

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