Thermometer charts

  Read comments...

 

Example

<script>
    var thermometer = new RGraph.Thermometer({
        id: 'cvs',
        min: 0,
        max: 100,
        value: 14,
        options: {
            gutterLeft: 45,
            gutterRight: 45,
            colors: ['rgba(255,0,0,1)']
        }
    }).draw();
</script>

The example file is here.

 

Properties

You can use these properties to control how the chart apears. You can set them by including them in the options section of the configuration as above.

 

Margins

gutterLeft
The left gutter of the chart, (the gutter is where the labels and title are)).
Default: 25

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

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

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

 

Background

backgroundColor
The default background color
Default: white

 

Colors

colors
An array of the colors of the bars.
Default: ['Gradient(#c00:red:#f66:#fcc)']

strokestyle
The color of the border around the thermometer
Default: black

 

Titles

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 title is rendered in. If not specified the text.font setting is used (usually Arial)
Default: null

titleSideSize
The size of the title. If not specified the size is usually 2pt bigger than the text.size setting.
Default: null

titleSideBold
Whather the title is bold or not.
Default: true

 

Labels and text

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 gutters 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

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

valueLabelDecimals
This controls how many decimals are shown if the value is being shown. It falls back to use scale.decimals if this is not specified.
Default: null

labelsCount
A value that controls how many Y 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 scale.decimals.
Default: 5

 

Shadow

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

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: ,

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

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

 

Interactive features

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 onclick or onmousemove.
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 tooltip DO NOT get hidden.
Default: false

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

resizable
Defaulting to false, this determines whether your chart will be resizable. Because of the numerous event handlers this has to install code on, This feature is unlikely to work with other dynamic features (the context menu is fine however).
Default: false

resizableMaxwidth
This allows you to set a maximum width that the chart can be resized to.
Default: null

resizableMaxheight
This allows you to set a maximum height that the chart can be resized to.
Default: null

annotatable
Whether annotations are enabled for the chart (ie you can draw on the chart interactively.
Default: false

annotateColor
If you do not allow the use of the palette, then this will be the only colour allowed for annotations.
Default: black

annotateLinewidth
This is the line width of the annotations.
Default: 1

 

Zoom

zoomFactor
This is the factor that the chart will be zoomed by (bigger values means more zoom)
Default: 1.5

zoomFadeIn
Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.
Default: true

zoomFadeOut
Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.
Default: true

zoomHdir
The horizontal direction of the zoom. Possible values are: left, center, right
Default: right

zoomVdir
The vertical direction of the zoom. Possible values are: up, center, down
Default: down

zoomDelay
The delay (in milliseconds) between frames.
Default: 50

zoomFrames
The number of frames in the zoom animation.
Default: 10

zoomShadow
Whether or not the zoomed canvas has a shadow or not.
Default: true

 

Events

eventsClick
If you want to add your own onclick 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 onmousemove 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 onmouseover 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 onmouseout function you can do so by assigning it to this property. See here for details.
Default: null

 

Miscellaneous

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. Its 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 value of properties.

 

obj.set(name, value)
An accessor that you can use to set the value 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 gutter 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, func)

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 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 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)
    {
        // ...
    }

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

Comments