297 lines
14 KiB
HTML
297 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
|
<!--
|
|
/**
|
|
* o------------------------------------------------------------------------------o
|
|
* | This file is part of the OfficeExcel package - you can learn more at: |
|
|
* | |
|
|
* | http://www.OfficeExcel.net |
|
|
* | |
|
|
* | This package is licensed under the OfficeExcel license. For all kinds of business |
|
|
* | purposes there is a small one-time licensing fee to pay and for non |
|
|
* | commercial purposes it is free to use. You can read the full license here: |
|
|
* | |
|
|
* | http://www.OfficeExcel.net/LICENSE.txt |
|
|
* o------------------------------------------------------------------------------o
|
|
*/
|
|
-->
|
|
<title>Documentation about the Fuel Gauge</title>
|
|
|
|
<meta name="keywords" content="OfficeExcel html5 canvas docs fuel gauge" />
|
|
<meta name="description" content="Documentation about the Fuel Gauge including information on all the options available to you" />
|
|
<meta name="googlebot" content="NOODP">
|
|
|
|
<meta property="og:title" content="OfficeExcel: HTML5 Javascript charts library" />
|
|
<meta property="og:description" content="A charts library based on the HTML5 canvas tag" />
|
|
<meta property="og:image" content="http://www.OfficeExcel.net/images/logo.png"/>
|
|
|
|
<link rel="stylesheet" href="../css/website.css" type="text/css" media="screen" />
|
|
<link rel="icon" type="image/png" href="../images/favicon.png">
|
|
|
|
<!-- Place this tag in your head or just before your close body tag -->
|
|
<script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
|
|
|
|
|
|
<?php PrintAnalyticsCode() ?>
|
|
</head>
|
|
<body>
|
|
|
|
|
|
<!-- Social networking buttons -->
|
|
<?php
|
|
$prefix = substr($_SERVER['SERVER_NAME'], 0, 3);
|
|
require("/OfficeExcel.{$prefix}/social.html");
|
|
?>
|
|
<!-- Social networking buttons -->
|
|
|
|
<div id="breadcrumb">
|
|
<a href="../index.html">OfficeExcel: HTML5 Javascript charts library</a>
|
|
>
|
|
<a href="./index.html">Documentation</a>
|
|
>
|
|
Fuel Gauge
|
|
</div>
|
|
|
|
<h1>Fuel <span>Gauge documentation</span></h1>
|
|
|
|
<script>
|
|
if (OfficeExcel.isOld()) {
|
|
document.write('<div style="background-color: #fee; border: 2px dashed red; padding: 5px"><b>Important</b><br /><br /> Internet Explorer does not natively support the HTML5 canvas tag, so if you want to see the charts, you can either:<ul><li>Install <a href="http://code.google.com/chrome/chromeframe/">Google Chrome Frame</a></li><li>Use ExCanvas. This is provided in the OfficeExcel Archive.</li><li>Use another browser entirely. Your choices are Firefox 3.5+, Chrome 2+, Safari 4+ or Opera 10.5+. </li></ul> <b>Note:</b> Internet Explorer 9 fully supports the canvas tag.</div>');
|
|
}
|
|
</script>
|
|
|
|
<p>
|
|
The Fuel gauge is recent addition to OfficeExcel, and the available configuration options are shown here.
|
|
</p>
|
|
|
|
<ul>
|
|
<li><a href="#example">Example</a></li>
|
|
<li><a href="#properties">Properties</a></li>
|
|
</ul>
|
|
|
|
<a name="example"></a>
|
|
<p> </p>
|
|
<h2>Example</h2>
|
|
<pre class="code">
|
|
<script>
|
|
window.onload = function ()
|
|
{
|
|
<span class="javascript-comment">// Create the Fuel chart. The arguments are: the minimum, the maximum, and the value.</span>
|
|
fuel = new OfficeExcel.Fuel('cvs', 0, 100, 67);
|
|
|
|
<span class="javascript-comment">// Configure the Fuel chart to appear as wanted.</span>
|
|
fuel.Set('chart.needle.color', 'blue');
|
|
fuel.Set('chart.colors', ['#ddf']);
|
|
fuel.Set('chart.labels.empty', 'Empty!');
|
|
fuel.Set('chart.labels.full', 'Full');
|
|
fuel.Set('chart.icon', '/images/water.jpg');
|
|
|
|
<span class="javascript-comment">// Now call the .Draw() method to draw the chart.</span>
|
|
fuel.Draw();
|
|
}
|
|
</script>
|
|
</pre>
|
|
|
|
<p>
|
|
The example file is <a href="../examples/fuel.html">here</a>.
|
|
</p>
|
|
|
|
<a name="properties"></a>
|
|
<p> </p>
|
|
<h2>Properties</h2>
|
|
|
|
<p>
|
|
You can use these properties to control how the Fuel Gauge apears. You can set them by using the Set() method. Eg:
|
|
</p>
|
|
|
|
<p>
|
|
<b>myFuel.Set('name', 'value');</b>
|
|
</p>
|
|
|
|
<ul>
|
|
<li><a href="#colors">Colors</a></li>
|
|
<li><a href="#margins">Margins</a></li>
|
|
<li><a href="#needle">Needle options</a></li>
|
|
<li><a href="#labels">Labels and text</a></li>
|
|
<li><a href="#interactive">Interactive features</a></li>
|
|
<li><a href="#misc">Miscellaneous</a></li>
|
|
</ul>
|
|
|
|
<div>
|
|
<a name="colors"></a>
|
|
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Colors</h3>
|
|
|
|
<a name="chart.colors"></a>
|
|
<b>chart.colors</b><br />
|
|
The color of the Fuel Gauge. Noe that despite there being only one color, this is still an array.<br />
|
|
<i>Default: ['red']</i><br /><br />
|
|
|
|
<a name="margins"></a>
|
|
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Margins</h3>
|
|
|
|
<a name="chart.gutter.left"></a>
|
|
<b>chart.gutter.left</b><br />
|
|
The left gutter of the chart, (the gutter is where the labels and title are)).<br />
|
|
<i>Default: 5</i><br /><br />
|
|
|
|
<a name="chart.gutter.right"></a>
|
|
<b>chart.gutter.right</b><br />
|
|
The right gutter of the chart, (the gutter is where the labels and title are).<br />
|
|
<i>Default: 5</i><br /><br />
|
|
|
|
<a name="chart.gutter.top"></a>
|
|
<b>chart.gutter.top</b><br />
|
|
The top gutter of the chart, (the gutter is where the labels and title are).<br />
|
|
<i>Default: 5</i><br /><br />
|
|
|
|
<a name="chart.gutter.bottom"></a>
|
|
<b>chart.gutter.bottom</b><br />
|
|
The bottom gutter of the chart, (the gutter is where the labels and title are).<br />
|
|
<i>Default: 5</i><br /><br />
|
|
|
|
<a name="needle"></a>
|
|
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Needle options</h3>
|
|
|
|
<a name="chart.needle.color"></a>
|
|
<b>chart.needle.color</b><br />
|
|
The color of the needle (not including the bulb at the bottom). Note that this is NOT an array - it's just a string.<br />
|
|
<i>Default: 'red'</i><br /><br />
|
|
|
|
<a name="labels"></a>
|
|
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Labels and text</h3>
|
|
|
|
<a name="chart.labels.empty"></a>
|
|
<b>chart.labels.empty</b><br />
|
|
The label used as the empty text.<br />
|
|
<i>Default: E</i><br /><br />
|
|
|
|
<a name="chart.labels.full"></a>
|
|
<b>chart.labels.full</b><br />
|
|
The label used as the full text.<br />
|
|
<i>Default: F</i><br /><br />
|
|
|
|
<a name="chart.text.color"></a>
|
|
<b>chart.text.color</b><br />
|
|
The color used for the text on the chart.<br />
|
|
<i>Default: F</i><br /><br />
|
|
|
|
<a name="chart.text.font"></a>
|
|
<b>chart.text.font</b><br />
|
|
The font used for the text.<br />
|
|
<i>Default: Verdana</i><br /><br />
|
|
|
|
<a name="interactive"></a>
|
|
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Interactive features</h3>
|
|
|
|
<a name="chart.contextmenu"></a>
|
|
<b>chart.contextmenu</b><br />
|
|
The context menu. For more details see <a href="context.html">here</a>.<br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.annotatable"></a>
|
|
<b>chart.annotatable</b><br />
|
|
Whether annotations are enabled for the chart (ie you can draw on the chart interactively.<br />
|
|
<i>Default: false</i><br /><br />
|
|
|
|
<a name="chart.annotate.color"></a>
|
|
<b>chart.annotate.color</b><br />
|
|
If you do not allow the use of the palette, then this will be the only colour allowed for annotations.<br />
|
|
<i>Default: black</i><br /><br />
|
|
|
|
<a name="chart.resizable"></a>
|
|
<b>chart.resizable</b><br />
|
|
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).<br />
|
|
<i>Default: false</i><br /><br />
|
|
|
|
<a name="chart.resize.handle.background"></a>
|
|
<b>chart.resize.handle.background</b><br />
|
|
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.<br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<a name="zoom"></a>
|
|
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Zoom</h3>
|
|
|
|
<a name="chart.zoom.mode"></a>
|
|
<b>chart.zoom.mode</b><br />
|
|
Can be used to control whether the zoom is in thumbnail or canvas mode. Possible values are: <i>thumbnail</i> and <i>canvas</i>.<br />
|
|
<i>Default: canvas</i><br /><br />
|
|
|
|
<a name="chart.zoom.factor"></a>
|
|
<b>chart.zoom.factor</b><br />
|
|
This is the factor that the chart will be zoomed by (bigger values means more zoom)<br />
|
|
<i>Default: 1.5</i><br /><br />
|
|
|
|
<a name="chart.zoom.fade.in"></a>
|
|
<b>chart.zoom.fade.in</b><br />
|
|
Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br />
|
|
<i>Default: true</i><br /><br />
|
|
|
|
<a name="chart.zoom.fade.out"></a>
|
|
<b>chart.zoom.fade.out</b><br />
|
|
Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br />
|
|
<i>Default: true</i><br /><br />
|
|
|
|
<a name="chart.zoom.hdir"></a>
|
|
<b>chart.zoom.hdir</b><br />
|
|
The horizontal direction of the zoom. Possible values are: <i>left</i>, <i>center</i>, <i>right</i><br />
|
|
<i>Default: right</i><br /><br />
|
|
|
|
<a name="chart.zoom.vdir"></a>
|
|
<b>chart.zoom.vdir</b><br />
|
|
The vertical direction of the zoom. Possible values are: <i>up</i>, <i>center</i>, <i>down</i><br />
|
|
<i>Default: down</i><br /><br />
|
|
|
|
<a name="chart.zoom.delay"></a>
|
|
<b>chart.zoom.delay</b><br />
|
|
The delay (in milliseconds) between frames.<br />
|
|
<i>Default: 50</i><br /><br />
|
|
|
|
<a name="chart.zoom.frames"></a>
|
|
<b>chart.zoom.frames</b><br />
|
|
The number of frames in the zoom animation.<br />
|
|
<i>Default: 10</i><br /><br />
|
|
|
|
<a name="chart.zoom.shadow"></a>
|
|
<b>chart.zoom.shadow</b><br />
|
|
Whether or not the zoomed canvas has a shadow or not.<br />
|
|
<i>Default: true</i><br /><br />
|
|
|
|
<a name="chart.zoom.thumbnail.width"></a>
|
|
<b>chart.zoom.thumbnail.width</b><br />
|
|
When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br />
|
|
<i>Default: 75</i><br /><br />
|
|
|
|
<a name="chart.zoom.thumbnail.height"></a>
|
|
<b>chart.zoom.thumbnail.height</b><br />
|
|
When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br />
|
|
<i>Default: 75</i><br /><br />
|
|
|
|
<a name="chart.zoom.thumbnail.fixed"></a>
|
|
<b>chart.zoom.thumbnail.fixed</b><br />
|
|
When the zoom is in thumbnail mode, you can use this property to fix the zoom in the top left corner instead
|
|
of it following the cursor around.<br />
|
|
<i>Default: false</i><br /><br />
|
|
|
|
|
|
<a name="chart.zoom.background"></a>
|
|
<b>chart.zoom.background</b><br />
|
|
Defaulting to true, this determines whether the zoom has a dark, semi-opaque background that covers the entire web page.<br />
|
|
<i>Default: true</i><br /><br />
|
|
|
|
|
|
<a name="misc"></a>
|
|
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Miscellaneous</h3>
|
|
|
|
<a name="chart.icon"></a>
|
|
<b>chart.icon</b><br />
|
|
This should be a data: URL that represents the image to use as the icon on the chart. The
|
|
<a href="../examples/fuel.html">example page</a> has an example of a chart that uses this option to show a
|
|
water droplet instead of the fuel pump.<br />
|
|
<i>Default: [A fuel icon]</i><br /><br />
|
|
</div>
|
|
|
|
</body>
|
|
</html> |