878 lines
43 KiB
HTML
878 lines
43 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>Documentaion about the OfficeExcel Bar chart</title>
|
|
|
|
<meta name="keywords" content="OfficeExcel html5 canvas docs bar charts" />
|
|
<meta name="description" content="Documentation about the Bar chart 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>
|
|
>
|
|
Bar charts
|
|
</div>
|
|
|
|
<h1>Bar <span>charts 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>
|
|
|
|
<ul>
|
|
<li><a href="#example">Example</a></li>
|
|
<li><a href="#properties">Properties</a></li>
|
|
<li><a href="#methods">Methods</a></li>
|
|
</ul>
|
|
|
|
<a name="example"></a>
|
|
<p> </p>
|
|
<h2>Example</h2>
|
|
<pre class="code">
|
|
<script>
|
|
window.onload = function ()
|
|
{
|
|
<span class="javascript-comment">
|
|
// Some data that is to be shown on the bar chart. To show a stacked or grouped chart
|
|
// each number should be an array of further numbers instead.</span>
|
|
var data = [280,45,133];
|
|
|
|
<span class="javascript-comment">
|
|
// An example of the data used by stacked and grouped charts
|
|
// var data = [[1,5,6], [4,5,3], [7,8,9]]</span>
|
|
|
|
<span class="javascript-comment">
|
|
// Create the br chart. The arguments are the ID of the canvas tag and the data</span>
|
|
var bar = new OfficeExcel.Bar('myCanvas', data);
|
|
|
|
<span class="javascript-comment">
|
|
// Now configure the chart to appear as wanted by using the .Set() method.
|
|
// All available properties are listed below.</span>
|
|
bar.Set('chart.labels', ['Richard', 'Alex', 'Nick']);
|
|
bar.Set('chart.gutter.left', 45);
|
|
bar.Set('chart.background.barcolor1', 'white');
|
|
bar.Set('chart.background.barcolor2', 'white');
|
|
bar.Set('chart.background.grid', true);
|
|
bar.Set('chart.colors', ['red']);
|
|
|
|
<span class="javascript-comment">
|
|
// Now call the .Draw() method to draw the chart</span>
|
|
bar.Draw();
|
|
}
|
|
</script>
|
|
</pre>
|
|
|
|
<p>
|
|
The example file is <a href="../examples/bar.html">here</a>.
|
|
</p>
|
|
|
|
<a name="properties"></a>
|
|
<p> </p>
|
|
<h2>Properties</h2>
|
|
|
|
<p>
|
|
You can use these properties to control how the bar chart apears. You can set them by using the Set() method. Eg:
|
|
</p>
|
|
|
|
<p>
|
|
<b>myBar.Set('name', 'value');</b>
|
|
</p>
|
|
|
|
<ul>
|
|
<li><a href="#background">Background</a></li>
|
|
<li><a href="#axes">Axes properties</a></li>
|
|
<li><a href="#colors">Colors</a></li>
|
|
<li><a href="#margins">Margins</a></li>
|
|
<li><a href="#labels and text">Labels and text</a></li>
|
|
<li><a href="#titles">Titles</a></li>
|
|
<li><a href="#shadow">Shadow</a></li>
|
|
<li><a href="#scale">Scale</a></li>
|
|
<li><a href="#key">Key</a></li>
|
|
<li><a href="#interactive features">Interactive features</a></li>
|
|
<li><a href="#zoom">Zoom</a></li>
|
|
<li><a href="#events">Events</a></li>
|
|
<li><a href="#miscellaneous">Miscellaneous</a></li>
|
|
</ul>
|
|
|
|
|
|
<a name="background"></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">Background</h3> <a name="chart.background.barcolor1"></a>
|
|
<b>chart.background.barcolor1</b><br />
|
|
The color of the background bars, (1 of 2). <br /><i>Default: white</i><br /><br />
|
|
<a name="chart.background.barcolor2"></a>
|
|
<b>chart.background.barcolor2</b><br />
|
|
The color of the background bars, (2 of 2). <br /><i>Default: white</i><br /><br />
|
|
<a name="chart.background.grid"></a>
|
|
<b>chart.background.grid</b><br />
|
|
Whether to show the background grid or not. <br /><i>Default: true</i><br /><br />
|
|
<a name="chart.background.grid.color"></a>
|
|
<b>chart.background.grid.color</b><br />
|
|
The color of the background grid. <br /><i>Default: #ddd</i><br /><br />
|
|
<a name="chart.background.grid.hsize"></a>
|
|
<b>chart.background.grid.hsize</b><br />
|
|
The horizontal background grid size. <br /><i>Default: 40</i><br /><br />
|
|
<a name="chart.background.grid.vsize"></a>
|
|
<b>chart.background.grid.vsize</b><br />
|
|
The vertical background grid size. <br /><i>Default: 18</i><br /><br />
|
|
<a name="chart.background.grid.width"></a>
|
|
<b>chart.background.grid.width</b><br />
|
|
The width that the background grid lines are. Decimals (eg 0.5) are permitted.<br /><i>Default: 1</i><br /><br />
|
|
<a name="chart.background.grid.border"></a>
|
|
<b>chart.background.grid.border</b><br />
|
|
Determines whether a border line is drawn around the grid.<br /><i>Default: true</i><br /><br />
|
|
<a name="chart.background.grid.hlines"></a>
|
|
<b>chart.background.grid.hlines</b><br />
|
|
Determines whether to draw the horizontal grid lines.<br /><i>Default: true</i><br /><br />
|
|
<a name="chart.background.grid.vlines"></a>
|
|
<b>chart.background.grid.vlines</b><br />
|
|
Determines whether to draw the vertical grid lines.<br /><i>Default: true</i><br /><br />
|
|
|
|
<a name="chart.background.grid.autofit"></a>
|
|
<b>chart.background.grid.autofit</b><br />
|
|
Instead of specifying a pixel width/height for the background grid, you can use autofit and specify how many horizontal and vertical lines you want.<br />
|
|
<i>Default: true</i><br /><br />
|
|
|
|
<a name="chart.background.grid.autofit.numhlines"></a>
|
|
<b>chart.background.grid.autofit.numhlines</b><br />
|
|
When using autofit this allows you to specify how many horizontal grid lines you want. <br />
|
|
<i>Default: 5</i><br /><br />
|
|
|
|
<a name="chart.background.grid.autofit.numvlines"></a>
|
|
<b>chart.background.grid.autofit.numvlines</b><br />
|
|
When using autofit this allows you to specify how many vertical grid lines you want. <br />
|
|
<i>Default: 20</i><br /><br />
|
|
|
|
<a name="chart.background.grid.autofit.align"></a>
|
|
<b>chart.background.grid.autofit.align</b><br />
|
|
If you want to have your grid lines line up with the labels (both X and Y axes), you can set this to true and OfficeExcel will
|
|
attempt to make the grid lines line up. If you have a <i>chart.hmargin</i> set then the alignment will be thrown out.<br />
|
|
<i>Default: false</i><br /><br />
|
|
|
|
<a name="chart.background.hbars"></a>
|
|
<b>chart.background.hbars</b><br />
|
|
An array of information stipulating horizontal coloured bars. You can use these to indicate limits. Eg: <i>myBar.Set('hbars', [[75, 10, 'yellow'], [85, 15, 'red']]);</i> This would give you two bars, one red and a lower yellow bar. The units correspond to your scale, and are the starting point and the height.<br /><i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.background.image"></a>
|
|
<b>chart.background.image</b><br />
|
|
If you want to specify a background image to use on your chart, specify it with this property.<br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.background.image.stretch"></a>
|
|
<b>chart.background.image.stretch</b><br />
|
|
By default your background image is stretched (if necessary) to cover the whole chart area (gutters not included).
|
|
If this is not what you want then set this property to false.<br />
|
|
<i>Default: true</i><br /><br />
|
|
|
|
<a name="chart.background.image.x"></a>
|
|
<b>chart.background.image.x</b><br />
|
|
The X position of the image. The coordinates are the top left corner of the image.<br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.background.image.y"></a>
|
|
<b>chart.background.image.y</b><br />
|
|
The Y position of the image. The coordinates are the top left corner of the image.<br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.background.image.align"></a>
|
|
<b>chart.background.image.align</b><br />
|
|
Instead of specifying the coordinates of the image, you can instead simply align it top, bottom, left or right.
|
|
Examples are:<br />
|
|
<ul>
|
|
<li>top left</li>
|
|
<li>bottom right</li>
|
|
<li>bottom</li>
|
|
<li>right</li>
|
|
</ul>
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<a name="axes"></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">Axes properties</h3>
|
|
|
|
<a name="chart.noaxes"></a>
|
|
<b>chart.noaxes</b><br />
|
|
Whether the axes are drawn<br />
|
|
<i>Default: false (the axes ARE drawn)</i><br /><br />
|
|
|
|
<a name="chart.noxaxis"></a>
|
|
<b>chart.noxaxis</b><br />
|
|
Whether the X axis is drawn<br />
|
|
<i>Default: false (the X axis IS drawn)</i><br /><br />
|
|
|
|
<a name="chart.noyaxis"></a>
|
|
<b>chart.noyaxis</b><br />
|
|
Whether the Y axis is drawn<br />
|
|
<i>Default: false (the Y axis IS drawn)</i><br /><br />
|
|
|
|
<a name="chart.noendxtick"></a>
|
|
<b>chart.noendxtick</b><br />
|
|
When you're combining the Bar and Line charts, you may want to use this property to stop the end X tick from
|
|
being drawn.<br />
|
|
<i>Default: false (the end tick IS drawn)</i><br /><br />
|
|
|
|
<a name="chart.numxticks"></a>
|
|
<b>chart.numxticks</b><br />
|
|
This controls the number of X tickmarks on the X axis.<br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<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.strokestyle"></a>
|
|
<b>chart.strokestyle</b><br />
|
|
The color of the outline of the bars. <br />
|
|
<i>Default: #666</i><br /><br />
|
|
|
|
<a name="chart.colors"></a>
|
|
<b>chart.colors</b><br />
|
|
An array of the colors of the actual bars. <br />
|
|
<i>Default: An array - ['rgb(0,0,255)', '#0f0', '#00f', '#ff0', '#0ff', '#0f0']</i><br /><br />
|
|
|
|
<a name="chart.colors.sequential"></a>
|
|
<b>chart.colors.sequential</b><br />
|
|
If true, for regular bar charts, (not stacked or grouped), the colors that you specify will be used in a sequential
|
|
fashion.<br />
|
|
<i>Default: false</i><br /><br />
|
|
|
|
<a name="chart.colors.reverse"></a>
|
|
<b>chart.colors.reverse</b><br />
|
|
If true, for stacked bar charts only, the colors that you specify will be used in a reverse order to what they are
|
|
normally.<br />
|
|
<i>Default: false</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.hmargin"></a>
|
|
<b>chart.hmargin</b><br />
|
|
The horizontal margin (in pixels) of the chart. The horizontal margin is on the inside of the axes.<br />
|
|
<i>Default: 5</i><br /><br />
|
|
|
|
<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: 25</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: 25</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: 25</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: 25</i><br /><br />
|
|
|
|
<a name="labels and text"></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.text.color"></a>
|
|
<b>chart.text.color</b><br />
|
|
The color of the labels. <br /><i>Default: black</i><br /><br />
|
|
<a name="chart.text.size"></a>
|
|
<b>chart.text.size</b><br />
|
|
The size (in points) of the labels. <br /><i>Default: 10</i><br /><br />
|
|
<a name="chart.text.angle"></a>
|
|
<b>chart.text.angle</b><br />
|
|
The angle of the horizontal text labels (at the bottom of the chart). This can be one of three values - 0, 45 or 90.<br /><i>Default: 0 (Horizontal)</i><br /><br />
|
|
<a name="chart.text.font"></a>
|
|
<b>chart.text.font</b><br />
|
|
The font used to render the text.<br /><i>Default: Verdana</i><br /><br />
|
|
<a name="chart.labels"></a>
|
|
<b>chart.labels</b><br />
|
|
An array of the labels to be used on the chart. <br /><i>Default: An empty array</i><br /><br />
|
|
|
|
<a name="chart.labels.above"></a>
|
|
<b>chart.labels.above</b><br />
|
|
If true, values will be shown above the bars. For regular and stacked bar charts units are included, whereas for
|
|
grouped bar charts they're not (usually there isn't enough space for them).
|
|
<br /><i>Default: false</i><br /><br />
|
|
|
|
<a name="chart.labels.above.decimals"></a>
|
|
<b>chart.labels.above.decimals</b><br />
|
|
This stipulates how many decimals are used in the above bar labels.
|
|
<br /><i>Default: 0</i><br /><br />
|
|
|
|
<a name="chart.labels.above.size"></a>
|
|
<b>chart.labels.above.size</b><br />
|
|
The font size of the above bar labels. Useful if you only have a few bars.
|
|
<br /><i>Default: false</i><br /><br />
|
|
|
|
<a name="chart.labels.above.angle"></a>
|
|
<b>chart.labels.above.angle</b><br />
|
|
You can use this to angle the text shown above the bars. It can be anything from -90 to 90 (degrees).
|
|
<br /><i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.labels.ingraph"></a>
|
|
<b>chart.labels.ingraph</b><br />
|
|
An array of labels for the chart which are drawn "inside" the chart. If you have 5 data points then this should have a corresponding number of elements, though there is a <a href="misc.html#shorthand.ingraph.labels">shorthand available</a>.<br /><i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.ylabels"></a>
|
|
<b>chart.ylabels</b><br />
|
|
Can be <i>true</i> or <i>false</i> and determines whether the chart has Y axis labels.<br />
|
|
<i>Default: true</i><br /><br />
|
|
|
|
<a name="chart.ylabels.count"></a>
|
|
<b>chart.ylabels.count</b><br />
|
|
A value that controls how many Y labels there are. Previously (prior to 8th August 2010) this could be 1,3,5.
|
|
Now it can be any number, but keep in mind that if you use this it may result in decimals.<br />
|
|
<i>Default: 5</i><br /><br />
|
|
|
|
<a name="chart.ylabels.specific"></a>
|
|
<b>chart.ylabels.specific</b><br />
|
|
You can use this option to give your own Y labels (eg ['Low', 'Medium', 'High'].<br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.xlabels.offset"></a>
|
|
<b>chart.xlabels.offset</b><br />
|
|
This allows you finer grained control over the X label positioning if you need it.<br /><i>Default: 0</i><br /><br />
|
|
<a name="chart.numyticks"></a>
|
|
<b>chart.numyticks</b><br />
|
|
The number of Y tickmarks. If you have changed the number of Y labels, you may also want to change this to match. <br /><i>Default: 10</i><br /><br />
|
|
<a name="titles"></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">Titles</h3>
|
|
|
|
<a name="chart.title"></a>
|
|
<b>chart.title</b><br />
|
|
The title of the chart, if any. <br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.title.font"></a>
|
|
<b>chart.title.font</b><br />
|
|
The font that the title is rendered in. If not specified the chart.text.font setting is used (usually Verdana)<br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.title.size"></a>
|
|
<b>chart.title.size</b><br />
|
|
The size of the title. If not specified the size is usually 2pt bigger than the chart.text.size setting.<br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.title.bold"></a>
|
|
<b>chart.title.bold</b><br />
|
|
Whather the title is bold or not.<br />
|
|
<i>Default: true</i><br /><br />
|
|
|
|
<a name="chart.title.background"></a>
|
|
<b>chart.title.background</b><br />
|
|
The background color (if any) for the title.<br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.title.color"></a>
|
|
<b>chart.title.color</b><br />
|
|
The color of the title.<br /> <i>Default: black</i><br /><br />
|
|
|
|
<a name="chart.title.hpos"></a>
|
|
<b>chart.title.hpos</b><br />
|
|
This allows you to completely override the horizontal positioning of the title. It should be a number between 0 and 1, and is multiplied with the whole width of the canvas and then used as the horizontal position.<br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
|
|
<a name="chart.title.vpos"></a>
|
|
<b>chart.title.vpos</b><br />
|
|
This allows you to completely override the vertical positioning of the title. It should be a number between 0 and 1, and is multiplied with the gutter and then used as the vertical position. It can be useful if you need to have a large gutter.<br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.title.xaxis"></a>
|
|
<b>chart.title.xaxis</b><br />
|
|
This allows to specify a title for the X axis.<br /><i>Default: none</i><br /><br />
|
|
<a name="chart.title.yaxis"></a>
|
|
|
|
<a name="chart.title.xaxis.size"></a>
|
|
<b>chart.title.xaxis.size</b><br />
|
|
This allows you to specify a size for the X axis title.<br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.title.xaxis.font"></a>
|
|
<b>chart.title.xaxis.font</b><br />
|
|
This allows to specify a font for the X axis title.<br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.title.xaxis.bold"></a>
|
|
<b>chart.title.xaxis.bold</b><br />
|
|
This controls whether the X axis title is bold or not.<br />
|
|
<i>Default: true</i><br /><br />
|
|
|
|
<a name="chart.title.yaxis"></a>
|
|
<b>chart.title.yaxis</b><br />
|
|
This allows to specify a title for the Y axis.<br />
|
|
<i>Default: none</i><br /><br />
|
|
|
|
<a name="chart.title.yaxis.size"></a>
|
|
<b>chart.title.yaxis.size</b><br />
|
|
This allows you to specify a size for the Y axis title.<br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.title.yaxis.font"></a>
|
|
<b>chart.title.yaxis.font</b><br />
|
|
This allows to specify a font for the Y axis title.<br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.title.yaxis.bold"></a>
|
|
<b>chart.title.yaxis.bold</b><br />
|
|
This controls whether the Y axis title is bold or not.<br />
|
|
<i>Default: true</i><br /><br />
|
|
|
|
<a name="chart.title.xaxis.pos"></a>
|
|
<b>chart.title.xaxis.pos</b><br />
|
|
This is multiplied with the gutter to give the position of the X axis title.<br /><i>Default: 0.25</i><br /><br />
|
|
<a name="chart.title.yaxis.pos"></a>
|
|
<b>chart.title.yaxis.pos</b><br />
|
|
This is multiplied with the gutter to give the position of the Y axis title.<br /><i>Default: 0.25</i><br /><br />
|
|
|
|
<!--
|
|
<a name="chart.title.yaxis.position"></a>
|
|
<b>chart.title.yaxis.align</b><br />
|
|
Instead of using the option above you can instead use this option, specifying <i>left</i> or <i>right</i>.<br />
|
|
<i>Default: left</i><br /><br />
|
|
-->
|
|
|
|
<a name="shadow"></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">Shadow</h3> <a name="chart.shadow"></a>
|
|
<b>chart.shadow</b><br />
|
|
Whether a drop shadow is applied. <br /><i>Default: false</i><br /><br />
|
|
<a name="chart.shadow.color"></a>
|
|
<b>chart.shadow.color</b><br />
|
|
The color of the shadow. <br /><i>Default: #666</i><br /><br />
|
|
<a name="chart.shadow.offsetx"></a>
|
|
<b>chart.shadow.offsetx</b><br />
|
|
The X offset of the shadow. <br /><i>Default: 3</i><br /><br />
|
|
<a name="chart.shadow.offsety"></a>
|
|
<b>chart.shadow.offsety</b><br />
|
|
The Y offset of the shadow. <br /><i>Default: 3</i><br /><br />
|
|
<a name="chart.shadow.blur"></a>
|
|
<b>chart.shadow.blur</b><br />
|
|
The severity of the shadow blurring effect. <br /><i>Default: 3</i><br /><br />
|
|
|
|
<a name="scale"></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">Scale</h3>
|
|
|
|
<a name="chart.scale.formatter"></a>
|
|
<b>chart.scale.formatter</b><br />
|
|
To allow thoroughly custom formats of numbers in the scale, you can use this option to
|
|
specify a function that is used by OfficeExcel to format numbers. This function should
|
|
handle ALL of the formatting. Eg:<br /><br />
|
|
<pre class="code">
|
|
function myFormatter(obj, num)
|
|
{
|
|
return num + 'F'; // An example of formatting
|
|
}
|
|
myGraph.Set('chart.scale.formatter', myFormatter);
|
|
</pre>
|
|
<br /><i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.scale.decimals"></a>
|
|
<b>chart.scale.decimals</b><br />
|
|
The number of decimal places to display for the Y scale.
|
|
<br /><i>Default: 0</i><br /><br />
|
|
|
|
<a name="chart.scale.point"></a>
|
|
<b>chart.scale.point</b><br />
|
|
The character used as the decimal point.<br />
|
|
<i>Default: .</i><br /><br />
|
|
|
|
<a name="chart.scale.thousand"></a>
|
|
<b>chart.scale.thousand</b><br />
|
|
The character used as the thousand separator<br />
|
|
<i>Default: ,</i><br /><br />
|
|
|
|
<a name="chart.units.pre"></a>
|
|
<b>chart.units.pre</b><br />
|
|
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".<br /><i>Default: none</i><br /><br />
|
|
|
|
<a name="chart.units.post"></a>
|
|
<b>chart.units.post</b><br />
|
|
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".<br /><i>Default: none</i><br /><br />
|
|
|
|
<a name="chart.ymax"></a>
|
|
<b>chart.ymax</b><br />
|
|
The optional maximum Y scale value. If not specified then it will be calculated.<br /><i>Default: null (It's calculated)</i><br /><br />
|
|
|
|
<a name="chart.ymin"></a>
|
|
<b>chart.ymin</b><br />
|
|
The optional minimum Y scale value. If not specified then it will be 0.<br /><i>Default: 0</i><br /><br />
|
|
|
|
|
|
<a name="key"></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">Key</h3>
|
|
|
|
<a name="chart.key"></a>
|
|
<b>chart.key</b><br />
|
|
An array of key information. <br />
|
|
<i>Default: [] (An empty array)</i><br /><br />
|
|
|
|
<a name="chart.key.background"></a>
|
|
<b>chart.key.background</b><br />
|
|
The color of the key background. Typically white, you could set this to something like rgba(255,255,255,0.7) to allow people to see things behind it.<br>
|
|
<i>Default: white</i><br /><br />
|
|
|
|
<a name="chart.key.halign"></a>
|
|
<b>chart.key.halign</b><br />
|
|
Instead of specifying the exact x/y coordinates, you can use this property to simply specify whether the key hould be
|
|
aligned <i>left</i> or <i>right</i>.<br />
|
|
<i>Default: right</i><br /><br />
|
|
|
|
<a name="chart.key.position"></a>
|
|
<b>chart.key.position</b><br />
|
|
Determines the position of the key.Either <b>graph</b> (default), or <b>gutter</b>.<br />
|
|
<i>Default: graph</i><br /><br />
|
|
|
|
<b>chart.key.position.x</b><br />
|
|
This allows you to specify a specific X coordinate for the key.<br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<b>chart.key.position.y</b><br />
|
|
This allows you to specify a specific Y coordinate for the key.<br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<b>chart.key.position.gutter.boxed</b><br />
|
|
If you have the key in gutter mode (ie horizontal), this allows you to give a background color.<br />
|
|
<i>Default: true</i><br /><br />
|
|
|
|
<a name="chart.key.shadow"></a>
|
|
<b>chart.key.shadow</b><br />
|
|
Whether a small drop shadow is applied to the key.<br />
|
|
<i>Default: false</i><br /><br />
|
|
|
|
<a name="chart.key.shadow.color"></a>
|
|
<b>chart.key.shadow.color</b><br />
|
|
The color of the shadow.<br />
|
|
<i>Default: #666</i><br /><br />
|
|
|
|
<a name="chart.key.shadow.blur"></a>
|
|
<b>chart.key.shadow.blur</b><br />
|
|
The extent of the blurring effect used on the shadow.<br />
|
|
<i>Default: 3</i><br /><br />
|
|
|
|
<a name="chart.key.shadow.offsetx"></a>
|
|
<b>chart.key.shadow.offsetx</b><br />
|
|
The X offset of the shadow.<br />
|
|
<i>Default: 2</i><br /><br />
|
|
|
|
<a name="chart.key.shadow.offsety"></a>
|
|
<b>chart.key.shadow.offsety</b><br />
|
|
The Y offset of the shadow.<br />
|
|
<i>Default: 2</i><br /><br />
|
|
|
|
<b>chart.key.rounded</b><br />
|
|
This controls whether the corners of the key (in graph mode) are curved. If the key is gutter mode, this has no effect.<br />
|
|
<i>Default: false</i><br /><br />
|
|
|
|
<b>chart.key.color.shape</b><br />
|
|
This can be <i>square</i>, <i>circle</i> or <i>line</i> and controls how the color indicators in the key appear.<br />
|
|
<i>Default: square</i><br /><br />
|
|
|
|
<b>chart.key.linewidth</b><br />
|
|
The line width of the surrounding border on the key.<br />
|
|
<i>Default: 1</i><br /><br />
|
|
|
|
|
|
|
|
<a name="interactive features"></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 />
|
|
An array of context menu items. More information on context menus is <a href="context.html">here</a>.<br />
|
|
<i>Default: [] (An empty array)</i><br /><br />
|
|
|
|
<a name="chart.tooltips"></a>
|
|
<b>chart.tooltips</b><br />
|
|
A numerically indexed array of tooltips that are shown when a bar is clicked. These can contain HTML.<br /><i>Default: null</i><br /><br />
|
|
<a name="chart.tooltips.effect"></a>
|
|
<b>chart.tooltips.effect</b><br />
|
|
The animated effect used for showing tooltips. Can be either <i>fade</i> or <i>expand</i>.<br /><i>Default: fade</i><br /><br />
|
|
|
|
<a name="chart.tooltips.event"></a>
|
|
<b>chart.tooltips.event</b><br />
|
|
This is the event that triggers the tooltips. It can be either <i>onclick</i> or <i>onmousemove</i>.<br />
|
|
<i>Default: onclick</i><br /><br />
|
|
|
|
<a name="chart.tooltips.css.class"></a>
|
|
<b>chart.tooltips.css.class</b><br />
|
|
This is the name of the CSS class the chart uses.<br /><i>Default: OfficeExcel_tooltip</i><br /><br />
|
|
|
|
<a name="chart.tooltips.override"></a>
|
|
<b>chart.tooltips.override</b><br />
|
|
If you wish to handle showing tooltips yourself, this should be a function object which does just that.
|
|
There's more information on the <a href="tooltips.html">tooltips documentation page</a><br />
|
|
<i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.tooltips.highlight"></a>
|
|
<b>chart.tooltips.highlight</b><br />
|
|
When combining chartss you will need to set this option to fase.<br />
|
|
<i>Default: true</i><br /><br />
|
|
|
|
|
|
<a name="chart.crosshairs"></a>
|
|
<b>chart.crosshairs</b><br />
|
|
If true, you will get a crosshair centering on the current mouse position.<br /><i>Default: false</i><br /><br />
|
|
<a name="chart.crosshairs.linewidth"></a>
|
|
<b>chart.crosshairs.linewidth</b><br />
|
|
This controls the linewidth of the crosshairs.<br /><i>Default: 1</i><br /><br />
|
|
<a name="chart.crosshairs.color"></a>
|
|
<b>chart.crosshairs.color</b><br />
|
|
The color of the crosshairs.<br /><i>Default: #333</i><br /><br />
|
|
|
|
<a name="chart.crosshairs.hlines"></a>
|
|
<b>chart.crosshairs.hlines</b><br />
|
|
This determines whether the horizontal crosshair is shown.<br />
|
|
<i>Default: true</i><br /><br />
|
|
|
|
<a name="chart.crosshairs.vlines"></a>
|
|
<b>chart.crosshairs.vlines</b><br />
|
|
This determines whether the vertical crosshair is shown.<br />
|
|
<i>Default: true</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="chart.adjustable"></a>
|
|
<b>chart.adjustable</b><br />
|
|
Defaulting to false, this determines whether your bar chart will be adjustable. <br /><i>Default: false</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="events"></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">Events</h3>
|
|
|
|
<a name="chart.events.click"></a>
|
|
<b>chart.events.click</b><br />
|
|
If you want to add your own <i>onclick</i> function you can do so by assigning it to this property. See
|
|
<a href="pseudo-standard-events.html">here</a> for details.
|
|
<br /><i>Default: null</i><br /><br />
|
|
|
|
<a name="chart.events.mousemove"></a>
|
|
<b>chart.events.mousemove</b><br />
|
|
If you want to add your own <i>onmousemove</i> function you can do so by assigning it to this property. See
|
|
<a href="pseudo-standard-events.html">here</a> for details.
|
|
<br /><i>Default: null</i><br /><br />
|
|
|
|
|
|
<a name="miscellaneous"></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.highlight.stroke"></a>
|
|
<b>chart.highlight.stroke</b><br />
|
|
If you use tooltips, this controls the colour of the highlight stroke.
|
|
<br /><i>Default: black</i><br /><br />
|
|
|
|
<a name="chart.highlight.fill"></a>
|
|
<b>chart.highlight.fill</b><br />
|
|
If you use tooltips, this controls the colour of the highlight fill.
|
|
<br /><i>Default: rgba(255,255,255,0.5)</i><br /><br />
|
|
|
|
<a name="chart.line"></a>
|
|
<b>chart.line</b><br />
|
|
Formerly a boolean, this now stipulates a line chart object which is to be drawn on top of the bar chart. You can see an example <a href="combine.html">here</a>.<br /><i>Default: null</i><br /><br />
|
|
<a name="chart.variant"></a>
|
|
<b>chart.variant</b><br />
|
|
This simply stipulates whether you want a regular bar chart, a dot chart, a pyramid chart a 3D chart, a sketch or a glassy chart. Possible values are:<ul><li>bar</li><li>dot</li><li>pyramid</li><li>arrow</li><li>3d</li><li>sketch</li><li>glass</li></ul>The pyramid, dot, arrow, sketch and glass variants are only effective for regular bar charts - not grouped or stacked charts.<br /><i>Default: bar</i><br /><br />
|
|
|
|
<a name="chart.xaxispos"></a>
|
|
<b>chart.xaxispos</b><br />
|
|
The position of the X axis. This can be <i>bottom</i>, <i>center</i> or <i>top</i>. <br />
|
|
<i>Default: bottom</i><br /><br />
|
|
|
|
<a name="chart.axis.color"></a>
|
|
<b>chart.axis.color</b><br />
|
|
The color of the axes.<br /><i>Default: black</i><br /><br />
|
|
<a name="chart.grouping"></a>
|
|
<b>chart.grouping</b><br />
|
|
How the bars are grouped, and it should be one of: <b>grouped</b> or <b>stacked</b><br /><i>Default: grouped</i><br /><br />
|
|
</div>
|
|
|
|
<a name="methods"></a>
|
|
<p> </p>
|
|
<h2>Methods</h2>
|
|
|
|
<a name="getbar"></a>
|
|
<b>obj.getBar(event)</b><br /><br />
|
|
This method makes it easier to get hold of which bar has been clicked on, or hovered over. It returns an array of:
|
|
<ul>
|
|
<li>The chart object</li>
|
|
<li>The X coordinate</li>
|
|
<li>The Y coordinate</li>
|
|
<li>The width of the bar</li>
|
|
<li>The height of the bar</li>
|
|
<li>The numerical index of the bar. This corresponds (for example) to the tooltips array, and the coordinates array</li>
|
|
</ul>
|
|
|
|
An example usage is:
|
|
|
|
<pre class="code">
|
|
<canvas id="cvs" width="600" height="250">[No canvas support]</canvas>
|
|
|
|
<script src="OfficeExcel.common.core.js"></script>
|
|
<script src="OfficeExcel.bar.js"></script>
|
|
|
|
<script>
|
|
myGraph = new OfficeExcel.Bar('myCanvas', [1.2, 1.3, 1.4, 1.5,6,1.9,2,2.1,2.5]);
|
|
myGraph.Set('chart.labels', ['John', 'Barry', 'Rich', 'Craig', 'Tom', 'Frank', 'Helen', 'Joyce', 'Fred'])
|
|
myGraph.Draw();
|
|
|
|
OfficeExcel.Register(myGraph);
|
|
|
|
myGraph.canvas.onclick = function (e)
|
|
{
|
|
OfficeExcel.Redraw();
|
|
|
|
var canvas = e.target;
|
|
var context = canvas.getContext('2d');
|
|
var obj = canvas.__object__;
|
|
<span style="color: green">var coords = obj.getBar(e);</span>
|
|
|
|
if (coords) {
|
|
var top = coords[1];
|
|
var left = coords[2];
|
|
var width = coords[3];
|
|
var height = coords[4];
|
|
|
|
context.beginPath();
|
|
context.strokeStyle = 'black';
|
|
context.fillStyle = 'rgba(255,255,255,0.5)';
|
|
context.strokeRect(top, left, width, height);
|
|
context.fillRect(top, left, width, height);
|
|
context.stroke();
|
|
context.fill();
|
|
}
|
|
}
|
|
</script>
|
|
</pre>
|
|
|
|
<a name="getShape"></a>
|
|
<b>obj.getShape(event)</b>
|
|
<p>
|
|
This method is an alternate name for the above method but has a generic name that is the same acoss the various libraries.
|
|
</p>
|
|
|
|
<a name="getValue"></a>
|
|
<b>obj.getValue(mixed)</b>
|
|
<p>
|
|
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:
|
|
</p>
|
|
|
|
<pre class="code">
|
|
myChart.canvas.onclick = function (e)
|
|
{
|
|
var obj = e.target.__object__;
|
|
var value = obj.getValue(e);
|
|
|
|
// ...
|
|
}
|
|
</pre>
|
|
|
|
|
|
</body>
|
|
</html> |