blob: c915fcba7830dc583936ea236d0e8e16680a2d94 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Fri Feb 22 10:35:17 CET 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Chart (Simple ODF API v0.8-incubating - http://incubator.apache.org/odftoolkit/)</title>
<meta name="date" content="2013-02-22">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Chart (Simple ODF API v0.8-incubating - http://incubator.apache.org/odftoolkit/)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Chart.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/odftoolkit/simple/chart/AbstractChartContainer.html" title="class in org.odftoolkit.simple.chart"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/chart/Chart.html" target="_top">Frames</a></li>
<li><a href="Chart.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.odftoolkit.simple.chart</div>
<h2 title="Class Chart" class="title">Class Chart</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.odftoolkit.simple.chart.Chart</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">Chart</span>
extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block"><code>Chart</code> represents the chart feature of the ODF document.
<code>Chart</code> provides methods to get/set chart title, get/set chart
data, etc.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/Chart.html#getAxisTitle(java.lang.String)">getAxisTitle</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;dimType)</code>
<div class="block">chart axis manipulation, temporarily only consider the axis title</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/chart/DataSet.html" title="class in org.odftoolkit.simple.chart">DataSet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/Chart.html#getChartData()">getChartData</a></strong>()</code>
<div class="block">chart data manipulation, get the chart data</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/Chart.html#getChartID()">getChartID</a></strong>()</code>
<div class="block">chart id manipulation, get the current chart id</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/Chart.html#getChartTitle()">getChartTitle</a></strong>()</code>
<div class="block">chart title manipulation, get the current chart title</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/chart/ChartType.html" title="enum in org.odftoolkit.simple.chart">ChartType</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/Chart.html#getChartType()">getChartType</a></strong>()</code>
<div class="block">chart type manipulation, get the current chart type</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/Chart.html#IsApply3DEffect()">IsApply3DEffect</a></strong>()</code>
<div class="block">3D effect manipulation, get whether the chart apples 3D effect</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/Chart.html#isUseLegend()">isUseLegend</a></strong>()</code>
<div class="block">chart legend manipulation</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/Chart.html#refreshChart()">refreshChart</a></strong>()</code>
<div class="block">Refresh chart view and data setting.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/Chart.html#setApply3DEffect(boolean)">setApply3DEffect</a></strong>(boolean&nbsp;_3deffect)</code>
<div class="block">3D effect manipulation, set to apply 3D effect</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/Chart.html#setAxisTitle(java.lang.String, java.lang.String)">setAxisTitle</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;dimType,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;title)</code>
<div class="block">chart axis manipulation, set the chart axis title according to the give
dimension</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/Chart.html#setChartData(org.odftoolkit.simple.chart.DataSet)">setChartData</a></strong>(<a href="../../../../org/odftoolkit/simple/chart/DataSet.html" title="class in org.odftoolkit.simple.chart">DataSet</a>&nbsp;dataset)</code>
<div class="block">chart data manipulation, set chart data</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/Chart.html#setChartTitle(java.lang.String)">setChartTitle</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;title)</code>
<div class="block">chart title manipulation, get the current chart title</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/Chart.html#setChartType(org.odftoolkit.simple.chart.ChartType)">setChartType</a></strong>(<a href="../../../../org/odftoolkit/simple/chart/ChartType.html" title="enum in org.odftoolkit.simple.chart">ChartType</a>&nbsp;type)</code>
<div class="block">chart type manipulation, set a chart type when chart type is changed, all
the corresponding chart behaviors and properties should be changed
accordingly</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/Chart.html#setUseLegend(boolean)">setUseLegend</a></strong>(boolean&nbsp;useLegend)</code>
<div class="block">chart legend manipulation, get whether the chart use legend</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="IsApply3DEffect()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>IsApply3DEffect</h4>
<pre>public&nbsp;boolean&nbsp;IsApply3DEffect()</pre>
<div class="block">3D effect manipulation, get whether the chart apples 3D effect</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>return true if the chart is applied 3D effect</dd></dl>
</li>
</ul>
<a name="getAxisTitle(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAxisTitle</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getAxisTitle(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;dimType)</pre>
<div class="block">chart axis manipulation, temporarily only consider the axis title</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dimType</code> - the chart axis dimension, x, y or z</dd>
<dt><span class="strong">Returns:</span></dt><dd>return axis title according to the given dimension,null if the
specific dimensional axis has no title</dd></dl>
</li>
</ul>
<a name="getChartData()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChartData</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/chart/DataSet.html" title="class in org.odftoolkit.simple.chart">DataSet</a>&nbsp;getChartData()</pre>
<div class="block">chart data manipulation, get the chart data</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>return the chart data</dd></dl>
</li>
</ul>
<a name="getChartTitle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChartTitle</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getChartTitle()</pre>
<div class="block">chart title manipulation, get the current chart title</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>return the chart title</dd></dl>
</li>
</ul>
<a name="getChartType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChartType</h4>
<pre>public&nbsp;<a href="../../../../org/odftoolkit/simple/chart/ChartType.html" title="enum in org.odftoolkit.simple.chart">ChartType</a>&nbsp;getChartType()</pre>
<div class="block">chart type manipulation, get the current chart type</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the chart type</dd></dl>
</li>
</ul>
<a name="getChartID()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChartID</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getChartID()</pre>
<div class="block">chart id manipulation, get the current chart id</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the chart id</dd></dl>
</li>
</ul>
<a name="isUseLegend()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUseLegend</h4>
<pre>public&nbsp;boolean&nbsp;isUseLegend()</pre>
<div class="block">chart legend manipulation</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>returns true if it is using legend, otherwise returns false</dd></dl>
</li>
</ul>
<a name="setApply3DEffect(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setApply3DEffect</h4>
<pre>public&nbsp;void&nbsp;setApply3DEffect(boolean&nbsp;_3deffect)</pre>
<div class="block">3D effect manipulation, set to apply 3D effect</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>_3deffect</code> - a flag specifying whether or not apply a 3D effect</dd></dl>
</li>
</ul>
<a name="setAxisTitle(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAxisTitle</h4>
<pre>public&nbsp;void&nbsp;setAxisTitle(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;dimType,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;title)</pre>
<div class="block">chart axis manipulation, set the chart axis title according to the give
dimension</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dimType</code> - the chart axis dimension, x,y, or z</dd><dd><code>title</code> - the title of axis</dd></dl>
</li>
</ul>
<a name="setChartData(org.odftoolkit.simple.chart.DataSet)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setChartData</h4>
<pre>public&nbsp;void&nbsp;setChartData(<a href="../../../../org/odftoolkit/simple/chart/DataSet.html" title="class in org.odftoolkit.simple.chart">DataSet</a>&nbsp;dataset)</pre>
<div class="block">chart data manipulation, set chart data</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dataset</code> - the data set for the chart, which is a 2 dimensional data
container</dd></dl>
</li>
</ul>
<a name="setChartTitle(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setChartTitle</h4>
<pre>public&nbsp;boolean&nbsp;setChartTitle(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;title)</pre>
<div class="block">chart title manipulation, get the current chart title</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>return the chart title</dd></dl>
</li>
</ul>
<a name="setChartType(org.odftoolkit.simple.chart.ChartType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setChartType</h4>
<pre>public&nbsp;void&nbsp;setChartType(<a href="../../../../org/odftoolkit/simple/chart/ChartType.html" title="enum in org.odftoolkit.simple.chart">ChartType</a>&nbsp;type)</pre>
<div class="block">chart type manipulation, set a chart type when chart type is changed, all
the corresponding chart behaviors and properties should be changed
accordingly</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - the type of chart</dd></dl>
</li>
</ul>
<a name="setUseLegend(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUseLegend</h4>
<pre>public&nbsp;void&nbsp;setUseLegend(boolean&nbsp;useLegend)</pre>
<div class="block">chart legend manipulation, get whether the chart use legend</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>useLegend</code> - a flag specifying whether or not use legend</dd></dl>
</li>
</ul>
<a name="refreshChart()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>refreshChart</h4>
<pre>public&nbsp;void&nbsp;refreshChart()</pre>
<div class="block">Refresh chart view and data setting.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Chart.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/odftoolkit/simple/chart/AbstractChartContainer.html" title="class in org.odftoolkit.simple.chart"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/chart/ChartContainer.html" title="interface in org.odftoolkit.simple.chart"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/chart/Chart.html" target="_top">Frames</a></li>
<li><a href="Chart.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2010-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>