Thermometer chart API reference

Documentation about the Thermometer chart including information about all of the options that are available to you. Thermometer charts can be used in a similar fashion to the Vertical Progress bar - they just have a different aesthetic.

Example

<script>
    new RGraph.Thermometer({
        id: 'cvs',
        min: 0,
        max: 100,
        value: 14,
        options: {
            marginLeft: 45,
            marginRight: 45,
            colors: ['rgba(255,0,0,1)']
        }
    }).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)).25
marginRightThe right margin of the chart, (the margin is where the labels and title are).25
marginTopThe top margin of the chart, (the margin is where the labels and title are).25
marginBottomThe bottom margin of the chart, (the margin is where the labels and title are).25
marginLeft
The left margin of the chart, (the margin is where the labels and title are)).
Default: 25

marginRight
The right margin of the chart, (the margin is where the labels and title are).
Default: 25

marginTop
The top margin of the chart, (the margin is where the labels and title are).
Default: 25

marginBottom
The bottom margin of the chart, (the margin is where the labels and title are).
Default: 25

Background properties

PropertyDescriptionDefault
backgroundColorThe default background color.white
backgroundColor
The default background color.
Default: white

Color properties

PropertyDescriptionDefault
colorsAn array of the colors of the bars.['Gradient(#c00:red:#f66:#fcc)']
colorsStrokeThe color of the border around the Thermometer.black
colors
An array of the colors of the bars.
Default: ['Gradient(#c00:red:#f66:#fcc)']

colorsStroke
The color of the border around the Thermometer.
Default: black

Title properties

PropertyDescriptionDefault
titleSideThis is the text that is used as the side title on the left hand side of the thermometer.An empty string
titleSideFontThe font that the side title is rendered in.null
titleSideSizeThe size of the side title.null
titleSideColorThe color of the side title.null
titleSideBoldWhether the title is bold or not.null
titleSideItalicWhether the title is italic or not.null
titleSide
This is the text that is used as the side title on the left hand side of the thermometer.
Default: An empty string

titleSideFont
The font that the side title is rendered in.
Default: null

titleSideSize
The size of the side title.
Default: null

titleSideColor
The color of the side title.
Default: null

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

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

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>
true
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
textBoldWhether text on the Thermometer chart is bold or not.false
textItalicWhether text on the Thermometer chart is italic or not.false
textFontThe font used to render text on the Thermometer chart.Arial, Verdana, sans-serif
textSizeThe size of text on the Thermometer chart.12
textColorThe color of text on the Thermometer chart.black
labelsValueThis controls whether the Thermometers value is shown in text.true
labelsValueDecimalsThis controls how many decimals are shown if the value is being shown. It falls back to use scaleDecimals if this is not specified.0
labelsValuePointThe decimal point character. It falls back to use scalePoint if this is not specified.null
labelsValueThousandThe character used as the thousand separator. It falls back to use scaleThousand if this is not specified.null
labelsValueUnitsPreUnits which are prepended to the value. It falls back to use scaleUnitsPre if this is not specified.null
labelsValueUnitsPostUnits which are appended to the value. It falls back to use scaleUnitsPost if this is not specified.null
labelsValueFontThe font used to render the label. This defaults to the textFont setting.null
labelsValueSizeThe size of the value label. This defaults to the textSize setting.null
labelsValueColorThe color of the value label. This defaults to the textColor setting.null
labelsValueBoldWhether the labelsValue label is bold or not. This falls back to the textBold setting.null
labelsValueItalicWhether the labelsValue label is italic or not. This falls back to the textItalic setting.null
labelsCountA value that controls how many scale labels there are. Keep in mind that if you use this it may result in decimals, and to see the full number you may need to use the scaleDecimals property.5
labelsFontThe font used by the vertical labels.null
labelsSizeThe size of the vertical labels.null
labelsColorThe color of the vertical labels.null
labelsBoldWhether the vertical labels are bold or not.null
labelsItalicWhether the vertical labels are italic or not.null
labelsDecimalsHow many decimals are displayed.null
labelsUnitsPreUnits which are prepended to the label.null
labelsUnitsPostUnits which are appended to the label.null
labelsPointThe point character used by the labels.null
labelsThousandThe thousand character used by the labels.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: true

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

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

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

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

textSize
The size of text on the Thermometer chart.
Default: 12

textColor
The color of text on the Thermometer chart.
Default: black

labelsValue
This controls whether the Thermometers value is shown in text.
Default: true

labelsValueDecimals
This controls how many decimals are shown if the value is being shown. It falls back to use scaleDecimals if this is not specified.
Default: 0

labelsValuePoint
The decimal point character. It falls back to use scalePoint if this is not specified.
Default: null

labelsValueThousand
The character used as the thousand separator. It falls back to use scaleThousand if this is not specified.
Default: null

labelsValueUnitsPre
Units which are prepended to the value. It falls back to use scaleUnitsPre if this is not specified.
Default: null

labelsValueUnitsPost
Units which are appended to the value. It falls back to use scaleUnitsPost if this is not specified.
Default: null

labelsValueFont
The font used to render the label. This defaults to the textFont setting.
Default: null

labelsValueSize
The size of the value label. This defaults to the textSize setting.
Default: null

labelsValueColor
The color of the value label. This defaults to the textColor setting.
Default: null

labelsValueBold
Whether the labelsValue label is bold or not. This falls back to the textBold setting.
Default: null

labelsValueItalic
Whether the labelsValue label is italic or not. This falls back to the textItalic setting.
Default: null

labelsCount
A value that controls how many scale labels there are. Keep in mind that if you use this it may result in decimals, and to see the full number you may need to use the scaleDecimals property.
Default: 5

labelsFont
The font used by the vertical labels.
Default: null

labelsSize
The size of the vertical labels.
Default: null

labelsColor
The color of the vertical labels.
Default: null

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

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

labelsDecimals
How many decimals are displayed.
Default: null

labelsUnitsPre
Units which are prepended to the label.
Default: null

labelsUnitsPost
Units which are appended to the label.
Default: null

labelsPoint
The point character used by the labels.
Default: null

labelsThousand
The thousand character used by the labels.
Default: null

Shadow properties

PropertyDescriptionDefault
shadowWhether a drop shadow is applied.true
shadowColorThe color of the shadow.gray
shadowOffsetxThe X offset of the shadow.0
shadowOffsetyThe Y offset of the shadow.0
shadowBlurThe severity of the shadow blurring effect.15
shadow
Whether a drop shadow is applied.
Default: true

shadowColor
The color of the shadow.
Default: gray

shadowOffsetx
The X offset of the shadow.
Default: 0

shadowOffsety
The Y offset of the shadow.
Default: 0

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

Scale properties

PropertyDescriptionDefault
scaleVisibleDefaulting to false, this controls whether the scale is visible.false
scaleDecimalsThis allows you to control the amount of decimals that the labels have.0
scalePointThe character used as the decimal point..
scaleThousandThe character used as the thousand separator.,
scaleUnitsPreThe units that the Y axis is measured in. This string is displayed before the number, allowing you to specify values such as "$50".none
scaleUnitsPostThe units that the Y axis is measured in. This string is displayed after the number, allowing you to specify values such as "50ms".none
scaleVisible
Defaulting to false, this controls whether the scale is visible.
Default: false

scaleDecimals
This allows you to control the amount of decimals that the labels have.
Default: 0

scalePoint
The character used as the decimal point.
Default: .

scaleThousand
The character used as the thousand separator.
Default: ,

scaleUnitsPre
The units that the Y axis is measured in. This string is displayed before the number, allowing you to specify values such as "$50".
Default: none

scaleUnitsPost
The units that the Y axis is measured in. This string is displayed after the number, allowing you to specify values such as "50ms".
Default: none

Interactive features properties

PropertyDescriptionDefault
adjustableDefaulting to false, this determines whether your bar chart will be adjustable.false
tooltipsA numerically indexed array of tooltips that are shown when a bar is clicked. These can contain HTML.null
tooltipsHighlightSet this to false if you don't want your charts to be highlighted.true
tooltipsEffectThe effect used for showing tooltips. Can be either fade or none.fade
tooltipsEventThis is the event that triggers the tooltips. It can be either click or mousemove.onclick
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 tooltips do not get hidden.false
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
adjustable
Defaulting to false, this determines whether your bar chart will be adjustable.
Default: false

tooltips
A numerically indexed array of tooltips that are shown when a bar is clicked. These can contain HTML.
Default: null

tooltipsHighlight
Set this to false if you don't want your charts to be highlighted.
Default: true

tooltipsEffect
The effect used for showing tooltips. Can be either fade or none.
Default: fade

tooltipsEvent
This is the event that triggers the tooltips. It can be either click or mousemove.
Default: onclick

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 tooltips do not get hidden.
Default: false

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

Event properties

PropertyDescriptionDefault
eventsClickIf you want to add your own click function you can do so by assigning it to this property. See here for details.null
eventsMousemoveIf you want to add your own mousemove function you can do so by assigning it to this property. See here for details.null
eventsMouseoverIf you want to add your own mouseover function you can do so by assigning it to this property. See here for details.null
eventsMouseoutIf you want to add your own mouseout function you can do so by assigning it to this property. See here for details.null
eventsClick
If you want to add your own click function you can do so by assigning it to this property. See here for details.
Default: null

eventsMousemove
If you want to add your own mousemove function you can do so by assigning it to this property. See here for details.
Default: null

eventsMouseover
If you want to add your own mouseover function you can do so by assigning it to this property. See here for details.
Default: null

eventsMouseout
If you want to add your own mouseout function you can do so by assigning it to this property. See here for details.
Default: null

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
cleartoThis is used in animations and effects as the default color to use when clearing the canvas.null
bulbBottomRadiusAdjustIf you want to add or remove a little (or a lot) from the bottom bulb radius you use this (use negative numbers to subtract).0
bulbBottomRadiusUse this property to set the bottom bulb radius.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

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

bulbBottomRadiusAdjust
If you want to add or remove a little (or a lot) from the bottom bulb radius you use this (use negative numbers to subtract).
Default: 0

bulbBottomRadius
Use this property to set the bottom bulb radius.
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 returns details on the focused bar (there's only one). It returns an array consisting of:

The shape also includes textual indexes like this: shape['object'] And they are:

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:

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

This method can be used to get an appropriate Y 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 in a similar way 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 event code here
});

The function is useful if you use method chaining when creating your charts:

var obj = new RGraph.Thermometer('cvs', 0,100,56)
    .on('draw', function (e, shape)
    {
        // Put ondraw code here
    }).on('click', function (e, shape)
    {
        // Handle click event
    }).draw();
The exec option and method

The exec function is documented here.

Animation effects

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

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