Share RGraph on Twitter Share RGraph on Google Plus Like RGraph on Facebook


Odometer charts documentation

 Please remember to link to the RGraph website and give your feedback here. Thanks! 

Important note! The options chart.green.solid, chart.yellow.solid and chart.red.solid have all been retired. By default the green/yellow/red colors are all solid. Gradients can still be applied but by using the new easy gradient syntax: obj.Set('chart.green.color', 'Gradient(white:green)');

Example

<script>
    window.onload = function ()
    {
        // Create the Odometer. The arguments are: the canvas ID, the minimum, the maximum and the value.
        var odo = new RGraph.Odometer('myOdo', 0, 100, 18);

        // Configure the Odometer to appear as you want.
        odo.Set('chart.green.max', 75);
        odo.Set('chart.red.min', 90);
        odo.Set('chart.label.area', 50);
        odo.Set('chart.needle.thickness', 2);

        // Now call the .Draw() method to draw the chart.
        odo.Draw();
    }
</script>

The example file is here.

Properties

You can use these properties to control how the Odometer apears. You can set these properties using the Set() method.

Chart configuration

chart.border
This controls the gray border of the Odometer.
Default: false

chart.tickmarks
This controls whether tickmarks are shown. If you're animating the Odometer you'll need to turn this off.
Default: true

chart.tickmarks.highlighted
This controls whether the tickmarks are highlighted in red/yellow/green.
Default: false

chart.zerostart
If you want the top value on your chart to be zero instead of the maximum value, set this to true.
Default: false

chart.centerx
If required, you can position the Meter chart using this instead of the gutters.
Default: null

chart.centery
If required, you can position the Meter chart using this instead of the gutters.
Default: null

chart.radius
If required, you can size the Meter chart using this instead of the gutters.
Default: null

Margins

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

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

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

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

Colors

chart.border.color1
This is the first color used in the gradient of the outer border of the chart (if enabled).
Default: #BEBCB0

chart.border.color2
This is the second/middle color used in the gradient of the outer border of the chart (if enabled).
Default: #F0EFEA

chart.border.color3
This is the third color used in the gradient of the outer border of the chart (if enabled).
Default: #BEBCB0

chart.green.max
This is the point at which the green area ends.
Default: 75% of the maximum value

chart.red.min
This is the point at which the red area starts. The yellow area is between the green and red areas.
Default: 90% of the maximum value

chart.green.color
This is the color of the green area.
Default: green

chart.yellow.color
This.the color of the yellow area.
Default: yellow

chart.red.color
This.the color of the red area.
Default: red

Labels and text

chart.value.text
Controls whether the value is indicated as a text label in the center of the dial.
Default: false

chart.value.units.pre
The pre units used on the textual value.
Default: An empty string

chart.value.units.post
The post units used on the textual value.
Default: An empty string

chart.labels
Instead of using computed numbers, which uses the maximum value, you can specify the Odometer to use textual labels instead, with this option.
Default: null

chart.label.area
The width of the area that labels are put in.
Default: 35

chart.text.size
The size of the text (in points).
Default: 10

chart.text.font
The font used to render the text.
Default: Arial

chart.text.color
The color of the labels.
Default: black

Needle

chart.needle.width
How thick the needle is.
Default: 2

chart.needle.color
The color that is applied to the needle.
Default: black

chart.needle.head
This controls whether the arrow head on the end of the needle is displayed.
Default: true

chart.needle.type
This determines which type of needle is used. It can be pointer or triangle.
Default: pointer

chart.needle.triangle.border
This controls the colour of the border for the pointer. If you don't want it you could set it to be transparent - rgba(0,0,0,0).
Default: #aaa

chart.needle.extra
With this you can specify a number of extra pointers that will be drawn on the Odometer. An example would be a meter that's used to show upload and download data. An example use:
odo.Set('chart.needle.extra', [[16, 'red'], [24, 'blue']]);

Default: An empty array

Titles

chart.title
The title text.
Default: null

chart.title.font
The font that the title is rendered in. If not specified the chart.text.font setting is used (usually Arial)
Default: null

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

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

chart.title.background
The background color (if any) for the title.
Default: null

chart.title.color
The color of the title.
Default: black

chart.title.x
To give the exact X coordinate for the title - use this
Default: null

chart.title.y
To give the exact Y coordinate for the title - use this
Default: null

Shadow

chart.shadow.inner
Whether a drop shadow is applied to the inner circle of the Odometer
Default: false

chart.shadow.inner.color
The color for the inner shadow.
Default: 3

chart.shadow.inner.offsetx
The X offset for the inner shadow.
Default: 3

chart.shadow.inner.offsety
The Y offset for the inner shadow.
Default: 3

chart.shadow.inner.blur
The extent of the blurring effect on the shadow.
Default: 6

chart.shadow.outer
Whether a drop shadow is applied to the whole Odometer.
Default: false

chart.shadow.outer.color
The color for the outer shadow.
Default: black

chart.shadow.outer.offsetx
The X offset for the outer shadow.
Default: 3

chart.shadow.outer.offsety
The Y offset for the outer shadow.
Default: 3

chart.shadow.outer.blur
The extent of the blurring effect on the shadow.
Default: 6

Interactive features

chart.contextmenu
An array of context menu items. More information on context menus is here.
Default: An empty array

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

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

chart.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

chart.resize.handle.background
With this you can specify the background color for the resize handle. If you're adjusting the position of the handle then you may need this to make the handle stand out more.
Default: null

chart.adjustable
You can make the Odometer interactively adjustable by setting this to true.
Default: false

Zoom

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

chart.zoom.fade.in
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

chart.zoom.fade.out
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

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

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

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

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

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

Scale

chart.units.pre
The units that the value is measured in. This string is displayed BEFORE the actual number, allowing you to specify values such as "$50" and is only used if chart.value.text is true.
Default: none

chart.units.post
The units that the value is measured in. This string is displayed AFTER the actual number, allowing you to specify values such as "50ms" and is only used if chart.value.text is true.
Default: none

chart.scale.decimals
The number of decimal places to display for the labels.
Default: 0

chart.scale.point
The character used as the decimal point.
Default: .

chart.scale.thousand
The character used as the thousand separator
Default: ,

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.getAngle(value)
This method will return you an appropriate angle for the given value.



© Copyright RGraph licensing 2008-2013 All rights reserved. Privacy policy, Terms and conditions