jqwidgets-framework
Version:
jQWidgets is an advanced Angular, Vue, Blazor, React, Web Components, jquery, ASP .NET MVC, Custom Elements and HTML5 UI framework.
2,989 lines • 155 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<link rel="stylesheet" href="../../../../Styles/jqx.apireference.css" type="text/css" />
<script type="text/javascript" src="../../../../scripts/jquery-1.11.1.min.js"></script>
<script type="text/javascript" src="../../../../scripts/documentation.js"></script>
<script type="text/javascript" src="../../../../jqwidgets/jqxcore.js"></script>
<meta name="keywords" content="jQuery, Chart, Chart plugin, Data Visualization, Help Documentation, jQuery Chart, JavaScript Chart, jQuery Mobile Chart, JavaScript Mobile Chart, Charting" />
<meta name="description" content="This page represents the help documentation of the jqxChart widget." />
<title>jqxChart API Reference</title>
<script type="text/javascript">
$(document).ready(function ()
{
$(".documentation-option-type-click").click(function (event)
{
var match = $(event.target).parents('tr').next().find(".property-content");
if (match && match.data('expanded'))
{
match.hide();
match.data('expanded', false);
}
else
{
match.show();
match.data('expanded', true);
}
//$(event.target).parents('tr').next().find(".property-content").hide();
});
});
</script>
</head>
<body>
<div id="properties">
<h2>Properties</h2>
<table class="documentation-table" style="padding-bottom: 20px;">
<tr>
<th>Name
</th>
<th>Type
</th>
<th>Default
</th>
</tr>
<!-- animationDuration -->
<tr>
<td class="documentation-option-type-click">
<span>animationDuration</span>
</td>
<td>
<span>Number</span>
</td>
<td>1000
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Determines the animations duration in milliseconds. The value must be between 0 and 5000.
If it is outside of this range jqxChart will reset it to the default value of 1000.
</p>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/CXrxS/">animationDuration is set to 1000</a>
</div>
</div>
</td>
</tr>
<!-- end of animationDuration -->
<tr>
<td class="documentation-option-type-click">
<span id='Span2'>borderLineColor</span>
</td>
<td>
<span>String</span>
</td>
<td>#888888
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Sets the chart's border color.
</p>
Example:
<pre>
<code>
// select the chart element and change the default border color.
$('#jqxChart').jqxChart({borderLineColor: 'Blue'});
// refresh the chart element
$('#jqxChart').jqxChart('refresh');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/DDKEZ/">borderLineColor is set to 'blue'</a>
</div>
</div>
</td>
</tr>
<tr>
<td class="documentation-option-type-click">
<span id='Span3'>borderLineWidth</span>
</td>
<td>
<span>Number</span>
</td>
<td>1
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Sets the chart's border line width
</p>
Example:
<pre>
<code>
$('#jqxChart').jqxChart({borderLineWidth: 1});
// refresh the chart element
$('#jqxChart').jqxChart('refresh');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/8kVXG/">borderLineWidth is set to 2</a>
</div>
</div>
</td>
</tr>
<tr>
<td class="documentation-option-type-click">
<span id='Span4'>backgroundColor</span>
</td>
<td>
<span>String</span>
</td>
<td>White
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Sets the chart's background color.
</p>
Example:
<pre>
<code>
// select the chart element and change the default background color.
$('#jqxChart').jqxChart({backgroundColor: 'Gray'});
// refresh the chart element
$('#jqxChart').jqxChart('refresh');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/7wQzp/">backgroundColor is set to 'silver'</a>
</div>
</div>
</td>
</tr>
<tr>
<td class="documentation-option-type-click">
<span id='Span5'>backgroundImage</span>
</td>
<td>
<span>String</span>
</td>
<td>''
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Sets the chart's background image.
</p>
Example:
<pre>
<code>
// select the chart element and set background image.
$('#jqxChart').jqxChart({backgroundImage: '../images/chart_background.jpg'});
// refresh the chart element
$('#jqxChart').jqxChart('refresh');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/ebHwC/">backgroundImage is set to a custom string</a>
</div>
</div>
</td>
</tr>
<tr>
<td class="documentation-option-type-click">
<span id='Span19'>colorScheme</span>
</td>
<td>
<span>String</span>
</td>
<td>'scheme01'
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Sets the chart's color pallete. jqxChart suppports 11 color schemes from 'scheme01'
to 'scheme11'.
</p>
Example:
<pre>
<code>
$('#jqxChart').jqxChart({colorScheme: 'scheme06'});
$('#jqxChart').jqxChart('refresh');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/zZUTA/">colorScheme is set to 'scheme11'</a>
</div>
</div>
</td>
</tr>
<!-- crosshairsDashStyle -->
<tr>
<td class="documentation-option-type-click">
<span id='Span11'>crosshairsDashStyle</span>
</td>
<td>
<span>String</span>
</td>
<td>'2,2'
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Gets or sets the dash style of the crosshairs lines. The style is a series of numbers indicating line length followed by space length.
</p>
Example:
<pre>
<code>
$('#jqxChart').jqxChart('crosshairsDashStyle', '1,1'});
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/q2XsW/">crosshairsDashStyle is set to '2,2'</a>
</div>
</div>
</td>
</tr>
<!-- crosshairsLineWidth -->
<tr>
<td class="documentation-option-type-click">
<span id='Span32'>crosshairsLineWidth</span>
</td>
<td>
<span>Number</span>
</td>
<td>1.0
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Gets or sets the width of the crosshairs lines.
</p>
Example:
<pre>
<code>
$('#jqxChart').jqxChart('crosshairsLineWidth', 2.0});
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/UYPV8/">crosshairsLineWidth is set to 1.5</a>
</div>
</div>
</td>
</tr>
<!-- columnSeriesOverlap -->
<tr>
<td class="documentation-option-type-click">
<span id='Span36'>columnSeriesOverlap</span>
</td>
<td>
<span>Boolean</span>
</td>
<td>false
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Enables or disables overlapping of the column series.
</p>
Example:
<pre>
<code>
$('#jqxChart').jqxChart('columnSeriesOverlap', true});
</code>
</pre>
</div>
</td>
</tr>
<!-- crosshairsColor -->
<tr>
<td class="documentation-option-type-click">
<span id='Span10'>crosshairsColor</span>
</td>
<td>
<span>String</span>
</td>
<td>#888888
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Gets or sets the color of the crosshairs lines.
</p>
Example:
<pre>
<code>
$('#jqxChart').jqxChart('crosshairsColor', '#AA55AA'});
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/anVxx/">crosshairsColor is set to '#888888'</a>
</div>
</div>
</td>
</tr>
<!-- draw -->
<tr>
<td class="documentation-option-type-click">
<span>draw</span>
</td>
<td>
<span>Function</span>
</td>
<td>null
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Determines the drawing function of jqxChart.
When the property is set, you can override the jqxChart's drawing.
</p>
Example:
<pre><code>
var chartSettings = {
title: "Map of the European Union",
description: "",
padding: { left: 10, top: 5, right: 10, bottom: 5 },
titlePadding: { left: 90, top: 0, right: 0, bottom: 10 },
source: dataAdapter
};
// custom drawing function after
chartSettings.draw = function (renderer, rect) {
var records = this.source.records;
var wScale = rect.width / 13000
var hScale = (rect.height) / 8500;
for (var i = 0; i < records.length; i++) {
var path = transformPath(records[i].path, wScale, hScale, 62, 22);
var pathElement = renderer.path(path, { stroke: 'black' });
if (records[i].eu == "true") {
renderer.attr(pathElement, { fill: 'blue' });
}
else
renderer.attr(pathElement, { fill: '#DEDEDE' });
}
}
</code></pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/LcFMV/">draw is set to custom function</a>
</div>
</div>
</td>
</tr>
<!-- end of draw -->
<!-- drawBefore -->
<tr>
<td class="documentation-option-type-click">
<span>drawBefore</span>
</td>
<td>
<span>Function</span>
</td>
<td>null
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
function for custom drawing before the title and other chart elements
</p>
Example:
<pre><code>
var chartSettings = {
title: "Map of the European Union",
description: "",
padding: { left: 10, top: 5, right: 10, bottom: 5 },
titlePadding: { left: 90, top: 0, right: 0, bottom: 10 },
source: dataAdapter
};
// function draw before the title and other chart elements
chartSettings.drawBefore = function (renderer, rect) {
renderer.rect(rect.x, rect.y, rect.width, rect.height, { fill: 'lightblue' });
}
</code></pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/LcFMV/">drawBefore is set to custom function</a>
</div>
</div>
</td>
</tr>
<!-- end of drawBefore -->
<tr>
<td class="documentation-option-type-click">
<span id='Span15'>description</span>
</td>
<td>
<span>String</span>
</td>
<td>''
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Sets the description text of the chart.
</p>
Example:
<pre>
<code>
// select the chart element and change the description to 'New description'
$('#jqxChart').jqxChart({description: 'New description'});
// refresh the chart element
$('#jqxChart').jqxChart('refresh');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/mDY2E/">description is set to "Statistics for 2011"</a>
</div>
</div>
</td>
</tr>
<!-- enableCrosshairs -->
<tr>
<td class="documentation-option-type-click">
<span id='Span9'>enableCrosshairs</span>
</td>
<td>
<span>Boolean</span>
</td>
<td>false
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Enables or disables the crosshairs lines. The lines are displayed in line and area series when you move over a data point.
</p>
Example:
<pre>
<code>
$('#jqxChart').jqxChart(enableCrosshairs', false);
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/rQ7MS/">enableCrosshairs is set to true</a>
</div>
</div>
</td>
</tr>
<!-- enabled -->
<tr>
<td class="documentation-option-type-click">
<span id='Span22'>enabled</span>
</td>
<td>
<span>Boolean</span>
</td>
<td>true
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Gets or sets whether the chart widget in enabled or disabled state.
</p>
Example:
<pre>
<code>
$('#jqxChart').jqxChart({enabled: false});
$('#jqxChart').jqxChart('refresh');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/V8ZUc/">enabled is set to false</a>
</div>
</div>
</td>
</tr>
<!-- enableAnimations -->
<tr>
<td class="documentation-option-type-click">
<span>enableAnimations</span>
</td>
<td>
<span>Boolean</span>
</td>
<td>true
</td>
</tr>
<tr>
<td colspan='3' style="width: 100%">
<div class="documentation-option-description property-content" style="display: none;">
<p>
Determines if the animations are enabled. When you set this property it will turn on or off the animations
for all series in all seriesGroups in the chart. You can override this property for individual seriesGroups and series.
</p>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/bf8gK/">enableAnimations is set to true</a>
</div>
</div>
</td>
</tr>
<!-- end of enableAnimations -->
<!-- enableAxisTextAnimation -->
<tr>
<td class="documentation-option-type-click">
<span>enableAxisTextAnimation</span>
</td>
<td>
<span>Boolean</span>
</td>
<td>false
</td>
</tr>
<tr>
<td colspan='3' style="width: 100%">
<div class="documentation-option-description property-content" style="display: none;">
<p>
Determines if the animation of the axes text is enabled.
</p>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/28Ktb/">enableAxisTextAnimation is set to true</a>
</div>
</div>
</td>
</tr>
<!-- end of enableAxisTextAnimation -->
<!-- greyScale -->
<tr>
<td class="documentation-option-type-click">
<span>greyScale</span>
</td>
<td>
<span>Boolean</span>
</td>
<td>false
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Determines whether to display the chart using grey scale colors.
</p>
Example:
<pre><code>
$('#jqxChart').jqxChart({greyScale: true});
</code></pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/adKKr/">greyScale is set to true</a>
</div>
</div>
</td>
</tr>
<!-- end of greyScale -->
<!-- legendLayout -->
<tr>
<td class="documentation-option-type-click">
<span id='Span34'>legendLayout</span>
</td>
<td>
<span>Object</span>
</td>
<td>null
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>Sets the legend's layout. The expected object is with the following fields:</p>
<ul>
<li>left - legend's X position.</li>
<li>top - legend's Y position.</li>
<li>width - legend's width.</li>
<li>height - legend's height.</li>
<li>flow - 'horizontal' or 'vertical'.</li>
</ul>
Example:
<h4>Code example</h4>
<pre><code>$('#jqxChart').jqxChart({legendLayout : { left: 500, top: 140, width: 300, height: 200, flow: 'vertical' }}); </code></pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/VAgKr/">legendLayout is set to { left: 535,top: 140,width: 200, height: 200, flow: 'vertical' }</a>
</div>
</div>
</td>
</tr>
<!-- localization -->
<tr>
<td class="documentation-option-type-click">
<span>localization</span>
</td>
<td>
<span>object</span>
</td>
<td>undefined
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
localization object containing culture specific properties required for formatting currencies, numbers and dates
</p>
Example:
<pre><code>
$('#chartContainer').jqxChart({localization: getLocalization('de')});
</code></pre>
</td>
</tr>
<!-- end of localization -->
<tr>
<td class="documentation-option-type-click">
<span id='Span17'>padding</span>
</td>
<td>
<span>Padding</span>
</td>
<td>{ left: 5, top: 5, right: 5, bottom: 5 }
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Sets the left,top, right & bottom padding of the Chart.
</p>
Example:
<pre>
<code>
$('#jqxChart').jqxChart({padding: { left: 10, top: 10, right: 10, bottom: 10 }});
$('#jqxChart').jqxChart('refresh');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/bRHBK/">padding is set to {left: 20,top: 5, right: 20, bottom: 5 }</a>
</div>
</div>
</td>
</tr>
<!-- rtl -->
<tr>
<td class="documentation-option-type-click">
<span id='Span33'>rtl</span>
</td>
<td>
<span>Boolean</span>
</td>
<td>false
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>Sets or gets a value indicating whether the Chart's layout is mirrored.</p>
Example:
<h4>Code example</h4>
<p>
Set the <code>rtl</code> property.
</p>
<pre><code>$('#jqxChart').jqxChart({rtl : true}); </code></pre>
<p>
Get the <code>rtl</code> property.
</p>
<pre><code>var rtl = $('#jqxChart').jqxChart('rtl'); </code></pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/K9T9s/">rtl is set to true</a>
</div>
</div>
</td>
</tr>
<!-- renderEngine -->
<tr>
<td class="documentation-option-type-click">
<span>renderEngine</span>
</td>
<td>
<span>String</span>
</td>
<td>''
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Determines the rendering engine used to display the chart. Possible values are 'SVG', 'VML' and 'HTML5'.
When the property is not set jqxChart will automatically select an optimal rendering engine depending on the browser capabilities.
</p>
Example:
<pre><code>
$('#jqxChart').jqxChart({renderEngine: 'HTML5'});
$('#jqxChart').jqxChart('refresh');
</code></pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/LJ3vR/">renderEngine is set to 'HTML5'</a>
</div>
</div>
</td>
</tr>
<!-- end of renderEngine -->
<!-- seriesGroups -->
<tr>
<td class="documentation-option-type-click">
<span id='Span12'>seriesGroups</span>
</td>
<td>
<span>Object</span>
</td>
<td>null
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
The seriesGroups property is used to describe all series displayed on the chart. jqxChart supports multiple
series of different types and series grouping. Each series group may have its own Value Axis (Y-axis) which
allows you to have values with different scales displayed on the same chart at the same time. It also allows
you to display multiple series types together on the same chart. For example, you can display all series in
one group as lines and the series in a second group as columns.
</p>
<pre><code>
seriesGroups:
[
{
type: 'stackedarea100',
orientation: 'vertical',
series: [
{ dataField: 'SearchNonPaid', displayText: 'Non-Paid Search Traffic' },
{ dataField: 'SearchPaid', displayText: 'Paid Search Traffic' },
{ dataField: 'Referral', displayText: 'Referral Traffic' }
],
bands:
[
{ minValue: 2000, maxValue: 2500, color: '#FF0000', opacity: 0.15},
{ minValue: 1000, maxValue: 1100, color: '#FF0000', opacity: 0.20}
]
}
]
</code></pre>
<br />
The seriesGroups is an array of objects where each object represents one group. A group may have the following properties:
<br />
<ul>
<li>type - sets the chart type. jqxChart supports several common chart types. You can
easily plot series of different types on a common chart. A type must be specified
for each series group. Currently jqxChart supports the following series types:
<ul>
<li>column - simple column series</li>
<li>stackedcolumn - stacked column series</li>
<li>stackedcolumn100 - percentage stacked columns</li>
<li>rangecolumn - floating column between two values</li>
<li>waterfall - waterfall series</li>
<li>stackedwaterfall - stacked waterfall series</li>
<li>line - simple streight lines connecting the value points</li>
<li>stackedline - stacked lines</li>
<li>stackedline100 - percentage stacked lines</li>
<li>spline - smooth lines connecting the value points</li>
<li>stackedspline - smooth stacked lines</li>
<li>stackedspline100 - percentage stacked smooth lines</li>
<li>stepline - step line</li>
<li>stackedstepline - stacked step line</li>
<li>stackedstepline100 - percentage stacked step line</li>
<li>area - area connecting the value points with streight lines</li>
<li>stackedarea- stacked area with streight lines between the points</li>
<li>rangearea - floating area between pairs of value points</li>
<li>stackedline100 - percentage stacked area</li>
<li>splinearea - smooth area connecting the value points</li>
<li>splinerangearea - smooth floating area between pairs of value points</li>
<li>stackedsplineara - smooth stacked area</li>
<li>stackedsplinearea100 - percentage stacked smooth area</li>
<li>steplinearea - step area connecting the value points</li>
<li>stackedsteplineara - step stacked area</li>
<li>stackedsteplinearea100 - percentage stacked step area</li>
<li>pie - circular chart divided into sectors, illustrating proportion</li>
<li>donut - chart divided into circular sectors with different inner and outer radius</li>
<li>scatter - data is displayed as a collection of points</li>
<li>stackedscatter - data is displayed as a collection of points and the values are stacked</li>
<li>stackedscatter100 - data is displayed as a collection of points and the values are percentage stacked</li>
<li>bubble - data is displayed as a collection of bubbles</li>
<li>stackedbubble - data is displayed as a collection of bubbles and the values are stacked</li>
<li>stackedbubble100 - data is displayed as a collection of bubbles and the values are percentage stacked</li>
<li>candlestick - display candlestick series using open, high, low, close data points</li>
<li>ohlc - display OHLC series using open, high, low, close data points</li>
</ul>
</li>
<li>orientation - specifies the orientation of the series group.
<ul>
<li>vertical - the valueAxis is displayed vertically and the xAxis horizontally.</li>
<li>horizontal - the valueAxis is displayed horizontally and the xAxis vertically</li>
</ul>
</li>
<li>valueAxis - object describing the valueAxis for this group. jqxChart allows you to use a common valueAxis and/or multiple value axes per serie group.</li>
<li>columnsGapPercent - percentage gap between columns within the same serie. The default value is 25.</li>
<li>seriesGapPercent - percentage gap between columns belonging to different series. The default value is 10.</li>
<li>columnsMaxWidth - maximum width of columns in column series.</li>
<li>columnsMinWidth - minimum width of columns in column series.</li>
<li>columnsTopWidthPercent - columns top width (as percentage of the total width). The default value is 100.</li>
<li>columnsBottomWidthPercent - columns bottom width (as percentage of the total width). The default value is 100.</li>
<li>skipOverlappingPoints - determines whether to display overlapping data points in column, ohlc and candlestick series. The default value is true.</li>
<li>polar - a boolean value. When polar is set to 'true' the chart will render in polar coordinates.</li>
<li>spider - a boolean value. When spider is set to 'true' the chart will render in polar coordinates.</li>
<li>radius - the radius of the polar coordinate system. Applicable to polar and spider charts only.</li>
<li>startAngle - the start angle (in degrees) of the polar coordinate system. Applicable to polar and spider charts only.</li>
<li>endAngle - the end angle (in degrees) of the polar coordinate system. Applicable to polar and spider charts only.</li>
<li>offsetX - horizontal position of the center of the polar coordinate system. Applicable to polar and spider charts only.</li>
<li>offsetY - vertical position of the center of the polar coordinate system. Applicable to polar and spider charts only.</li>
<li>series - an array of chart series.<p>Each serie has the following properties:</p>
<ul>
<li>dataField - name of the field in the data source.</li>
<li>displayText - name to display for this serie.</li>
<li>dataFieldOpen, dataFieldHigh, dataFieldLow, dataFieldClose - names of the fields in the data source
used in candlestcik and ohlc series
</li>
<li>displayTextOpen, displayTextHigh, displayTextLow, displayTextClose - names to display for candlestick and ohlc series.</li>
<li>colorScheme - color palette to use when rendering the serie.</li>
<li>color - (Deprecated) fill color for the serie.</li>
<li>lineColor - Line color for the serie.</li>
<li>lineColorSelected - Line color for the serie when selected.</li>
<li>fillColor - Fill color for the serie.</li>
<li>fillColorSelected - Fill color for the serie when selected.</li>
<li>fillColorAlt - Alternating fill color for the serie. Applicable to OHLC series only.</li>
<li>fillColorAltSelected - Alternating fill color for the serie when selected. Applicable to OHLC series only.</li>
<li>lineColorSymbol - Line color for the marker symbols in serie.</li>
<li>lineColorSymbolSelected - Line color for the marker symbols in the serie when selected.</li>
<li>fillColorSymbol - Fill color for the marker symbols in the serie.</li>
<li>fillColorSymbolSelected - Fill color for the the marker symbols in serie when selected.</li>
<li>colorFunction - a custom function that returns the color of a data point.<br />
The function will received the following parameters: dataValue, itemIndex, serie, group<br />
The implementation of the function can return a single color which will be used as a fillColor and<br />
the other colors will be derived or it can return an object containing fillColor, fillColorSelected, etc.
</li>
<li>greyScale - boolean that determines whether to display the serie in grey scale.</li>
<li>legendFormatSettings - legend data formatting settings for the values in the serie.</li>
<li>legendFormatFunction - legend data formatting function for the values in the serie.</li>
<li>legendFillColor - fill color of the legend box. The default value is inherited by the serie's color.</li>
<li>legendLineColor - line color of the legend box. The default value is inherited by the serie's color.</li>
<li>toolTipFormatSettings - tooltip data formatting settings for the values in the serie.</li>
<li>toolTipFormatFunction - tooltip data formatting function for the values in the serie.</li>
<li>toolTipLineColor - determines the tooltip's border lines color.</li>
<li>toolTipBackground - determines the tooltip's background.</li>
<li>toolTipClass - determines the tooltip's CSS class name.</li>
<li>useGradient - determines whether to use color gradients.</li>
<li>opacity - determines the opacity of the items in this serie.</li>
<li>lineWidth - determines the line tickness of the items in this serie.</li>
<li>lineDashStyle - a string sequence of numbers represening line and space lengths, e.g. '2,2' </li>
<li>emptyPointsDisplay - determines how to display value gaps in line series.
Possible values are: 'connect', 'skip' and 'zero'<br />
</li>
<li>linesUnselectMode - determines how line and area series are unselected based on mouse and touch events. Possible values are 'click' or 'default'.
If the value is set to 'click', once a line or area serie is selected, it will remain selected until the user clicks or moves the cursor outside the chart.
In default mode, the serie will be unselected immediatelly after the cursor moves over another serie or outside the chart.
</li>
<li>symbolType - determines the symbol type displayed for the data points in the serie. This parameter is applicable to line, area, scatter and bubble series only. Acceptable values are: 'none', 'circle', 'square', 'diamond', 'triangle_up', 'triangle_down', 'triangle_left', 'triangle_right'</li>
<li>symbolSize - determines the size of the symbol element</li>
<li>symbolSizeSelected - determines the size of the symbol element. This paramters is applicable to line and area series only.</li>
<li>labels - object describing the labels properties of the axis
<ul>
<li>visible - true/false/'custom' determining the visibility. When 'custom' is set, displays only custom values/offsets.</li>
<li>offset - labels offset, e.g {x: -5, y: 0}.</li>
<li>angle - text rotation angle. </li>
<li>horizontalAligment - horizontal labels alignment.</li>
<li>verticalAligment - vertical labels alignment.</li>
<li>class - CSS class of the labels.</li>
<li>backgroundColor - labels background color.</li>
<li>backgroundOpacity - labels background opacity.</li>
<li>borderColor - labels border line color.</li>
<li>borderOpacity - labels border line opacity.</li>
<li>padding - object describing the padding of the labels
<ul>
<li>left - left padding.</li>
<li>right - right padding.</li>
<li>top - top padding.</li>
<li>bottom - bottom padding.</li>
</ul>
</li>
<li>autoRotate - boolean determining if auto rotation is enabled.</li>
<li>formatSettings - object describing the format settings of the labels.</li>
<li>formatFunction - callback function used to format the labels.</li>
<li>radius - radius of the labels in pie/donut series.</li>
<li>linesEnabled - determines whether to use lines for the labels in pie/donut series.</li>
<li>linesAngles - determines whether to use direct lines for the labels in pie/donut series.</li>
<li>custom – an array of custom values/offsets where a label/tickmark/gridline will be displayed.</li>
</ul>
</li>
<li>radius - outer radius of pie and donut series in pixels or percents.</li>
<li>innerRadius - inner radius of donut series in pixels or percents.</li>
<li>selectedRadiusChange - radius change on selection of pie and donut series in pixels or percents.</li>
<li>initialAngle - initial angle in pie and donut series.</li>
<li>startAngle - minimum angle in a pie, donut, polar and spider series</li>
<li>endAngle - maximum angle in a pie, donut, polar and spider series</li>
<li>centerOffset - offset from the center point in a pie/donut series.</li>
<li>hiddenPointsDisplay - determines whether to hide slices of toggled points in pie and donut series.</li>
<li>enableSeriesToggle - determines whether to toggle the series visibility after click on a legend's box.</li>
<li>enableSelection - determines whether the serie is selectable.</li>
</ul>
</li>
<li>annotations - an array of chart annotation objects.<p>Each annotation has the following properties:</p>
<ul>
<li>yValue - value to determine the vertical offset of the annotation.</li>
<li>xValue - value to determine the horizontal offset of the annotation.</li>
<li>yValue2 - optional 2nd value to determine the vertical offset of the annotation's bottom-right point.</li>
<li>xValue2 - optional 2nd value to determine the horizontal offset of the annotation bottom-right point.</li>
<li>offset - custom offset of the annotation relative to xValue & yValue, e.g. { x: -45, y: -25}</li>
<li>width - width of the annotation</li>
<li>height - width of the annotation</li>
<li>fillColor - fill/background color of the annotation.</li>
<li>lineColor - line color of the annotation.</li>
<li>type - shape type of the annotation, e.g. 'rect, circle, line, path'.</li>
<li>radius - radius of the annotation in case its type is 'circle'.</li>
<li>path - line path command in case the type is 'path', e.g. 'M 10,10 L 20,20 L 50,50'.</li>
<li>text - object describing the text of the annotation:
<ul>
<li>value - text of the annotation.</li>
<li>class - CSS class of the annotation.</li>
<li>angle - text rotation angle.</li>
<li>offset - offset of the annotation text relative to the base annotation offset, e.g. { x: 5, y: 10}</li>
</ul>
</li>
</ul>
</li>
</ul>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/7RDBc/">seriesGroups is set to a custom object</a>
</div>
</div>
</td>
</tr>
<!-- source -->
<tr>
<td class="documentation-option-type-click">
<span id='Span23'>source</span>
</td>
<td>
<span>Object</span>
</td>
<td>null
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Sets the chart's data source.
</p>
Example:
<pre><code>
var source =
{
datatype: "tab",
datafields: [
{ name: 'Date'},
{ name: 'Referral'},
{ name: 'SearchPaid'},
{ name: 'SearchNonPaid'}
],
url: '../sampledata/website_analytics.txt'
};
var dataAdapter = new $.jqx.dataAdapter(source,
{
async: false,
autoBind: true,
});
// prepare jqxChart settings
var settings = {
title: "Visual Web Traffic Analysis",
description: "Unique site visitors in 2011",
source: dataAdapter,
xAxis:
{
dataField: 'Date',
unitInterval: Math.round(dataAdapter.records.length / 12),
gridLines: { visible: false }
},
colorScheme: 'scheme06',
seriesGroups:
[
{
type: 'stackedarea100',
valueAxis:
{
unitInterval: 500,
title: {text: 'Daily visitors'}
},
series: [
{ dataField: 'SearchNonPaid', displayText: 'Non-Paid Search Traffic' },
{ dataField: 'SearchPaid', displayText: 'Paid Search Traffic' },
{ dataField: 'Referral', displayText: 'Referral Traffic' }
]
}
]
};
// setup the chart
$('#jqxChart').jqxChart(settings);
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/Csscx/">source is set to sampleData</a>
</div>
</div>
</td>
</tr>
<tr>
<td class="documentation-option-type-click">
<span id='Span1'>showBorderLine</span>
</td>
<td>
<span>Boolean</span>
</td>
<td>true
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Determines whether to display the chart's border line
</p>
Example:
<pre>
<code>
// hide the border line
$('#jqxChart').jqxChart({showBorderLine: 'false'});
// refresh the chart element
$('#jqxChart').jqxChart('refresh');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/6HTdH/">showBorderLine is set to false</a>
</div>
</div>
</td>
</tr>
<tr>
<td class="documentation-option-type-click">
<span id='Span16'>showLegend</span>
</td>
<td>
<span>Boolean</span>
</td>
<td>false
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Determines whether to show or hide the chart series legend.
</p>
Example:
<pre>
<code>
// select the chart element and hides the legend
$('#jqxChart').jqxChart({showLegend: false});
// refresh the chart element
$('#jqxChart').jqxChart('refresh');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/kw7GV/">showLegend is set to true</a>
</div>
</div>
</td>
</tr>
<!-- showToolTips -->
<tr>
<td class="documentation-option-type-click">
<span id='Span20'>showToolTips</span>
</td>
<td>
<span>Boolean</span>
</td>
<td>true
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Enables or disables the chart tooltips.
</p>
Example:
<pre>
<code>
$('#jqxChart').jqxChart({showToolTips: false});
$('#jqxChart').jqxChart('refresh');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/66kau/">showToolTips is set to false</a>
</div>
</div>
</td>
</tr>
<tr>
<td class="documentation-option-type-click">
<span id='Span14'>title</span>
</td>
<td>
<span>String</span>
</td>
<td>''
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Sets the title of the chart.
</p>
Example:
<pre>
<code>
// select the chart element and change the title to 'New Title'
$('#jqxChart').jqxChart({title: 'New Title'});
// refresh the chart element
$('#jqxChart').jqxChart('refresh');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/WnUMv/">title is set to "Top 5 most populated countries"</a>
</div>
</div>
</td>
</tr>
<tr>
<td class="documentation-option-type-click">
<span id='Span18'>titlePadding</span>
</td>
<td>
<span>Padding</span>
</td>
<td>{ left: 2, top: 2, right: 2, bottom: 2 }
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Sets the padding of the chart's title.
</p>
Example:
<pre>
<code>
$('#jqxChart').jqxChart({titlePadding: { left: 10, top: 10, right: 10, bottom: 10 }});
$('#jqxChart').jqxChart('refresh');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/B8kkN/">titlePadding is set to {left: 90,top: 0, right: 0, bottom: 10 }</a>
</div>
</div>
</td>
</tr>
<!-- toolTipShowDelay -->
<tr>
<td class="documentation-option-type-click">
<span id='Span21'>toolTipShowDelay</span>
</td>
<td>
<span>Number</span>
</td>
<td>500
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Determines the tooltips show delay in milliseconds. Values may range from 0 to 10000 [ms]
</p>
Example:
<pre>
<code>
$('#jqxChart').jqxChart({toolTipShowDelay: 2000});
$('#jqxChart').jqxChart('refresh');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/ysJcw/">toolTipShowDelay is set to 1000</a>
</div>
</div>
</td>
</tr>
<!-- toolTipHide delay -->
<tr>
<td class="documentation-option-type-click">
<span id='Span6'>toolTipHideDelay</span>
</td>
<td>
<span>Number</span>
</td>
<td>4000
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Determines the tooltips hide delay in milliseconds.
</p>
Example:
<pre>
<code>
$('#jqxChart').jqxChart({toolTipHideDelay: 5000});
$('#jqxChart').jqxChart('refresh');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/cuFaU/">toolTipHideDelay is set to 1000</a>
</div>
</div>
</td>
</tr>
<!-- toolTipMoveDuration delay -->
<tr>
<td class="documentation-option-type-click">
<span id='Span7'>toolTipMoveDuration</span>
</td>
<td>
<span>Number</span>
</td>
<td>300
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Determines the time in millisecond to move the tooltip between items.
</p>
Example:
<pre>
<code>
$('#jqxChart').jqxChart({toolTipMoveDuration: 50});
$('#jqxChart').jqxChart('refresh');
</code>
</pre>
</td>
</tr>
<!-- toolTipFormatFunction -->
<tr>
<td class="documentation-option-type-click">
<span id='Span8'>toolTipFormatFunction</span>
</td>
<td>
<span>Function</span>
</td>
<td>undefined
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
User defined tooltips text formatting callback function.
</p>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/mPVXF/">toolTipFormatFunction is set to a custom function</a>
</div>
</div>
</td>
</tr>
<!-- valueAxis -->
<tr>
<td class="documentation-option-type-click">
<span id='Span25'>valueAxis</span>
</td>
<td>
<span>Object</span>
</td>
<td>null
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<br />
Example:
<pre><code>
valueAxis:
{
title: {text: 'Values'},
unitInterval: 1,
minValue: 0,
maxValue: 100,
gridLines: {
visible: true,
step: 3,
color: '#888888'
}
}
</code></pre>
valueAxis properties:<br />
<ul>
<li>visible - shows or hides the valueAxis.</li>
<li>unitInterval - sets the interval between the units.</li>
<li>minValue - sets the minimum value of the valueAxis.</li>
<li>maxValue - sets the maximum value of the valueAxis.</li>
<li>baselineValue - sets the baseline value for the axis.</li>
<li>logarithmicScale - determines whether to use logarithmic scale. The default value is 'false'.</li>
<li>logarithmicScaleBase - base for logarithmic scale. The default value is 10.</li>
<li>formatSettings - settings used to format the displayed values along the axis.</li>
<li>formatFunction - custom function to format the displayed values along the axis.</li>
<li>flip - specifies whether the values are displayed in reverse order.</li>
<li>position - sets the axis position. Possible values: "left" and "right".</li>
<li>padding - object describing the padding of the axis
<ul>
<li>left - left padding.</li>
<li>right - right padding.</li>
</ul>
</li>
<li>axisSize - sets the size of the axis.</li>
<li>customDraw - boolean determining whether to draw the axis or the user will use APIs to draw it. The default is false.</li>
<li>title - object describing the title of the valueAxis
<ul>
<li>visible - boolean determining the visibility of the title.</li>
<li>text - text of the title.</li>
<li>class - CSS class of the title text.</li>
<li>horizontalAlignment - horizontal alignment.</li>
<li>verticalAlignment - horizontal alignment.</li>
</ul>
</li>
<li>tickMarks - object describing the tick marks properties of the valueAxis
<ul>
<li>visible - true/false/'custom' determining the visibility. When 'custom' is set, displays only custom values/offsets.</li>
<li>step - interval steps between tick mark placements.</li>
<li>dashStyle - tick marks dash style, e.g. '2,2', </li>
<li>lineWidth - line width in pixels of the tick marks.</li>
<li>size - size in pixels of the tick marks. The default is 4.</li>
<li>color - color of the tick marks, e.g. '#757575'.</li>
<li>custom – an array of custom values/offsets where a label/tickmark/gridline will be displayed.</li>
</ul>
</li>
<li>gridLines - object describing the grid lines properties of the valueAxis
<ul>
<li>visible - true/false/'custom' determining the visibility. When 'custom' is set, displays only custom values/offsets.</li>
<li>step - interval steps between grid line placements.</li>
<li>dashStyle - grid lines dash style, e.g. '2,2', </li>
<li>lineWidth - line width in pixels of the grid lines.</li>
<li>color - color of the tick marks, e.g. '#757575'.</li>
<li>custom – an array of custom values/offsets where a label/tickmark/gridline will be displayed.</li>
</ul>
</li>
<li>line - object describing the line properties of the axis
<ul>
<li>visible - boolean determining the visibility of the axis line.</li>
<li>dashStyle - line dash style, e.g. '2,2'. The default is inherited from the grid lines. </li>
<li>lineWidth - line width. The default is inherited from the grid lines.</li>
<li>color - color of axis line, e.g. '#757575'.</li>
</ul>
</li>
<li>labels - object describing the labels properties of the axis
<ul>
<li>visible - true/false/'custom' determining the visibility. When 'custom' is set, displays only custom values/offsets.</li>
<li>step - interval steps between label placements.</li>
<li>class - CSS class of the labels.</li>
<li>angle - text rotation angle. </li>
<li>textRotationPoint - position to rotate the text around, e.g. 'lefttop', 'centertop' or 'rightbottom'</li>
<li>autoRotate - boolean determining if auto rotation is enabled. Applicable to polar and spider charts only.</li>
<li>horizontalAligment - horizontal labels alignment.</li>
<li>verticalAligment - vertical labels alignment.</li>
<li>offset - labels offset, e.g {x: -5, y: 0}.</li>
<li>formatSettings - object describing the format settings of the labels.</li>
<li>formatFunction - callback function used to format the labels.</li>
<li>custom – an array of custom values/offsets where a label/tickmark/gridline will be displayed.</li>
</ul>
</li>
<li>showGridLines - deprecated. (use the visible property of gridLines)</li>
<li>gridLinesInterval - deprecated. (use the step property of gridLines)</li>
<li>gridLinesColor - deprecated. (use the color property of gridLines)</li>
<li>gridLinesDashStyle - deprecated. (use the dashStyle property of gridLines)</li>
<li>showTickMarks - deprecated. (use the visible property of tickMarks)</li>
<li>tickMarksInterval - deprecated. (use the step property of tickMarks)</li>
<li>tickMarksColor - deprecated. (use the color property of tickMarks)</li>
<li>tickMarksDashStyle - deprecated. (use the dashStyle property of tickMarks)</li>
<li>alternatingBackgroundColor - alternating background color between grid lines</li>
<li>alternatingBackgroundColor2 - second alternating background color</li>
<li>alternatingBackgroundOpacity - opacity of the alternating background</li>
<li>bands - optional color bands dislayed in the chart's plot area
<ul>
<li>minValue - start value of the color band.</li>
<li>maxValue - end value of the color band.</li>
<li>color - color used to fill the area between the minValue and the maxValue.</li>
<li>opacity - fraction indicating the fill opacity.</li>
</ul>
</li>
</ul>
<br />
</div>
</td>
</tr>
<!-- xAxis -->
<tr>
<td class="documentation-option-type-click">
<span id='Span24'>xAxis</span>
</td>
<td>
<span>Object</span>
</td>
<td>null
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Sets the Chart's xAxis.
</p>
Example:
<pre><code>
xAxis:
{
dataField: 'Date',
formatFunction: function (value) {
var months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
return months[value.getMonth()];
},
type: 'date',
baseUnit: 'month',
flip: false,
tickMarks: {
visible: true,
step: 1,
color: '#888888'
},
unitInterval: 1,
gridLines: {
visible: true,
step: 3,
color: '#888888'
}
}
</code></pre>
<ul>
<li>visible - shows or hides the xAxis axis.</li>
<li>unitInterval - sets the interval between the units.</li>
<li>dataField - points to a data field in the data source.</li>
<li>type - the type of the axis. Values can be:
<ul>
<li>'default' - auto detects and switches to 'basic', 'linear' or 'date'</li>
<li>'date'- when displaying dates</li>
<li>'basic' - displays all data points sequencially</li>
<li>'linear' - linear arrangement by the value of the xAxis data field</li>
</ul>
</li>
<li>baseUnit - the base unit when used with 'date' axis. Values can be 'year', 'month', 'day', 'hour', 'minute', 'second' or 'millisecond'.</li>
<li>valuesOnTicks - specifies whether the axis values will be aligned with the tick marks.</li>
<li>dateFormat - optional date format for parsing the data from the data source. Applicable when type is set to 'date'.</li>
<li>axisSize - sets the size of the xAxis.</li>
<li>customDraw - boolean determining whether to draw the axis or the user will use APIs to draw it. The default is false.</li>
<li>flip - specifies whether the axis is displayed in reverse order.</li>
<li>position - sets the axis position. Possible values: "top" and "bottom".</li>
<li>padding - object describing the padding of the axis
<ul>
<li>top - top padding.</li>
<li>bottom - bottom padding.</li>
</ul>
</li>
<li>title - object describing the title of the axis
<ul>
<li>visible - boolean determining the visibility of the title.</li>
<li>text - text of the title.</li>
<li>class - CSS class of the title text.</li>
<li>horizontalAlignment - horizontal alignment.</li>
<li>verticalAlignment - horizontal alignment.</li>
</ul>
</li>
<li>tickMarks - object describing the tick marks properties of the axis
<ul>
<li>visible - true/false/'custom' determining the visibility. When 'custom' is set, displays only custom values/offsets.</li>
<li>step - interval steps between tick marks placements.</li>
<li>dashStyle - tick marks dash style, e.g. '2,2', </li>
<li>lineWidth - line width in pixels of the tick marks.</li>
<li>size - size in pixels of the tick marks. The default is 4.</li>
<li>color - color of the tick marks, e.g. '#757575'.</li>
<li>custom – an array of custom values/offsets where a label/tickmark/gridline will be displayed.</li>
</ul>
</li>
<li>gridLines - object describing the grid lines properties of the axis
<ul>
<li>visible - true/false/'custom' determining the visibility. When 'custom' is set, displays only custom values/offsets.</li>
<li>step - interval steps between grid lines placements.</li>
<li>dashStyle - grid lines dash style, e.g. '2,2', </li>
<li>lineWidth - line width in pixels of the grid lines.</li>
<li>color - color of the tick marks, e.g. '#757575'.</li>
<li>custom – an array of custom values/offsets where a label/tickmark/gridline will be displayed.</li>
</ul>
</li>
<li>line - object describing the line properties of the axis
<ul>
<li>visible - boolean determining the visibility of the axis line.</li>
<li>dashStyle - line dash style, e.g. '2,2'. The default is inherited from the grid lines. </li>
<li>lineWidth - line width. The default is inherited from the grid lines.</li>
<li>color - color of axis line, e.g. '#757575'.</li>
</ul>
</li>
<li>labels - object describing the labels properties of the axis
<ul>
<li>visible - true/false/'custom' determining the visibility of the axis labels. When 'custom' is set, displays only custom values/offsets.</li>
<li>step - interval steps between label placements.</li>
<li>class - CSS class of the labels.</li>
<li>angle - text rotation angle. </li>
<li>textRotationPoint - position to rotate the text around, e.g. 'lefttop', 'centertop' or 'rightbottom'</li>
<li>autoRotate - boolean determining if auto rotation is enabled. Applicable to polar and spider charts only.</li>
<li>horizontalAligment - horizontal labels alignment.</li>
<li>verticalAligment - vertical labels alignment.</li>
<li>offset - labels offset, e.g {x: -5, y: 0}.</li>
<li>formatSettings - object describing the format settings of the labels.</li>
<li>formatFunction - callback function used to format the labels.</li>
<li>custom – an array of custom values/offsets where a label/tickmark/gridline will be displayed.</li>
</ul>
</li>
<li>logarithmicScale - determines whether to use logarithmic scale. The default value is 'false'.</li>
<li>logarithmicScaleBase - base for logarithmic scale. The default value is 10.</li>
<li>showGridLines - deprecated. (use the visible property of gridLines)</li>
<li>gridLinesInterval - deprecated. (use the step property of gridLines)</li>
<li>gridLinesColor - deprecated. (use the color property of gridLines)</li>
<li>gridLinesDashStyle - deprecated. (use the dashStyle property of gridLines)</li>
<li>showTickMarks - deprecated. (use the visible property of tickMarks)</li>
<li>tickMarksInterval - deprecated. (use the step property of tickMarks)</li>
<li>tickMarksColor - deprecated. (use the color property of tickMarks)</li>
<li>tickMarksDashStyle - deprecated. (use the dashStyle property of tickMarks)</li>
<li>alternatingBackgroundColor - alternating background color between grid lines</i></li>
<li>alternatingBackgroundColor2 - second alternating background color</li>
<li>alternatingBackgroundOpacity - opacity of the alternating background</li>
<li>formatSettings - settings used to format the displayed values.</li>
<li>formatFunction - custom function to format the displayed values.</li>
<li>toolTipFormatSettings - settings used to format xAxis values in tooltips.</li>
<li>toolTipFormatFunction - custom function to format xAxis values in tooltips.</li>
<li>rangeSelector - definition of a range selector on the xAxis.</li>
</ul>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/UX2c6/">xAxis is set to a custom object</a>
</div>
</div>
</td>
</tr>
</table>
<br />
</div>
<!-- EVENTS -->
<div id="events">
<h2>Events</h2>
<table class="documentation-table">
<tr>
<th>Name
</th>
<th>Arguments
</th>
<th></th>
</tr>
<!-- click -->
<tr>
<td class="documentation-option-type-click">
<span id='Span27'>click</span>
</td>
<td>
<span>Object</span>
</td>
<td></td>
</tr>
<tr>
<td colspan='3' style='padding-bottom: 0px; width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
The event is raised when the user clicks on series element.
Example:
</p>
<pre>
<code>
$('#jqxChart').jqxChart(settings);
$('#jqxChart').on('click', function(e))
{
alert('event = ' + e.event + ' index = ' + e.elementIndex );
}
}
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/nTuHS/">Bind to the click event by type: jqxChart.</a>
</div>
</div>
</td>
</tr>
<!-- mouseover -->
<tr>
<td class="documentation-option-type-click">
<span id='Span13'>mouseover</span>
</td>
<td>
<span>Object</span>
</td>
<td></td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
The event is raised when the user moves the cursor above a series element.
Example:
</p>
<pre>
<code>
// get the series groups of an existing chart
var groups = $('#jqxChart').jqxChart('seriesGroups');
// add a mouseover event handler function to the 1st group
if (groups.length > 0)
{
groups[0].mouseover = function(e)
{
alert('event = ' + e.event + ' index = ' + e.elementIndex );
}
// update the group
$('#jqxChart').jqxChart({seriesGroups: groups});
}
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/XwM39/">Bind to the mouseover event by type: jqxChart.</a>
</div>
</div>
</td>
</tr>
<!-- mouseout -->
<tr>
<td class="documentation-option-type-click">
<span id='Span26'>mouseout</span>
</td>
<td>
<span>Object</span>
</td>
<td></td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
The event is raised when the user moves the cursor out of a series element.
Example:
</p>
<pre>
<code>
// get the series groups of an existing chart
var groups = $('#jqxChart').jqxChart('seriesGroups');
// add a mouseout event handler function to the 1st group
if (groups.length > 0)
{
groups[0].mouseout = function(e)
{
alert('event = ' + e.event + ' index = ' + e.elementIndex );
}
// update the group
$('#jqxChart').jqxChart({seriesGroups: groups});
}
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/aTSFx/">Bind to the mouseout event by type: jqxChart.</a>
</div>
</div>
</td>
</tr>
<!-- refreshBegin -->
<tr>
<td class="documentation-option-type-click">
<span id='Span37'>refreshBegin</span>
</td>
<td>
<span>Object</span>
</td>
<td></td>
</tr>
<tr>
<td colspan='3' style='padding-bottom: 0px; width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
The event is raised when the chart begins rendering.
</p>
</div>
</td>
</tr>
<!-- refreshEnd -->
<tr>
<td class="documentation-option-type-click">
<span id='Span38'>refreshEnd</span>
</td>
<td>
<span>Object</span>
</td>
<td></td>
</tr>
<tr>
<td colspan='3' style='padding-bottom: 0px; width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
The event is raised when the chart finishes rendering.
</p>
</div>
</td>
</tr>
<!-- rangeSelectionChanged -->
<tr>
<td class="documentation-option-type-click">
<span id='Span40'>rangeSelectionChanged</span>
</td>
<td>
<span>Object</span>
</td>
<td></td>
</tr>
<tr>
<td colspan='3' style='padding-bottom: 20px; width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
The event is raised after the chart's range selector position changes and after the chart ends rendering.
</p>
</div>
</td>
</tr>
<!-- rangeSelectionChanging -->
<tr>
<td class="documentation-option-type-click">
<span id='Span39'>rangeSelectionChanging</span>
</td>
<td>
<span>Object</span>
</td>
<td></td>
</tr>
<tr>
<td colspan='3' style='padding-bottom: 0px; width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
The event is raised when the chart's range selector position changes and before the chart starts rendering.
</p>
</div>
</td>
</tr>
<!-- toggle -->
<tr>
<td class="documentation-option-type-click">
<span id='Span41'>toggle</span>
</td>
<td>
<span>Object</span>
</td>
<td></td>
</tr>
<tr>
<td colspan='3' style='padding-bottom: 0px; width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
The event is raised when a serie is toggled by a user click in the chart's legend or through an API call.
</p>
</div>
</td>
</tr>
</table>
</div>
<div id="Div2">
<h2 class="documentation-top-header">Methods</h2>
<table class="documentation-table">
<tr>
<th>Name
</th>
<th>Arguments
</th>
<th>Return Value
</th>
</tr>
<!-- addColorScheme -->
<tr>
<td class="documentation-option-type-click">
<span id='Span29'>addColorScheme</span>
</td>
<td>
<span>schemeName, array of colors</span>
</td>
<td>None
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Adds a new color sheme. If a scheme with the same name already exists the method will update its colors.
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>schemeName</em></td>
<td>String</td>
<td></td>
</tr>
<tr>
<td><em>colorsArray</em></td>
<td>Array</td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>None</em>
</div>
<h4>Code Example</h4>
<pre>
<code>
// setup the chart
var myChart = $('#jqxChart').jqxChart(settings);
// add a new color scheme named 'myScheme'
myChart.jqxChart('addColorScheme', 'myScheme', ['#FF0000', '#00FF00', '#0000FF']);
// apply the new scheme by setting the chart's colorScheme property
myChart.jqxChart('colorScheme', 'myScheme');
// refresh the chart
myChart.jqxChart('refresh');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/P2twj/">adds a new color sheme in the jqxChart.</a>
</div>
</div>
</td>
</tr>
<!-- getItemsCount -->
<tr>
<td class="documentation-option-type-click">
<span id='Span48'>getItemsCount</span>
</td>
<td>
<span>groupIndex, serieIndex</span>
</td>
<td>Number
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Note: Please, include jqxchart.api.js in order to access this API function.<br />
<br />
Gets the number of rendered items in a specific serie.<br />
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>groupIndex</em></td>
<td>Number</td>
<td></td>
</tr>
<tr>
<td><em>serieIndex</em></td>
<td>Number</td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>Number</em>
</div>
<h4>Code Example</h4>
<pre>
<code>
var chartInstance = $('#chartContainer').jqxChart('getInstance');
var count = chartInstance.getItemsCount(0, 1);
</code>
</pre>
</div>
</td>
</tr>
<tr>
<td class="documentation-option-type-click">
<span id='Span55'>getXAxisValue </span>
</td>
<td>
<span>offset, groupIndex</span>
</td>
<td>Number
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Note: Please, include jqxchart.api.js in order to access this API function.<br />
<br />
Gets the X Axis's value.<br />
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>offset</em></td>
<td>Number</td>
<td></td>
</tr>
<tr>
<td><em>groupIndex</em></td>
<td>Number</td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>Number</em>
</div>
<h4>Code Example</h4>
<pre>
<code>
var chartInstance = $('#chartContainer').jqxChart('getInstance');
var xvalue = chartInstance.getXAxisValue(position.x, 0);
</code>
</pre>
</div>
</td>
</tr>
<tr>
<td class="documentation-option-type-click">
<span id='Span56'>getValueAxisValue </span>
</td>
<td>
<span>offset, groupIndex</span>
</td>
<td>Number
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Note: Please, include jqxchart.api.js in order to access this API function.<br />
<br />
Gets the X Axis's value.<br />
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>offset</em></td>
<td>Number</td>
<td></td>
</tr>
<tr>
<td><em>groupIndex</em></td>
<td>Number</td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>Number</em>
</div>
<h4>Code Example</h4>
<pre>
<code>
var chartInstance = $('#chartContainer').jqxChart('getInstance');
var yvalue = chartInstance.getValueAxisValue(position.y, 0);
</code>
</pre>
</div>
</td>
</tr>
<!-- getItemCoord -->
<tr>
<td class="documentation-option-type-click">
<span id='Span49'>getItemCoord</span>
</td>
<td>
<span>groupIndex, serieIndex, itemIndex</span>
</td>
<td>object
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Note: Please, include jqxchart.api.js in order to access this API function.<br />
<br />
Gets the rendered coordinates of a data point element.<br />
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>groupIndex</em></td>
<td>Number</td>
<td></td>
</tr>
<tr>
<td><em>serieIndex</em></td>
<td>Number</td>
<td></td>
</tr>
<tr>
<td><em>itemIndex</em></td>
<td>Number</td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>Object</em>
</div>
<h4>Code Example</h4>
<pre>
<code>
var chartInstance = $('#chartContainer').jqxChart('getInstance');
var coord = chartInstance.getItemCoord(0, 1, i);
</code>
</pre>
</div>
</td>
</tr>
<!-- getXAxisRect -->
<tr>
<td class="documentation-option-type-click">
<span id='Span50'>getXAxisRect</span>
</td>
<td>
<span>groupIndex</span>
</td>
<td>{x, y, width, height}
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Note: Please, include jqxchart.api.js in order to access this API function.<br />
<br />
Gets the rendered rectangle coordinates of the x-Axis of specific serie group.<br />
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>groupIndex</em></td>
<td>Number</td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>Object</em> - {x, y, width, height}
</div>
<h4>Code Example</h4>
<pre>
<code>
var chartInstance = $('#chartContainer').jqxChart('getInstance');
var rect = chartInstance.getXAxisRect(0);
</code>
</pre>
</div>
</td>
</tr>
<!-- getXAxisLabels -->
<tr>
<td class="documentation-option-type-click">
<span id='Span51'>getXAxisLabels</span>
</td>
<td>
<span>groupIndex</span>
</td>
<td>array
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Note: Please, include jqxchart.api.js in order to access this API function.<br />
<br />
Gets the rendered coordinates and values of the xAxis labels.<br />
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>groupIndex</em></td>
<td>Number</td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>Array</em>
</div>
<h4>Code Example</h4>
<pre>
<code>
var chartInstance = $('#chartContainer').jqxChart('getInstance');
var rect = instance.getXAxisRect(0);
var labels = chartInstance.getXAxisLabels(0);
for (var i = 0; i < labels.length; i++) {
renderer.rect(rect.x + labels[i].offset, rect.y, 50, 50, { fill: 'blue', opacity: 0.5 });
</code>
</pre>
</div>
</td>
</tr>
<!-- getValueAxisRect -->
<tr>
<td class="documentation-option-type-click">
<span id='Span52'>getValueAxisRect</span>
</td>
<td>
<span>groupIndex</span>
</td>
<td>{x, y, width, height}
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Note: Please, include jqxchart.api.js in order to access this API function.<br />
<br />
Gets the rendered rectangle coordinates of the valueAxis of specific serie group.<br />
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>groupIndex</em></td>
<td>Number</td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>Object</em> - {x, y, width, height}
</div>
<h4>Code Example</h4>
<pre>
<code>
var chartInstance = $('#chartContainer').jqxChart('getInstance');
var rect = chartInstance.getValueAxisRect(0);
</code>
</pre>
</div>
</td>
</tr>
<!-- getValueAxisLabels -->
<tr>
<td class="documentation-option-type-click">
<span id='Span53'>getValueAxisLabels</span>
</td>
<td>
<span>groupIndex</span>
</td>
<td>array
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Note: Please, include jqxchart.api.js in order to access this API function.<br />
<br />
Gets the rendered coordinates and values of the valueAxis labels.<br />
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>groupIndex</em></td>
<td>Number</td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>Array</em> - axis's labels
</div>
<h4>Code Example</h4>
<pre>
<code>
var chartInstance = $('#chartContainer').jqxChart('getInstance');
var rect = instance.getValueAxisRect(0);
var labels = chartInstance.getValueAxisLabels(0);
for (var i = 0; i < labels.length; i++) {
renderer.rect(rect.x, rect.y + labels[i].offset, -50, 50, { fill: 'blue', opacity: 0.5 });
</code>
</pre>
</div>
</td>
</tr>
<!-- getColorScheme -->
<tr>
<td class="documentation-option-type-click">
<span id='Span31'>getColorScheme</span>
</td>
<td>
<span>schemeName</span>
</td>
<td>array of colors or undefined
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Returns the colors of a color scheme by name. If the scheme doesn't exist the method returns undefined.
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>schemeName</em></td>
<td>String</td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>Array</em> - color scheme's colors
</div>
<h4>Code Example</h4>
<pre>
<code>
// get the colors of a scheme named 'myScheme'
var schemeColors = $('#jqxChart').jqxChart('getColorScheme', 'myScheme');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/fPeTA/">gets color sheme in the jqxChart.</a>
</div>
</div>
</td>
</tr>
<!-- hideSerie -->
<tr>
<td class="documentation-option-type-click">
<span id='Span45'>hideSerie</span>
</td>
<td>
<span>groupIndex, serieIndex, itemIndex</span>
</td>
<td>None
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Hides a chart serie. The result of calling this function is same as<br />
the user unchecking the legend box of a chart serie. The itemIndex parameter is optional
and applicable to pie and donut series only.
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>groupIndex</em></td>
<td>Number</td>
<td></td>
</tr>
<tr>
<td><em>serieIndex</em></td>
<td>Number</td>
<td></td>
</tr>
<tr>
<td><em>itemIndex</em></td>
<td>Number</td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>None</em>
</div>
<h4>Code Example</h4>
<pre>
<code>
$('#jqxChart').jqxChart('hideSerie', 0, 1, NaN);
</code>
</pre>
</div>
</td>
</tr>
<!-- hideToolTip -->
<tr>
<td class="documentation-option-type-click">
<span id='Span47'>hideToolTip</span>
</td>
<td>
<span>hideDelay</span>
</td>
<td>None
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Note: Please, include jqxchart.api.js in order to access this API function.<br />
<br />
Hides the current tooltip if visible.<br />
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>hideDelay</em></td>
<td>Number</td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>None</em>
</div>
<h4>Code Example</h4>
<pre>
<code>
var chartInstance = $('#chartContainer').jqxChart('getInstance');
chartInstance.hideToolTip(
1000 /* hide after 1 second, optional parameter */
);
</code>
</pre>
</div>
</td>
</tr>
<!-- refresh -->
<tr>
<td class="documentation-option-type-click">
<span id='Span28'>refresh</span>
</td>
<td>
<span>None</span>
</td>
<td>None
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Refreshes the content of the chart widget after a property or data update.
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>None</em></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>None</em>
</div>
<h4>Code Example</h4>
<pre>
<code>
// select the chart element and change the color scheme
$('#jqxChart').jqxChart({colorScheme: 'scheme02'});
// refresh the chart element
$('#jqxChart').jqxChart('refresh');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/GSNPm/">refreshes the jqxChart.</a>
</div>
</div>
</td>
</tr>
<!-- removeColorScheme -->
<tr>
<td class="documentation-option-type-click">
<span id='Span30'>removeColorScheme</span>
</td>
<td>
<span>schemeName</span>
</td>
<td>None
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Removes an existing color scheme. If the scheme does not exist the method has no effect.
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>scheme</em></td>
<td>String</td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>None</em>
</div>
<h4>Code Example</h4>
<pre>
<code>
// remove an existing color scheme named 'myScheme'
$('#jqxChart').jqxChart('removeColorScheme', 'myScheme');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/QWqs5/">removes color sheme in the jqxChart.</a>
</div>
</div>
</td>
</tr>
<!-- saveAsJPEG -->
<tr>
<td class="documentation-option-type-click">
<span id='Span42'>saveAsJPEG</span>
</td>
<td>
<span>fileName, exportServer</span>
</td>
<td>'chart.jpeg', ''
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Exports the chart's content as JPEG image.<br />
The browser must support HTML5 Canvas and the device must be able to connect to the export server.
If you don't setup your own export server the default server is jqwidgets.com.
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>fileName</em></td>
<td>String</td>
<td></td>
</tr>
<tr>
<td><em>exportServer</em></td>
<td>
String/td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>None</em>
</div>
<h4>Code Example</h4>
<pre>
<code>
$('#jqxChart').jqxChart('saveAsJPEG', 'myChart.jpeg');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/QnqE8/">Exports the chart's content as JPEG image.</a>
</div>
</div>
</td>
</tr>
<!-- saveAsPNG -->
<tr>
<td class="documentation-option-type-click">
<span id='Span43'>saveAsPNG</span>
</td>
<td>
<span>fileName, exportServer</span>
</td>
<td>'chart.png', ''
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Exports the chart's content as PNG image.<br />
The browser must support HTML5 Canvas and the device must be able to connect to the export server.
If you don't setup your own export server the default server is jqwidgets.com.
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>fileName</em></td>
<td>String</td>
<td></td>
</tr>
<tr>
<td><em>exportServer</em></td>
<td>
String/td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>None</em>
</div>
<h4>Code Example</h4>
<pre>
<code>
$('#jqxChart').jqxChart('saveAsPNG', 'myChart.png');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/CgJEq/">Exports the chart's content as PNG image.</a>
</div>
</div>
</td>
</tr>
<!-- saveAsPDF -->
<tr>
<td class="documentation-option-type-click">
<span id='Span54'>saveAsPDF</span>
</td>
<td>
<span>fileName, exportServer</span>
</td>
<td>'chart.pdf', ''
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Exports the chart's content as PDF.<br />
The browser must support HTML5 Canvas and the device must be able to connect to the export server.
If you don't setup your own export server the default server is jqwidgets.com.
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>fileName</em></td>
<td>String</td>
<td></td>
</tr>
<tr>
<td><em>exportServer</em></td>
<td>
String/td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>None</em>
</div>
<h4>Code Example</h4>
<pre>
<code>
$('#jqxChart').jqxChart('saveAsPDF', 'myChart.pdf');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/fvgvffsr/">Exports the chart's content as PDF.</a>
</div>
</div>
</td>
</tr>
<!-- showSerie -->
<tr>
<td class="documentation-option-type-click">
<span id='Span44'>showSerie</span>
</td>
<td>
<span>groupIndex, serieIndex, itemIndex</span>
</td>
<td>None
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Shows a hidden chart serie. The result of calling this function is same as<br />
the user checking the legend box of a chart serie. The itemIndex parameter is optional
and applicable to pie and donut series only.
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>groupIndex</em></td>
<td>Number</td>
<td></td>
</tr>
<tr>
<td><em>serieIndex</em></td>
<td>Number</td>
<td></td>
</tr>
<tr>
<td><em>itemIndex</em></td>
<td>Number</td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>None</em>
</div>
<h4>Code Example</h4>
<pre>
<code>
$('#jqxChart').jqxChart('showSerie', 0, 1, NaN);
</code>
</pre>
</div>
</td>
</tr>
<!-- showToolTip -->
<tr>
<td class="documentation-option-type-click">
<span id='Span46'>showToolTip</span>
</td>
<td>
<span>groupIndex, serieIndex, itemIndex, showDelay, hideDelay</span>
</td>
<td>None
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Note: Please, include jqxchart.api.js in order to access this API function.<br />
<br />
Shows a the tooltip for a perticular data point.<br />
</p>
<pre>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>groupIndex</em></td>
<td>Number</td>
<td></td>
</tr>
<tr>
<td><em>serieIndex</em></td>
<td>Number</td>
<td></td>
</tr>
<tr>
<td><em>itemIndex</em></td>
<td>Number</td>
<td></td>
</tr>
<tr>
<td><em>showDelay</em></td>
<td>Number</td>
<td></td>
</tr>
<tr>
<td><em>hideDelay</em></td>
<td>Number</td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>None</em>
</div>
<h4>Code Example</h4>
<code>
var chartInstance = $('#chartContainer').jqxChart('getInstance');
chartInstance.showToolTip(
0, /* first seriesGroup */
1, /* second serie */
5, /* fifth item */
1000, /* 1s show delay, optional parameter */
5000 /* 5s hide delay, optional parameter */
);
</code>
</pre>
</div>
</td>
</tr>
<!-- update -->
<tr>
<td class="documentation-option-type-click">
<span id='Span35'>update</span>
</td>
<td>
<span>None</span>
</td>
<td>None
</td>
</tr>
<tr>
<td colspan='3' style='width: 100%'>
<div class="documentation-option-description property-content" style="display: none;">
<p>
Updates the values of the chart series without full refresh of the entire chart.
The method should be used for animation of frequently changing values. See the
live updates example in the product demo.
</p>
<div class="methodArgs">
<table class="arguments">
<tbody>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><em>None</em></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<strong>Return Value</strong><br />
<em>None</em>
</div>
<h4>Code Example</h4>
<pre>
<code>
updateDataValues();
// update the chart series
$('#jqxChart').jqxChart('update');
</code>
</pre>
<div style="padding-bottom: 5px;">
<em>Try it:</em> <a target="_blank" href="http://jsfiddle.net/jqwidgets/P6q29/">update the jqxChart.</a>
</div>
</div>
</td>
</tr>
</table>
<br />
</div>
</body>
</html>